|
IBM WebSphereTM eXtreme Scale, Release 8.6 API Specification |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientSecurityConfiguration
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.
ObjectGridManager.connect(ClientSecurityConfiguration, URL)
,
ObjectGridManager.connect(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. |
String |
getCredentialGeneratorClass()
Gets the CredentialGenerator implementation class name set
in the client security property file. |
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 |
---|
int getAuthenticationRetryCount()
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.
setAuthenticationRetryCount(int)
method of
this interface or 0
if setAuthenticationRetryCount
was not previously called for this object.setAuthenticationRetryCount(int)
void setAuthenticationRetryCount(int authenticationRetryCount)
authenticationRetryCount
- the authentication retry count
IllegalArgumentException
- if authenticationRetryCount is less than zeroint getTransportType()
The return value will be one of the three transport types defined
on the SecurityConstants
class.
setTransportType(int)
method of this interface or
SecurityConstants.SSL_SUPPORTED
if setTransportType
was not previously called for this object.setTransportType(int)
,
SecurityConstants.TCP_IP
,
SecurityConstants.SSL_SUPPORTED
,
SecurityConstants.SSL_REQUIRED
int getClientCertificateAuthentication()
setClientCertificateAuthentication(int)
method of
this interface or SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED
if setClientCertificateAuthentication
was not
previously called for this object.setClientCertificateAuthentication(int)
,
SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_NEVER
,
SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED
,
SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED
boolean isSecurityEnabled()
setSecurityEnabled(boolean)
method of
this interface or false
if setSecurityEnabled
was not
previously called for this object.setSecurityEnabled(boolean)
boolean isSingleSignOnEnabled()
setSingleSignOnEnabled(boolean)
method of
this interface or false
if setSingleSignOnEnabled
was not
previously called for this object.setSingleSignOnEnabled(boolean)
void setClientCertificateAuthentication(int clientCertAuthen)
clientCertAuthen
- the client ceritificate authentication type
IllegalArgumentException
- if clientCertAuthen is not one of
the valid values from the SecurityConstants
class.SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_NEVER
,
SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED
,
SecurityConstants.CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED
void setTransportType(int type)
type
- the transport type
IllegalArgumentException
- if type is not one of the valid
values from the SecurityConstants
class.SecurityConstants.TCP_IP
,
SecurityConstants.SSL_SUPPORTED
,
SecurityConstants.SSL_REQUIRED
void setSecurityEnabled(boolean isSecurityEnabled)
isSecurityEnabled
- whether or not security is enabledvoid setSingleSignOnEnabled(boolean enabled)
enabled
- whether or not single sign on is enabledSSLConfiguration getSSLConfiguration()
SSLConfiguration
object associated with this client
security configuration.
setSSLConfiguration(SSLConfiguration)
method of
this interface or null
if setSSLConfiguration
was not
previously called for this object.setSSLConfiguration(SSLConfiguration)
,
SSLConfiguration
void setSSLConfiguration(SSLConfiguration sslConfig)
SSLConfiguration
object associated with this client
security configuration.
sslConfig
- the SSL setting for this object.SSLConfiguration
int getCredentialAuthenticationType()
setCredentialAuthenticationType(int)
method of
this interface or SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED
if setCredentialAuthenticationType
was not
previously called for this object.setCredentialAuthenticationType(int)
,
SecurityConstants.CREDENTIAL_AUTHENTICATION_NEVER
,
SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED
,
SecurityConstants.CREDENTIAL_AUTHENTICATION_REQUIRED
void setCredentialAuthenticationType(int credAuthen)
credAuthen
- the credential authentication type
IllegalArgumentException
- if credAuthen is not one of
the valid values from the SecurityConstants
class.SecurityConstants.CREDENTIAL_AUTHENTICATION_NEVER
,
SecurityConstants.CREDENTIAL_AUTHENTICATION_SUPPORTED
,
SecurityConstants.CREDENTIAL_AUTHENTICATION_REQUIRED
void setCredentialGenerator(CredentialGenerator generator)
CredentialGenerator
object for this client
security configuration.
generator
- a CredentialGenerator objectCredentialGenerator
CredentialGenerator getCredentialGenerator()
CredentialGenerator
object for this client
security configuration.
setCredentialGenerator(CredentialGenerator)
method of
this interface or null
if setCredentialGenerator
was not
previously called for this object.setCredentialGenerator(CredentialGenerator)
,
CredentialGenerator
String getCredentialGeneratorClass()
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.
null
is returned if no value
is set for this property.getCredentialGeneratorProps()
String getCredentialGeneratorProps()
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.
null
is returned
if no value is set for this property or for the
"credentialGeneratorClass" property.getCredentialGeneratorClass()
|
IBM WebSphereTM eXtreme Scale, Release 8.6 API Specification |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |