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

java.lang.Object
- com.entrust.toolkit.smproxy.SMProxyConfig

All Implemented Interfaces:

LogoutListener
```
public class SMProxyConfig
extends java.lang.Object
implements LogoutListener
```
This class is used by the SMProxy family of classes to store configuration parameters. The parameters that can be set are the following:
- SSLEnabled - Used to determine if an SSL connection should be used for this connection. The default setting is false indicating SSL for this connection is not enabled.
- setSSLCipherSuites
- setSSLProtocols
- setKeyManager
- setTrustManager - Setting allows Trusted Certificates (CA or End Entity to be added or removed). These certificates are used to determined whether the SSL server should be trusted by configuring the JSSEX509TrustManager for the SMProxySSLSocketFactory.
  Note:The certificates are stored in a static memory cache. This means every certificate added or removed through this class will be added/removed for every subsequent HTTPS connection made with a SMProxy related class instance.
When SSL is enabled, either a KeyManager and TrustManager parameters must be provided, or a User object can be supplied. Example usage. Implicit SMProxy configuration via INI:
```
 User user = new User();
 user.setConnections(inifile);
 .
 .
 user.login(CredentialReader,SecureStringBuffer);
 
```
Explicit SMProxy configuration - Directory only:
```
 User user = new User();
 
 SMProxyConfig config = new SMProxyConfig(user); 
 SMProxyDirectory directory = new SMProxyDirectory("http://proxyserver");
 directory.setSMProxyConfig(config);
 user.setConnections(directory, null);
 .
 .
 user.login(CredentialReader,SecureStringBuffer);
 
```
Since:

8.1

Constructor Summary

Constructors
Constructor and Description
`SMProxyConfig()` The default constructor.
`SMProxyConfig(boolean enabled)` Constructor which allows SSL to be enabled or disabled for this SMProxy configuration.
`SMProxyConfig(User user)` Constructor which enables SSL and creates a keyManager and trustManager object from the provided user object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`getClientAuth()` Returns true is this Security Manager Proxy client will respond to a request for client authentication.
`static boolean`	`getCompatMode()` Returns whether compatibility mode is enabled.
`javax.net.ssl.KeyManager`	`getKeyManager()` Returns the KeyManager
`java.lang.String[]`	`getSSLCipherSuites()` Returns the names of the SSL cipher suites that will be used for the Security Manager Proxy connection.
`boolean`	`getSSLEnabled()` Returns SSL enabled value
`java.lang.String[]`	`getSSLProtocols()` Gets the SSL protocol versions that will be used for the Security Manager Proxy connection.
`javax.net.ssl.TrustManager`	`getTrustManager()` Returns the TrustManager
`void`	`logout()` The logout callback function; called from the user when logging out.
`static void`	`setClientAuth(boolean enable)` Enables or disables client authentication for the SSL session.
`static void`	`setCompatMode(boolean enable)` Sets compatibility mode.
`void`	`setKeyManager(javax.net.ssl.KeyManager keyManger)` Sets the KeyManager to use for the SSL connection
`void`	`setSSLCipherSuites(java.lang.String[] sslCipherSuites)` Sets the SSL cipher suites that will be used for the Security Manager Proxy connection.
`void`	`setSSLEnabled(boolean SSL)` Sets whether SSL should be enabled.
`void`	`setSSLProtocols(java.lang.String[] sslProtocols)` Sets the SSL protocol versions that will be used for the Security Manager Proxy connection.
`void`	`setTrustManager(javax.net.ssl.TrustManager trustManger)` Sets the trustManager to use for the SSL connection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SMProxyConfig
```
public SMProxyConfig()
```
    The default constructor. The following default parameters are set:
    - SSLEnabled - false
  - SMProxyConfig
```
public SMProxyConfig(boolean enabled)
```
    Constructor which allows SSL to be enabled or disabled for this SMProxy configuration.
    
    Parameters:
    
    enabled - sets whether SSL is enabled or disabled.
  - SMProxyConfig
```
public SMProxyConfig(User user)
              throws SMProxyException
```
    Constructor which enables SSL and creates a keyManager and trustManager object from the provided user object.
    Note: The user in this case would typically be offline. Also, once the user logs out the keyManager and trustManager will be cleared.
    
    Parameters:
    
    user - Entrust user that will be used to create the trustManager and keyManager.
    
    Throws:
    
    SMProxyException - if there are any other issues when attempting to obtain credentials from the provided user.
- Method Detail
  - getSSLProtocols
```
public java.lang.String[] getSSLProtocols()
```
    Gets the SSL protocol versions that will be used for the Security Manager Proxy connection.
    
    Returns:
    
    an array of the supported protocols.
  - setSSLProtocols
```
public void setSSLProtocols(java.lang.String[] sslProtocols)
```
    Sets the SSL protocol versions that will be used for the Security Manager Proxy connection.
    
    Parameters:
    
    sslProtocols - List of all the protocols to enable.
  - getSSLCipherSuites
```
public java.lang.String[] getSSLCipherSuites()
```
    Returns the names of the SSL cipher suites that will be used for the Security Manager Proxy connection.
    
    Returns:
    
    an array of cipher suite names
  - setSSLCipherSuites
```
public void setSSLCipherSuites(java.lang.String[] sslCipherSuites)
```
    Sets the SSL cipher suites that will be used for the Security Manager Proxy connection.
    
    Parameters:
    
    sslCipherSuites - List of all the cipher suites to enable
  - setKeyManager
```
public void setKeyManager(javax.net.ssl.KeyManager keyManger)
```
    Sets the KeyManager to use for the SSL connection
    
    Parameters:
    
    keyManger - the m_keyManager to set
  - setTrustManager
```
public void setTrustManager(javax.net.ssl.TrustManager trustManger)
```
    Sets the trustManager to use for the SSL connection
    
    Parameters:
    
    trustManger - the trustManager to set
  - getKeyManager
```
public javax.net.ssl.KeyManager getKeyManager()
```
    Returns the KeyManager
    
    Returns:
    
    the m_keyManager
  - getTrustManager
```
public javax.net.ssl.TrustManager getTrustManager()
```
    Returns the TrustManager
    
    Returns:
    
    the m_trustManager
  - getSSLEnabled
```
public boolean getSSLEnabled()
```
    Returns SSL enabled value
    
    Returns:
    
    true if SSL is enabled, false if SSL is not enabled
  - setSSLEnabled
```
public void setSSLEnabled(boolean SSL)
```
    Sets whether SSL should be enabled.
    
    Parameters:
    
    SSL - true indicates SSL enabled, false SSL disabled
  - logout
```
public void logout()
```
    Description copied from interface: LogoutListener
    
    The logout callback function; called from the user when logging out.
    
    Specified by:
    
    logout in interface LogoutListener
  - getClientAuth
```
public static boolean getClientAuth()
```
    Returns true is this Security Manager Proxy client will respond to a request for client authentication. This gets the value of the system property 'com.entrust.toolkit.SMProxy.useClientAuth'
    
    Returns:
    
    true is client authentication is enabled
  - setClientAuth
```
public static void setClientAuth(boolean enable)
```
    Enables or disables client authentication for the SSL session.
    As the private key is only available in some cases, it's recommended that this setting is always set to false. User create, recover and roaming are not possible if this value is set. This sets the value of the system property 'com.entrust.toolkit.SMProxy.useClientAuth'
    
    Parameters:
    
    enable - set to true to enable client authentication. Defaults to false.
  - getCompatMode
```
public static boolean getCompatMode()
```
    Returns whether compatibility mode is enabled.
    When connecting to Security Manager Proxy server 6 , this must be true. This returns the value for the system property 'com.entrust.toolkit.smproxy.compat'
    
    Returns:
    
    whether compatibility mode is enabled
  - setCompatMode
```
public static void setCompatMode(boolean enable)
```
    Sets compatibility mode.
    When connecting to Security Manager Proxy server 6 , this must be set to true. This sets the value for the system property 'com.entrust.toolkit.smproxy.compat'
    
    Parameters:
    
    enable - whether compatibility mode is enabled. Defaults to false.

Class SMProxyConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SMProxyConfig

SMProxyConfig

SMProxyConfig

Method Detail

getSSLProtocols

setSSLProtocols

getSSLCipherSuites

setSSLCipherSuites

setKeyManager

setTrustManager

getKeyManager

getTrustManager

getSSLEnabled

setSSLEnabled

logout

getClientAuth

setClientAuth

getCompatMode

setCompatMode