com.ibm.websphere.objectgrid.security.plugins.builtins
Class KeyStoreLoginAuthenticator

java.lang.Object
  com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginAuthenticator

All Implemented Interfaces:

Authenticator

public class KeyStoreLoginAuthenticator
extends Object
implements Authenticator

This class is an implementation of the Authenticator interface when a user name and password are used as a credential.

When user ID and password authentication is used, the credential passed to the authenticate(Credential) method is a UserPasswordCredential object.

This implementation will use a KeyStoreLoginModule to authenticate the user into the key store using the JAAS login module "KeyStoreLogin". The key store can be configured as an option to the KeyStoreLoginModule class. Please see the KeyStoreLoginModule class for more details about how to set up the JAAS login configuration file.

This class is fully supported for production use.

Since:

WAS XD 6.0.1

See Also:

Authenticator, KeyStoreLoginModule, UserPasswordCredential

Constructor Summary

KeyStoreLoginAuthenticator()
Creates a new KeyStoreLoginAuthenticator.

Method Summary

Subject

authenticate(Credential credential) Authenticates a UserPasswordCredential.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStoreLoginAuthenticator

public KeyStoreLoginAuthenticator()

Creates a new KeyStoreLoginAuthenticator.

Method Detail

authenticate

public Subject authenticate(Credential credential)
                     throws InvalidCredentialException,
                            ExpiredCredentialException

Authenticates a UserPasswordCredential.

Uses the user name and password from the specified UserPasswordCredential to login to the KeyStoreLoginModule named "KeyStoreLogin".

Specified by:

authenticate in interface Authenticator

Parameters:

credential - the user Credential

Returns:

a Subject object representing the user

Throws:

InvalidCredentialException - if credential isn't a UserPasswordCredential or some error occurs during processing of the supplied UserPasswordCredential

ExpiredCredentialException - if credential is expired. This exception is not used by this implementation

See Also:

Authenticator.authenticate(Credential), KeyStoreLoginModule