com.ibm.websphere.objectgrid.security.plugins
Interface Authenticator

All Known Implementing Classes:

CertificateMappingAuthenticator, KeyStoreLoginAuthenticator, LDAPAuthenticator, WSTokenAuthenticator

public interface Authenticator

This plugin can be used to authenticate an ObjectGrid client to an ObjectGrid server based on the credential provided by the client. A Subject object is returned as a result of authentication.

This plugin is used in an ObjectGrid server. It can be configured in the ObjectGrid cluster XML file.

The Credential passed in the authenticate(Credential) method can contain any credential information users desire. For example, it could be a Credential object containing a user password pair.

ObjectGrid provides several built-in implementations for this interface:

• com.ibm.websphere.objectgrid.security.plugins.builtins.CertificateMappingAuthenticator: An authenticator that simply maps a SSL certficate to a Subject.
• com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginAuthenticator: An authenticator that authenticates a user ID and password to a key file.
• com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticator: An authenticator that authenticates a user ID and password to a LDAP server.
• com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenAuthenticator: An authenticator that authenticates a WebSphere Application Server securty token.

Refer to the respective JavaDoc for more details.

Since:

WAS XD 6.0.1

See Also:

Credential

Method Summary

Subject

authenticate(Credential credential) Authenticates a user represented by the credential object.

Method Detail

authenticate

Subject authenticate(Credential credential)
                     throws InvalidCredentialException,
                            ExpiredCredentialException

Authenticates a user represented by the credential object.

Parameters:

credential - the user Credential

Returns:

a Subject object representing the user

Throws:

InvalidCredentialException - if the credential is invalid

ExpiredCredentialException - if the credential is expired

See Also:

Credential