IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

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

java.lang.Object
  extended by com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticator
All Implemented Interfaces:
Authenticator

public class LDAPAuthenticator
extends Object
implements Authenticator

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

When basic authentication is used, the credential passed to the authenticate(Credential) method is a UserPasswordCredential object.

This implementation uses the SimpleLDAPLoginModule class to authenticate the user into an LDAP server using the JAAS login module "LDAPLogin". The parameters for the LDAP server connection can be configured as options to the LDAPLoginModule. Please refer to the SimpleLDAPLoginModule class for more details about what properties should be configured.

This class is fully supported for production use.

Since:
WAS XD 6.0.1
See Also:
Authenticator, SimpleLDAPLoginModule, UserPasswordCredential

Constructor Summary
LDAPAuthenticator()
          Creates a new LDAPAuthenticator
 
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

LDAPAuthenticator

public LDAPAuthenticator()
Creates a new LDAPAuthenticator

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 LDAPLoginModule named "LDAPLogin".

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), LDAPLoginModule

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.