com.entrust.toolkit.roaming

Class RoamingConfiguration

java.lang.Object

com.entrust.toolkit.roaming.RoamingConfiguration

Direct Known Subclasses:

RoamingConfigurationWithSMProxy

public class RoamingConfiguration
extends java.lang.Object

This class is a convenience class for parsing Roaming Server information from an entrust.ini file. It also includes a constructor for providing the configuration information explicitly.

The following entries are required in the [Entrust Settings] section:

Server

The host name or IP address of the Directory Server, with an optional port number. If the port number is omitted, 389 is used as the default. Multiple hosts can be listed in a comma-delimited format.

ProfileServer

The host name or IP address of the Roaming Server, with an optional port number. If the port number is omitted, 640 is used as the default.

RoamSearchBase

The Directory search base to use when searching for Roaming information.

The following entries are optional:

ProfileServerDN

The Distinguished name of the identity running the Roaming Server.

ProfileServerKeyType

The symmetric key type to use when communicating with the Roaming Server. Possible values are "CAST-128", "Triple DES" and "IDEA". The default value is "CAST-128".

RoamGetFilesFromServer

Set to 1 to indicate the client should ask the Roaming Server to retrieve files from the Directory instead of the client. This places additional burden on the Roaming Server, but is useful if the clients are having difficulty accessing the Directory.

RoamingIDField

The Directory attribute used to store the Roaming User ID. If absent, the default is userid

RoamingSSLPort

The number of the port on which the Roaming Server is listening for SSL/TLS connections. If absent, the port number on which the Roaming Server is listening for other connections is used.

The following entries are only used if SMProxy is enabled. URL's must be HTTP only:

SMProxyURL

The common URL for the proxy server. Use this if all of the proxied connections are through the same SMProxy server.

SMRoamingProxyURL

The URL for the SMProxy server that provides the Roaming Server connection. Use this setting if the roaming server connections are to go through a separate SMProxy server.

SMServerProxyURL

The URL for the SMProxy server that provides the connection to the Directory Server that contains the user credentials. Use this setting if the LDAP directory is on a separate SMProxy server. This overrides the SMProxyURL value. If the FilesFromServer setting is false, this parameter will have no effect.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
RoamingConfiguration(IniFile iniFile, boolean smProxyEnabled) Create a RoamingConfiguration object.
RoamingConfiguration(java.lang.String iniFile) Create a RoamingConfiguration object.
RoamingConfiguration(java.lang.String iniFile, boolean smProxyEnabled) Create a RoamingConfiguration object.
RoamingConfiguration(java.lang.String directory, java.lang.String roamingServerIP, java.lang.String roamSearchBase) Create a RoamingConfiguration object.

Method Summary

Modifier and Type	Method and Description
JNDIDirectory	getDirectory() Return a connection to the Directory specified in the ini file.
boolean	getFilesFromServer() Return true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.
java.lang.String	getKeyType() Returns the symmetric key type to use when communicating with the Roaming Server, as parsed from the ini file.
java.lang.String	getProfileServerDN() Return the distinguished name of the Roaming Server.
java.lang.String	getRoamingIDField() Return the Directory attribute used to store the Roaming User ID.
java.lang.String	getRoamingServerIP() Return the host name or IP address of the Roaming Server, as parsed from the ini file.
int	getRoamingServerPort() Return the port number of the Roaming Server, as parsed from the ini file.
int	getRoamingSSLPort() Return the port number to use for SSL communication with the Roaming Server.
java.lang.String	getRoamSearchBase() Return the Search Base to use when searching the Directory for roaming files, as parsed from the ini file.
java.net.URL	getSMRoamingProxyURL() Returns the SMRoamingProxyURL value or null if this value has not been set.
java.net.URL	getSMRoamingServerProxyURL() Returns the SMRoamingServerProxyURL value or null if this value has not been set.
void	setFilesFromServer(boolean filesFromServer) Set to true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.
void	setKeyType(java.lang.String keyType) Sets the symmetric key type to use when communicating with the Roaming Server.
void	setProfileServerDN(java.lang.String profileServerDN) Set the distinguished name of the Roaming Server
void	setRoamingIDField(java.lang.String roamingIDField) Sets the Directory attribute used to store the Roaming User ID.
void	setRoamingServerPort(int roamingServerPort) Set the port number of the Roaming Server.
void	setRoamingSSLPort(int roamingSSLPort) Set the port number to use for SSL communication with the Roaming Server.
void	setSMRoamingProxyURL(java.net.URL m_SMRoamingProxyURL) Sets the SMProxy URL for the roaming server.
void	setSMRoamingServerProxyURL(java.net.URL m_SMRoamingServerProxyURL) Sets the SMProxy URL for the directory that contains the roaming credentials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoamingConfiguration

public RoamingConfiguration(java.lang.String directory,
                            java.lang.String roamingServerIP,
                            java.lang.String roamSearchBase)
                     throws RoamingException

Create a RoamingConfiguration object.

Allows roaming configuration in situations where file access may not be permitted.

Parameters:

directory - The host name or IP address of the Directory Server, with an optional port number. If the port number is omitted, 389 is used as the default. Multiple hosts can be listed in a comma-delimited format.

roamingServerIP - The host name or IP address of the Roaming Server. The default port number is 640. Use setRoamingServerPort to set the port value.

roamSearchBase - The Directory search base to use when searching for Roaming information.

Throws:

RoamingException - if any of the provided values are invalid

RoamingConfiguration

public RoamingConfiguration(java.lang.String iniFile)
                     throws RoamingException,
                            java.io.FileNotFoundException

Create a RoamingConfiguration object.

Parameters:

iniFile - the path to the entrust.ini file that contains the Roaming configuration information.

Throws:

RoamingException - if any of the required settings in iniFile are missing, or those present are invalid.

java.io.FileNotFoundException - if iniFile cannot be found

RoamingConfiguration

public RoamingConfiguration(java.lang.String iniFile,
                            boolean smProxyEnabled)
                     throws RoamingException,
                            java.io.FileNotFoundException

Create a RoamingConfiguration object.

Parameters:

iniFile - the path to the entrust.ini file that contains the Roaming configuration information.

smProxyEnabled - true if the proxy settings should be used

Throws:

RoamingException - if any of the required settings in iniFile are missing, or those present are invalid.

java.io.FileNotFoundException - if iniFile cannot be found

Since:

8.1

RoamingConfiguration

public RoamingConfiguration(IniFile iniFile,
                            boolean smProxyEnabled)
                     throws RoamingException

Create a RoamingConfiguration object.

Parameters:

iniFile - the entrust.ini file that contains the Roaming configuration information.

smProxyEnabled - true if the proxy settings should be used

Throws:

RoamingException - if any of the required settings in iniFile are missing, or those present are invalid.

Since:

8.1

See Also:

SMProxyManagerTransport( IniFile entrustIniFile ), SMProxyDirectory(IniFile entrustIniFile)

Method Detail

getDirectory

public JNDIDirectory getDirectory()

Return a connection to the Directory specified in the ini file.

Returns:

a connection to the Directory specified in the ini file.

getKeyType

public java.lang.String getKeyType()

Returns the symmetric key type to use when communicating with the Roaming Server, as parsed from the ini file.

Returns:

the symmetric key type to use when communicating with the Roaming Server,

setKeyType

public void setKeyType(java.lang.String keyType)
                throws RoamingException

Sets the symmetric key type to use when communicating with the Roaming Server.

Valid values are "CAST-128", "Triple DES" and "IDEA". The default is "CAST-128".

Parameters:

keyType - the symmetric key type to use when communicating with the Roaming Server

Throws:

RoamingException - if key type is invalid

getProfileServerDN

public java.lang.String getProfileServerDN()

Return the distinguished name of the Roaming Server.

Returns:

the distinguished name of the Roaming Server.

setProfileServerDN

public void setProfileServerDN(java.lang.String profileServerDN)
                        throws RoamingException

Set the distinguished name of the Roaming Server

Parameters:

profileServerDN - the distinguished name of the Roaming Server.

Throws:

RoamingException

getFilesFromServer

public boolean getFilesFromServer()

Return true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.

Returns:

true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.

setFilesFromServer

public void setFilesFromServer(boolean filesFromServer)

Set to true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.

Parameters:

filesFromServer - set to true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files. The default is false.

getRoamingIDField

public java.lang.String getRoamingIDField()

Return the Directory attribute used to store the Roaming User ID.

Returns:

the Directory attribute used to store the Roaming User ID.

setRoamingIDField

public void setRoamingIDField(java.lang.String roamingIDField)
                       throws RoamingException

Sets the Directory attribute used to store the Roaming User ID.

Parameters:

roamingIDField - the Directory attribute used to store the Roaming User ID. The default value is "userid".

Throws:

RoamingException

getRoamingServerIP

public java.lang.String getRoamingServerIP()

Return the host name or IP address of the Roaming Server, as parsed from the ini file.

Returns:

the host name or IP address of the Roaming Server.

getRoamingServerPort

public int getRoamingServerPort()

Return the port number of the Roaming Server, as parsed from the ini file.

Returns:

the port number of the Roaming Server.

setRoamingServerPort

public void setRoamingServerPort(int roamingServerPort)

Set the port number of the Roaming Server.

Parameters:

roamingServerPort - the port number of the Roaming Server. Default is port 640.

getRoamingSSLPort

public int getRoamingSSLPort()

Return the port number to use for SSL communication with the Roaming Server.

Returns:

the port number to use for SSL communication with the Roaming Server.

setRoamingSSLPort

public void setRoamingSSLPort(int roamingSSLPort)

Set the port number to use for SSL communication with the Roaming Server.

Parameters:

roamingSSLPort - the port number to use for SSL communication with the Roaming Server. The default is the RoamingServerPort value. Setting this value to '0' will cause the RoamingServerPort value to be used.

getRoamSearchBase

public java.lang.String getRoamSearchBase()

Return the Search Base to use when searching the Directory for roaming files, as parsed from the ini file.

Returns:

the Search Base to use when searching the Directory for roaming files.

getSMRoamingProxyURL

public java.net.URL getSMRoamingProxyURL()

Returns the SMRoamingProxyURL value or null if this value has not been set.

Returns:

the SMRoamingProxyURL value.

Since:

8.1

getSMRoamingServerProxyURL

public java.net.URL getSMRoamingServerProxyURL()

Returns the SMRoamingServerProxyURL value or null if this value has not been set.

Returns:

the SMRoamingServerProxyURL value.

Since:

8.1

setSMRoamingServerProxyURL

public void setSMRoamingServerProxyURL(java.net.URL m_SMRoamingServerProxyURL)

Sets the SMProxy URL for the directory that contains the roaming credentials.

Parameters:

m_SMRoamingServerProxyURL - the m_SMRoamingServerProxyURL to set

Since:

8.1

setSMRoamingProxyURL

public void setSMRoamingProxyURL(java.net.URL m_SMRoamingProxyURL)

Sets the SMProxy URL for the roaming server.

Parameters:

m_SMRoamingProxyURL - the m_SMRoamingProxyURL to set

Since:

8.1