RoamingConfigurationWithSMProxy ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.roaming.RoamingConfiguration
- - com.entrust.toolkit.roaming.RoamingConfigurationWithSMProxy

```
public class RoamingConfigurationWithSMProxy
extends RoamingConfiguration
```
A RoamingConfiguration class that implements Proxy Order.
This class provides dynamic configuration of SMProxy support based the value of the proxyOrder parameter. The following ProxyOrder values are used to control the Proxy Ordering:
- PROXYFIRST: a connection the proxy server will be attempted first. If that fails, a connection to the authority server will be attempted.
- PROXYLAST: a connection to the authority server will be attempted first. If that fails, a connection to the proxy server will be attempted. This is the default setting.
- NEVERPROXY: a connection to the authority server will be attempted. If that fails, a failure will occur
- ALWAYSPROXY: a connection to the proxy server will be attempted. If that fails, a failure will occur
The determination of which configuration to use is performed in the constructor.
NOTE: A simple TCP/IP connection attempt is used as a connectivity test. For the proxied connection, this test is performed against the proxy server, not the roaming server.
Since:

8.1

Constructor Summary

Constructors
Constructor and Description
`RoamingConfigurationWithSMProxy(IniFile iniFile, ProxyOrder proxyOrder)` Constructor that takes an entrust.ini file and sets the proxyFirst parameter.
`RoamingConfigurationWithSMProxy(java.lang.String entrustIniFile, ProxyOrder proxyOrder)` Constructor that takes an entrust.ini file path and sets the proxyFirst parameter.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getConnectTimeout()`
`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`	`setConnectTimeout(int connectTimeout)`
`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
  - RoamingConfigurationWithSMProxy
```
public RoamingConfigurationWithSMProxy(java.lang.String entrustIniFile,
                               ProxyOrder proxyOrder)
                                throws RoamingException,
                                       java.net.MalformedURLException,
                                       java.io.FileNotFoundException,
                                       java.text.ParseException
```
    Constructor that takes an entrust.ini file path and sets the proxyFirst parameter.
    
    Parameters:
    entrustIniFile - the entrust.ini file that contains the Roaming configuration information
    proxyOrder - true if the proxy settings should be attempted first
    
    Throws:
    
    RoamingException - if there are no roaming settings in the entrust.ini file
    
    java.net.MalformedURLException - if the proxy server address is invalid
    
    java.io.FileNotFoundException - if the entrust.ini file cannot be found
    
    java.text.ParseException - if the roaming parameters invalid
  - RoamingConfigurationWithSMProxy
```
public RoamingConfigurationWithSMProxy(IniFile iniFile,
                               ProxyOrder proxyOrder)
                                throws RoamingException,
                                       java.text.ParseException,
                                       java.net.MalformedURLException
```
    Constructor that takes an entrust.ini file and sets the proxyFirst parameter.
    
    Parameters:
    iniFile - the entrust.ini file that contains the Roaming configuration information.
    proxyOrder - true if the proxy settings should be attempted first
    
    Throws:
    
    java.io.FileNotFoundException - if the entrust.ini file cannot be found *
    
    RoamingException - if there are no roaming settings in the entrust.ini file
    
    java.text.ParseException - if the roaming parameters are invalid
    
    java.net.MalformedURLException - if the proxy server address is invalid
- Method Detail
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns:
    the ConnectTimeout
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Parameters:
    connectTimeout - the timeout value to be used in milliseconds.
  - getDirectory
```
public JNDIDirectory getDirectory()
```
    Description copied from class: RoamingConfiguration
    
    Return a connection to the Directory specified in the ini file.
    
    Overrides:
    
    getDirectory in class RoamingConfiguration
    
    Returns:
    a connection to the Directory specified in the ini file.
  - getKeyType
```
public java.lang.String getKeyType()
```
    Description copied from class: RoamingConfiguration
    
    Returns the symmetric key type to use when communicating with the Roaming Server, as parsed from the ini file.
    
    Overrides:
    
    getKeyType in class RoamingConfiguration
    
    Returns:
    the symmetric key type to use when communicating with the Roaming Server,
  - setKeyType
```
public void setKeyType(java.lang.String keyType)
                throws RoamingException
```
    Description copied from class: RoamingConfiguration
    
    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".
    
    Overrides:
    
    setKeyType in class RoamingConfiguration
    
    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()
```
    Description copied from class: RoamingConfiguration
    
    Return the distinguished name of the Roaming Server.
    
    Overrides:
    
    getProfileServerDN in class RoamingConfiguration
    
    Returns:
    the distinguished name of the Roaming Server.
  - setProfileServerDN
```
public void setProfileServerDN(java.lang.String profileServerDN)
                        throws RoamingException
```
    Description copied from class: RoamingConfiguration
    
    Set the distinguished name of the Roaming Server
    
    Overrides:
    
    setProfileServerDN in class RoamingConfiguration
    
    Parameters:
    profileServerDN - the distinguished name of the Roaming Server.
    
    Throws:
    
    RoamingException
  - getFilesFromServer
```
public boolean getFilesFromServer()
```
    Description copied from class: RoamingConfiguration
    
    Return true if the client will request the Roaming Server retrieve roaming files from the Directory, false if the client will retrieve the files.
    
    Overrides:
    
    getFilesFromServer in class RoamingConfiguration
    
    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)
```
    Description copied from class: RoamingConfiguration
    
    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.
    
    Overrides:
    
    setFilesFromServer in class RoamingConfiguration
    
    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()
```
    Description copied from class: RoamingConfiguration
    
    Return the Directory attribute used to store the Roaming User ID.
    
    Overrides:
    
    getRoamingIDField in class RoamingConfiguration
    
    Returns:
    the Directory attribute used to store the Roaming User ID.
  - setRoamingIDField
```
public void setRoamingIDField(java.lang.String roamingIDField)
                       throws RoamingException
```
    Description copied from class: RoamingConfiguration
    
    Sets the Directory attribute used to store the Roaming User ID.
    
    Overrides:
    
    setRoamingIDField in class RoamingConfiguration
    
    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()
```
    Description copied from class: RoamingConfiguration
    
    Return the host name or IP address of the Roaming Server, as parsed from the ini file.
    
    Overrides:
    
    getRoamingServerIP in class RoamingConfiguration
    
    Returns:
    the host name or IP address of the Roaming Server.
  - getRoamingServerPort
```
public int getRoamingServerPort()
```
    Description copied from class: RoamingConfiguration
    
    Return the port number of the Roaming Server, as parsed from the ini file.
    
    Overrides:
    
    getRoamingServerPort in class RoamingConfiguration
    
    Returns:
    the port number of the Roaming Server.
  - setRoamingServerPort
```
public void setRoamingServerPort(int roamingServerPort)
```
    Description copied from class: RoamingConfiguration
    
    Set the port number of the Roaming Server.
    
    Overrides:
    
    setRoamingServerPort in class RoamingConfiguration
    
    Parameters:
    roamingServerPort - the port number of the Roaming Server. Default is port 640.
  - getRoamingSSLPort
```
public int getRoamingSSLPort()
```
    Description copied from class: RoamingConfiguration
    
    Return the port number to use for SSL communication with the Roaming Server.
    
    Overrides:
    
    getRoamingSSLPort in class RoamingConfiguration
    
    Returns:
    the port number to use for SSL communication with the Roaming Server.
  - setRoamingSSLPort
```
public void setRoamingSSLPort(int roamingSSLPort)
```
    Description copied from class: RoamingConfiguration
    
    Set the port number to use for SSL communication with the Roaming Server.
    
    Overrides:
    
    setRoamingSSLPort in class RoamingConfiguration
    
    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()
```
    Description copied from class: RoamingConfiguration
    
    Return the Search Base to use when searching the Directory for roaming files, as parsed from the ini file.
    
    Overrides:
    
    getRoamSearchBase in class RoamingConfiguration
    
    Returns:
    the Search Base to use when searching the Directory for roaming files.
  - getSMRoamingServerProxyURL
```
public java.net.URL getSMRoamingServerProxyURL()
```
    Description copied from class: RoamingConfiguration
    
    Returns the SMRoamingServerProxyURL value or null if this value has not been set.
    
    Overrides:
    
    getSMRoamingServerProxyURL in class RoamingConfiguration
    
    Returns:
    the SMRoamingServerProxyURL value.
  - setSMRoamingServerProxyURL
```
public void setSMRoamingServerProxyURL(java.net.URL m_SMRoamingServerProxyURL)
```
    Description copied from class: RoamingConfiguration
    
    Sets the SMProxy URL for the directory that contains the roaming credentials.
    
    Overrides:
    
    setSMRoamingServerProxyURL in class RoamingConfiguration
    
    Parameters:
    m_SMRoamingServerProxyURL - the m_SMRoamingServerProxyURL to set
  - setSMRoamingProxyURL
```
public void setSMRoamingProxyURL(java.net.URL m_SMRoamingProxyURL)
```
    Description copied from class: RoamingConfiguration
    
    Sets the SMProxy URL for the roaming server.
    
    Overrides:
    
    setSMRoamingProxyURL in class RoamingConfiguration
    
    Parameters:
    m_SMRoamingProxyURL - the m_SMRoamingProxyURL to set
  - getSMRoamingProxyURL
```
public java.net.URL getSMRoamingProxyURL()
```
    Description copied from class: RoamingConfiguration
    
    Returns the SMRoamingProxyURL value or null if this value has not been set.
    
    Overrides:
    
    getSMRoamingProxyURL in class RoamingConfiguration
    
    Returns:
    the SMRoamingProxyURL value.

Class RoamingConfigurationWithSMProxy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoamingConfigurationWithSMProxy

RoamingConfigurationWithSMProxy

Method Detail

getConnectTimeout

setConnectTimeout

getDirectory

getKeyType

setKeyType

getProfileServerDN

setProfileServerDN

getFilesFromServer

setFilesFromServer

getRoamingIDField

setRoamingIDField

getRoamingServerIP

getRoamingServerPort

setRoamingServerPort

getRoamingSSLPort

setRoamingSSLPort

getRoamSearchBase

getSMRoamingServerProxyURL

setSMRoamingServerProxyURL

setSMRoamingProxyURL

getSMRoamingProxyURL