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

All Superinterfaces:

java.io.Serializable

public interface ClientSecurityConfiguration
extends java.io.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 methods are added in future releases.

Since:

WAS XD 6.0.1

See Also:

ObjectGridManager.connect(ClientSecurityConfiguration, URL), ObjectGridManager.connect(String, HostPortConnectionAttributes[], ClientSecurityConfiguration, URL), ObjectGridManager.connect(String, String, String, ClientSecurityConfiguration, URL), ObjectGridManager.connect(URL, String, ClientSecurityConfiguration, URL)

Method Summary

int	getAuthenticationRetryCount() Gets the authentication retry count for this client security configuration.
int	getClientCertificateAuthentication() Gets the client certificate authentication type for this client security configuration.
int	getCredentialAuthenticationType() Gets the credential authentication type for this client security configuration.
CredentialGenerator	getCredentialGenerator() Gets the CredentialGenerator object for this client security configuration.
java.lang.String	getCredentialGeneratorClass() Gets the CredentialGenerator implementation class name set in the client security property file.
java.lang.String	getCredentialGeneratorProps() Gets the CredentialGenerator properties set in the client security property file.
SSLConfiguration	getSSLConfiguration() Gets the SSLConfiguration object associated with this client security configuration.
int	getTransportType() Gets the transport type for this client security configuration.
boolean	isSecurityEnabled() Gets whether security is enabled for this client security configuration.
boolean	isSingleSignOnEnabled() Gets whether single sign on is enabled for this client security configuration.
void	setAuthenticationRetryCount(int authenticationRetryCount) Sets the authentication retry count for this client security configuration.
void	setClientCertificateAuthentication(int clientCertAuthen) Set the client certificate authentication type for this client security configuration.
void	setCredentialAuthenticationType(int credAuthen) Sest the credential authentication type for this client security configuration.
void	setCredentialGenerator(CredentialGenerator generator) Sets the CredentialGenerator object for this client security configuration.
void	setSecurityEnabled(boolean isSecurityEnabled) Sets whether or not security is enabled for this client security configuration.
void	setSingleSignOnEnabled(boolean enabled) Sets whether or not single sign on is enabled for this client security configuration.
void	setSSLConfiguration(SSLConfiguration sslConfig) Sets the SSLConfiguration object associated with this client security configuration.
void	setTransportType(int type) Sets the transport type for this client security configuration.

Method Detail

getAuthenticationRetryCount

int getAuthenticationRetryCount()

Gets the authentication retry count for this client security configuration.

The authentication retry count is the number a times authentication will be reattempted if there is a failure during authentication indicating the credential is expired.

Returns:

the argument that was passed to the setAuthenticationRetryCount(int) method of this interface or 0 if setAuthenticationRetryCount was not previously called for this object.

See Also:

setAuthenticationRetryCount(int)

setAuthenticationRetryCount

void setAuthenticationRetryCount(int authenticationRetryCount)

Sets the authentication retry count for this client security configuration.

Parameters:

authenticationRetryCount - the authentication retry count

Throws:

java.lang.IllegalArgumentException - if authenticationRetryCount is less than zero

getTransportType

int getTransportType()

Gets the transport type for this client security configuration.

The return value will be one of the three transport types defined on the SecurityConstants class.

Returns:

the argument that was passed to the setTransportType(int) method of this interface or SecurityConstants.SSL_SUPPORTED if setTransportType was not previously called for this object.

See Also:

setTransportType(int), SecurityConstants.TCP_IP, SecurityConstants.SSL_SUPPORTED, SecurityConstants.SSL_REQUIRED

getClientCertificateAuthentication

int getClientCertificateAuthentication()

Gets the client certificate authentication type for this client security configuration.

Returns:

the argument that was passed to the setClientCertificateAuthentication(int) method of this interface or SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED if setClientCertificateAuthentication was not previously called for this object.

See Also:

setClientCertificateAuthentication(int), SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_NEVER, SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED, SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED

isSecurityEnabled

boolean isSecurityEnabled()

Gets whether security is enabled for this client security configuration.

Returns:

the argument that was passed to the setSecurityEnabled(boolean) method of this interface or false if setSecurityEnabled was not previously called for this object.

See Also:

setSecurityEnabled(boolean)

isSingleSignOnEnabled

boolean isSingleSignOnEnabled()

Gets whether single sign on is enabled for this client security configuration.

Returns:

the argument that was passed to the setSingleSignOnEnabled(boolean) method of this interface or false if setSingleSignOnEnabled was not previously called for this object.

See Also:

setSingleSignOnEnabled(boolean)

setClientCertificateAuthentication

void setClientCertificateAuthentication(int clientCertAuthen)

Set the client certificate authentication type for this client security configuration.

Parameters:

clientCertAuthen - the client ceritificate authentication type

Throws:

java.lang.IllegalArgumentException - if clientCertAuthen is not one of the valid values from the SecurityConstants class.

See Also:

SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_NEVER, SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED, SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED

setTransportType

void setTransportType(int type)

Sets the transport type for this client security configuration.

Parameters:

type - the transport type

Throws:

java.lang.IllegalArgumentException - if type is not one of the valid values from the SecurityConstants class.

See Also:

SecurityConstants.TCP_IP, SecurityConstants.SSL_SUPPORTED, SecurityConstants.SSL_REQUIRED

setSecurityEnabled

void setSecurityEnabled(boolean isSecurityEnabled)

Sets whether or not security is enabled for this client security configuration.

Parameters:

isSecurityEnabled - whether or not security is enabled

setSingleSignOnEnabled

void setSingleSignOnEnabled(boolean enabled)

Sets whether or not single sign on is enabled for this client security configuration.

Parameters:

enabled - whether or not single sign on is enabled

getSSLConfiguration

SSLConfiguration getSSLConfiguration()

Gets the SSLConfiguration object associated with this client security configuration.

Returns:

the argument that was passed to the setSSLConfiguration(SSLConfiguration) method of this interface or null if setSSLConfiguration was not previously called for this object.

See Also:

setSSLConfiguration(SSLConfiguration), SSLConfiguration

setSSLConfiguration

void setSSLConfiguration(SSLConfiguration sslConfig)

Sets the SSLConfiguration object associated with this client security configuration.

Parameters:

sslConfig - the SSL setting for this object.

See Also:

SSLConfiguration

getCredentialAuthenticationType

int getCredentialAuthenticationType()

Gets the credential authentication type for this client security configuration.

Returns:

the argument that was passed to the setCredentialAuthenticationType(int) method of this interface or SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED if setCredentialAuthenticationType was not previously called for this object.

See Also:

setCredentialAuthenticationType(int), SecurityConstants.CREDENTIAL_AUTHENTICATION_NEVER, SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED, SecurityConstants.CREDENTIAL_AUTHENTICATION_REQUIRED

setCredentialAuthenticationType

void setCredentialAuthenticationType(int credAuthen)

Sest the credential authentication type for this client security configuration.

Parameters:

credAuthen - the credential authentication type

Throws:

java.lang.IllegalArgumentException - if credAuthen is not one of the valid values from the SecurityConstants class.

See Also:

SecurityConstants.CREDENTIAL_AUTHENTICATION_NEVER, SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED, SecurityConstants.CREDENTIAL_AUTHENTICATION_REQUIRED

setCredentialGenerator

void setCredentialGenerator(CredentialGenerator generator)

Sets the CredentialGenerator object for this client security configuration.

Parameters:

generator - a CredentialGenerator object

See Also:

CredentialGenerator

getCredentialGenerator

CredentialGenerator getCredentialGenerator()

Gets the CredentialGenerator object for this client security configuration.

Returns:

the argument that was passed to the setCredentialGenerator(CredentialGenerator) method of this interface or null if setCredentialGenerator was not previously called for this object.

See Also:

setCredentialGenerator(CredentialGenerator), CredentialGenerator

getCredentialGeneratorClass

java.lang.String getCredentialGeneratorClass()

Gets the CredentialGenerator implementation class name set in the client security property file.

If the "credentialGeneratorClass" property is not set in the security property file, a null will be returned.

Returns:

the value of the "credentialGeneratorClass" from the client security property file. null is returned if no value is set for this property.

See Also:

getCredentialGeneratorProps()

getCredentialGeneratorProps

java.lang.String getCredentialGeneratorProps()

Gets the CredentialGenerator properties set in the client security property file.

If the "credentialGeneratorProps" property is not set in the security security property file, a null will be returned.

If the "credentialGeneratorProps" property is set, but the property "credentialGeneratorClass" is not set, the "credentialGeneratorProps" property will be ignored. In this case, a null will be returned by this method.

Returns:

the value of the "credentialGeneratorProps" property from the client security property file. null is returned if no value is set for this property or for the "credentialGeneratorClass" property.

See Also:

getCredentialGeneratorClass()