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

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

All Implemented Interfaces:

LoginModule

Deprecated. This plug-in is deprecated in version 8.6. Use the SimpleLDAPLoginModule LoginModule.

public class LDAPLoginModule
extends Object
implements LoginModule

This LDAPLoginModule authenticates a user name and password to the configured LDAP server.

A login configuration should provide at least the following two options:

• providerURL: The LDAP server provider URL
• factoryClass: The ldap context factory implementation class

Here is a Login module configuration example used by the sample LDAPAuthenticator:

 LDAPLogin {
     com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule required
     providerURL="ldap://bluepages.ibm.com:389/"
     factoryClass="com.sun.jndi.ldap.LdapCtxFactory"
     debug=true;
 };
 

The providerURL points to the IBM bluepages LDAP server with the port number 389. The initial context factory is com.sun.jndi.ldap.LdapCtxFactory.

Since:

WAS XD 6.0.1

See Also:

LoginModule

Field Summary

static String	FACTORY_CLASS Deprecated. LDAP context factory implementation class property name
static String	PROVIDER_URL Deprecated. LDAP server provider URL property name

Constructor Summary

LDAPLoginModule()
Deprecated.

Method Summary

boolean	abort() Deprecated. Called if the LoginContext's overall authentication failed.
boolean	commit() Deprecated. Called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).
void	initialize(Subject _subject, CallbackHandler _callbackHandler, Map _sharedState, Map _options) Deprecated. Initializes this LoginModule.
boolean	login() Deprecated. Authenticates the user by a user name and password.
boolean	logout() Deprecated. Logs out the user.

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_URL

public static final String PROVIDER_URL

Deprecated.

LDAP server provider URL property name

See Also:

Constant Field Values

FACTORY_CLASS

public static final String FACTORY_CLASS

Deprecated.

LDAP context factory implementation class property name

See Also:

Constant Field Values

Constructor Detail

LDAPLoginModule

public LDAPLoginModule()

Deprecated.

Method Detail

initialize

public void initialize(Subject _subject,
                       CallbackHandler _callbackHandler,
                       Map _sharedState,
                       Map _options)

Deprecated.

Initializes this LoginModule.

Specified by:

initialize in interface LoginModule

Parameters:

_subject - the Subject to be authenticated.

_callbackHandler - a CallbackHandler for communicating with the end user (prompting for user names and passwords, for example).

_sharedState - shared LoginModule state.

_options - options specified in the login Configuration for this particular LoginModule.

login

public boolean login()
              throws LoginException

Deprecated.

Authenticates the user by a user name and password.

Specified by:

login in interface LoginModule

Returns:

true in all cases since this LoginModule should not be ignored.

Throws:

FailedLoginException - if the authentication fails.

LoginException - if this LoginModule is unable to perform the authentication.

commit

public boolean commit()
               throws LoginException

Deprecated.

Called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), this method associates a SimpleUserPrincipal and SimpleDeptPrincipal with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, this method removes any state that was originally saved.

Specified by:

commit in interface LoginModule

Returns:

true if this LoginModule's own login and commit attempts succeeded, or false otherwise.

Throws:

LoginException - if the commit fails.

abort

public boolean abort()
              throws LoginException

Deprecated.

Called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login and commit methods), then this method cleans up any state that was originally saved.

Specified by:

abort in interface LoginModule

Returns:

false if this LoginModule's own login and/or commit attempts failed, and true otherwise.

Throws:

LoginException - if the abort fails.

logout

public boolean logout()
               throws LoginException

Deprecated.

Logs out the user.

This method removes the SamplePrincipal that was added by the commit method.

Specified by:

logout in interface LoginModule

Returns:

true in all cases since this LoginModule should not be ignored.

Throws:

LoginException - if the logout fails.