Java Globus API: Class CoGProperties
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.globus.common
Class CoGProperties

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--java.util.Properties
                    |
                    +--org.globus.common.CoGProperties
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable
public class CoGProperties
extends java.util.Properties

Responsible for managing the properties file "~/.globus/cog.properties", which holds information about various properties needed by the security classes. These properties include:

  • the location of the user certificate file
  • the location of the user key file
  • the location of the CA certificates
  • the location of the proxy file
  • the tcp port range
  • the local ip address for DHCP systems

See Also:
Serialized Form

Inner classes inherited from class java.util.Map
java.util.Map.Entry
 
Field Summary
static java.lang.String BASEDN
           
static java.lang.String CONFIG_FILE
          the configuration file properties are read from -- located in ~/.globus"
static java.lang.String configFile
          the config file location
static java.lang.String MDSHOST
           
static java.lang.String MDSPORT
           
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
CoGProperties()
           
CoGProperties(java.lang.String file)
           
 
Method Summary
static void fixSpace(java.util.Properties p)
           
protected  boolean getAsBoolean(java.lang.String key, boolean defaultValue)
           
protected  int getAsInt(java.lang.String label, int defValue)
           
 java.lang.String getCaCertFile()
          Deprecated. Use getCaCertLocations() instead.
 java.lang.String getCaCertLocations()
          Retrieves the location of the CA cert files.
 java.lang.String getCaCerts()
          Deprecated. Use getCaCertLocations() instead.
static CoGProperties getDefault()
           
 java.lang.String getDefaultPKCS11Handle()
           
 java.lang.String getIPAddress()
          Returns the user specified ip address.
 java.lang.String getOrgMDSBaseDN()
           
 java.lang.String getOrgMDSHost()
           
 java.lang.String getOrgMDSPort()
           
 java.lang.String getPKCS11LibraryName()
           
 java.lang.String getProxyFile()
          Retrieves the location of the proxy file.
 int getProxyLifeTime()
           
 int getProxyStrength()
           
 java.lang.String getRootMDSBaseDN()
           
 java.lang.String getRootMDSHost()
           
 java.lang.String getRootMDSPort()
           
 java.lang.String getSecureRandomAlgorithm()
           
 java.lang.String getSecureRandomProvider()
           
 java.lang.String getTcpPortRange()
          Returns the tcp port range.
 java.lang.String getUserCertFile()
          Retreives the location of the user cert file.
 java.lang.String getUserKeyFile()
          Retrieves the location of the user key file.
protected static boolean isNullOrEmpty(java.lang.String tmp)
           
 void load(java.io.InputStream in)
           
 void load(java.lang.String file)
           
 void save()
           
 void save(java.lang.String file)
           
 void setCaCertLocations(java.lang.String list)
           
static void setDefault(CoGProperties properties)
          Sets default configuration.
 void setProxyFile(java.lang.String proxyFile)
           
 void setProxyLifeTime(int lifeTimeInHours)
           
 void setProxyStrength(int strength)
           
 void setUserCertFile(java.lang.String userCertFile)
           
 void setUserKeyFile(java.lang.String userKeyFile)
           
 boolean useDevRandom()
          Returns whether to use the /dev/urandom device for seed generation.
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, propertyNames, save, setProperty, store
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MDSHOST

public static final java.lang.String MDSHOST

MDSPORT

public static final java.lang.String MDSPORT

BASEDN

public static final java.lang.String BASEDN

CONFIG_FILE

public static final java.lang.String CONFIG_FILE
the configuration file properties are read from -- located in ~/.globus"

configFile

public static java.lang.String configFile
the config file location
Constructor Detail

CoGProperties

public CoGProperties()

CoGProperties

public CoGProperties(java.lang.String file)
              throws java.io.IOException
Method Detail

getDefault

public static CoGProperties getDefault()

setDefault

public static void setDefault(CoGProperties properties)
Sets default configuration. It can be used to set a different configuration dynamically.

save

public void save()
          throws java.io.IOException

save

public void save(java.lang.String file)
          throws java.io.IOException

load

public void load(java.lang.String file)
          throws java.io.IOException

load

public void load(java.io.InputStream in)
          throws java.io.IOException
Overrides:
load in class java.util.Properties

fixSpace

public static void fixSpace(java.util.Properties p)

getUserCertFile

public java.lang.String getUserCertFile()
Retreives the location of the user cert file. It first checks the X509_USER_CERT system property. If the property is not set, it checks next the 'usercert' property in the current configuration. If that property is not set, it returns a default location of the user cert file. The default value is the 'usercert.pem' file in the user's globus directory. For example: ${user.home}/.globus/usercert.pem.
Returns:
String the location of the user cert file

setUserCertFile

public void setUserCertFile(java.lang.String userCertFile)

getPKCS11LibraryName

public java.lang.String getPKCS11LibraryName()

getDefaultPKCS11Handle

public java.lang.String getDefaultPKCS11Handle()

getUserKeyFile

public java.lang.String getUserKeyFile()
Retrieves the location of the user key file. It first checks the X509_USER_KEY system property. If the property is not set, it checks next the 'userkey' property in the current configuration. If that property is not set, it returns a default location of the user key file. The default value is the 'userkey.pem' file in the user's globus directory. For example: ${user.home}/.globus/userkey.pem.
Returns:
String the location of the user key file

setUserKeyFile

public void setUserKeyFile(java.lang.String userKeyFile)

getIPAddress

public java.lang.String getIPAddress()
Returns the user specified ip address. This is used for DHCP machines where java is unable to determine the right IP address.
Returns:
String the ip address of the machine.

getCaCertFile

public java.lang.String getCaCertFile()
Deprecated. Use getCaCertLocations() instead.

Returns:
String the locations of the CA certificates
See Also:
getCaCertLocations

getCaCerts

public java.lang.String getCaCerts()
Deprecated. Use getCaCertLocations() instead.

Returns:
String the locations of the CA certificates
See Also:
getCaCertLocations

getCaCertLocations

public java.lang.String getCaCertLocations()
Retrieves the location of the CA cert files. It first checks the X509_CERT_DIR system property. If the property is not set, it checks next the 'cacert' property in the current configuration. If that property is not set, it tries to find the certificates using the following rules:
First the ${user.home}/certificates directory is checked. If the directory does not exist, and on a Unix machine, the /etc/grid-security/certificates directory is checked next. Otherwise, null is returned. This indicates the the certificates directory could not be found.
Moreover, this function can return multiple file and directory locations. The locations must be comma separated.
Returns:
String the locations of the CA certificates

setCaCertLocations

public void setCaCertLocations(java.lang.String list)

getProxyFile

public java.lang.String getProxyFile()
Retrieves the location of the proxy file. It first checks the X509_USER_PROXY system property. If the property is not set, it checks next the 'proxy' property in the current configuration. If that property is not set, then it defaults to a value based on the following rules:
If a UID system property is set, and running on a Unix machine it returns /tmp/x509up_u${UID}. If any other machine then Unix, it returns ${tempdir}/x509up_u${UID}, where tempdir is a platform-specific temporary directory as indicated by the java.io.tmpdir system property. If a UID system property is not set, the username will be used instead of the UID. That is, it returns ${tempdir}/x509up_u_${username}
This is done this way because Java is not able to obtain the current uid.
Returns:
String the location of the proxy file

setProxyFile

public void setProxyFile(java.lang.String proxyFile)

getTcpPortRange

public java.lang.String getTcpPortRange()
Returns the tcp port range. It first checks the 'org.globus.tcp.port.range' system property. If the system property is not set then it returns the value specified in the configuration file. Returns null if the port range is not defined.
The port range is in the following form: ,
Returns:
String the port range.

useDevRandom

public boolean useDevRandom()
Returns whether to use the /dev/urandom device for seed generation.
Returns:
true if the device should be used (if available of course) Returns true by default unless specified otherwise by the user.

getSecureRandomProvider

public java.lang.String getSecureRandomProvider()

getSecureRandomAlgorithm

public java.lang.String getSecureRandomAlgorithm()

getProxyStrength

public int getProxyStrength()

setProxyStrength

public void setProxyStrength(int strength)

getProxyLifeTime

public int getProxyLifeTime()

setProxyLifeTime

public void setProxyLifeTime(int lifeTimeInHours)

getRootMDSHost

public java.lang.String getRootMDSHost()

getRootMDSPort

public java.lang.String getRootMDSPort()

getRootMDSBaseDN

public java.lang.String getRootMDSBaseDN()

getOrgMDSHost

public java.lang.String getOrgMDSHost()

getOrgMDSPort

public java.lang.String getOrgMDSPort()

getOrgMDSBaseDN

public java.lang.String getOrgMDSBaseDN()

getAsBoolean

protected boolean getAsBoolean(java.lang.String key,
                               boolean defaultValue)

getAsInt

protected int getAsInt(java.lang.String label,
                       int defValue)

isNullOrEmpty

protected static final boolean isNullOrEmpty(java.lang.String tmp)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD