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

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

All Implemented Interfaces:

LoginModule

public class SimpleLDAPLoginModule
extends Object
implements LoginModule

SimpleLDAPLoginModule 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. This may be an SSL URL, in which case the trust store for the server will be used to validate the LDAP server certificate
• factoryClass: The ldap context factory implementation class, which is typically "com.sun.jndi.ldap.LdapCtxFactory".

Here is a Login module configuration example which may be used by LDAPAuthenticator:

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

The example providerURL points to an LDAP server with the port number 389. The initial context factory is com.sun.jndi.ldap.LdapCtxFactory. This login module returns a principal of class javax.security.auth.x500.X500Principal.

Since:

WebSphere eXtreme Scale 8.6

See Also:

LoginModule

Constructor Summary

SimpleLDAPLoginModule()

Method Summary

boolean	abort()
boolean	commit()
void	initialize(Subject _subject, CallbackHandler _callbackHandler, Map<String,?> _sharedState, Map<String,?> _options)
boolean	login()
boolean	logout()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLDAPLoginModule

public SimpleLDAPLoginModule()

Method Detail

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

initialize

public void initialize(Subject _subject,
                       CallbackHandler _callbackHandler,
                       Map<String,?> _sharedState,
                       Map<String,?> _options)

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException