IBM WebSphere Extended Deployment (XD)TM
Release 6.0.1

com.ibm.websphere.objectgrid.security.config
ClientSecurityConfiguration

All Implemented Interfaces
Serializable


This interface represents the client side security configurations. User can call ClientSecurityConfigurationFactory.getClientSecurityConfiguration() to get a ClientSecurityConfiguration instance.

Users are not recommended to implement this interface in case more access methods are added in future releases.
See Also:

    



Method Summary
public  intgetAuthenticationRetryCount()
          
public  voidsetAuthenticationRetryCount(int)
           set the authentication retry count. The default value is .
public  intgetTransportType()
          
public  intgetClientCertificateAuthentication()
          
public  booleanisSecurityEnabled()
          
public  booleanisSingleSignOnEnabled()
          
public  voidsetClientCertificateAuthentication(int)
          
public  voidsetTransportType(int)
          
public  voidsetSecurityEnabled(boolean)
          
public  voidsetSingleSignOnEnabled(boolean)
           Set whether single sign on is enabled.
public  SSLConfigurationgetSSLConfiguration()
           Get the SSLConfiguration object associated with this client.
public  voidsetSSLConfiguration(com.ibm.websphere.objectgrid.security.config.SSLConfiguration)
           Set the SSLConfiguration object associated with this client.
public  intgetCredentialAuthenticationType()
           This methods returns the custom authentication mode. A custom authentication.
public  voidsetCredentialAuthenticationType(int)
           This methods can used to set the basic authentication mode. A basic .
public  voidsetCredentialGenerator(com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator)
           Set the CredentialGenerator object for this client.
public  CredentialGeneratorgetCredentialGenerator()
           Get the CredentialGenerator object for this client.

Method Detail

getAuthenticationRetryCount

public int getAuthenticationRetryCount()


Returns:
     authentication retry count


setAuthenticationRetryCount

public void setAuthenticationRetryCount(int authenticationRetryCount)
set the authentication retry count. The default value is #DEFAULT_AUTHENTICATION_RETRY_COUNT.
Parameters:
    authenticationRetryCount - the authentication retry count


getTransportType

public int getTransportType()

See Also:
    TCP_IPSSL_SUPPORTEDSSL_REQUIRED


Returns:
     the transport type


getClientCertificateAuthentication

public int getClientCertificateAuthentication()

See Also:
    CLIENT_CERTIFICATE_AUTHENTICATION_NEVERCLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTEDCLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED


Returns:
     the client certificate authentication type


isSecurityEnabled

public boolean isSecurityEnabled()


Returns:
     whether the security is enabled or not


isSingleSignOnEnabled

public boolean isSingleSignOnEnabled()


Returns:
     whether Single Sign on is enabled for this client.


setClientCertificateAuthentication

public void setClientCertificateAuthentication(int clientCertAuthen)
set the client certificate authentication type
See Also:
    CLIENT_CERTIFICATE_AUTHENTICATION_NEVERCLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTEDCLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED
Parameters:
    clientCertAuthen - the client ceritificate authentication type


setTransportType

public void setTransportType(int type)
Set the transport type
See Also:
    TCP_IPSSL_SUPPORTEDSSL_REQUIRED
Parameters:
    type - the transport type


setSecurityEnabled

public void setSecurityEnabled(boolean isSecurityEnabled)
set whether the security is enabled or not
Parameters:


setSingleSignOnEnabled

public void setSingleSignOnEnabled(boolean enabled)
Set whether single sign on is enabled.
Parameters:
    enabled - whether single sign on is enabled for this client or not.


getSSLConfiguration

public SSLConfiguration getSSLConfiguration()
Get the SSLConfiguration object associated with this client.


Returns:
     the SSL setting for this client.


setSSLConfiguration

public void setSSLConfiguration(SSLConfiguration sslConfig)
Set the SSLConfiguration object associated with this client.
Parameters:
    sslConfig - the SSL setting for this client.


getCredentialAuthenticationType

public int getCredentialAuthenticationType()
This methods returns the custom authentication mode. A custom authentication mode can be one of the following: For more details about the authentication modes and their impacts to the authentication. Please refer to the constants.
See Also:
    CREDENTIAL_AUTHENTICATION_NEVERCREDENTIAL_AUTHENTICATION_SUPPORTEDCREDENTIAL_AUTHENTICATION_REQUIRED


Returns:
     the basic authentication mode


setCredentialAuthenticationType

public void setCredentialAuthenticationType(int credAuthen)
This methods can used to set the basic authentication mode. A basic authentication mode can be one of the following: For more details about the authentication modes and their impacts to the authentication. Please refer to the constants.
See Also:
    CREDENTIAL_AUTHENTICATION_NEVERCREDENTIAL_AUTHENTICATION_SUPPORTEDCREDENTIAL_AUTHENTICATION_REQUIRED
Parameters:
    credAuthen - the basic authentication mode


setCredentialGenerator

public void setCredentialGenerator(CredentialGenerator generator)
Set the CredentialGenerator object for this client.
Parameters:
    generator - the CredentialGenerator object associated with this client


getCredentialGenerator

public CredentialGenerator getCredentialGenerator()
Get the CredentialGenerator object for this client.


Returns:
     the CredentialGenerator object associated with this client


IBM WebSphere Extended Deployment (XD)TM
Release 6.0.1