com.liferay.portal.security.auth

Class LDAPAuth

java.lang.Object

com.liferay.portal.security.auth.LDAPAuth

All Implemented Interfaces:

com.liferay.portal.security.auth.Authenticator

public class LDAPAuth
extends java.lang.Object
implements com.liferay.portal.security.auth.Authenticator

Author:

Brian Wing Shun Chan, Scott Lee, Josef Sustacek

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_METHOD_BIND
static java.lang.String	AUTH_METHOD_PASSWORD_COMPARE
static java.lang.String	RESULT_PASSWORD_EXP_WARNING
static java.lang.String	RESULT_PASSWORD_RESET

Fields inherited from interface com.liferay.portal.security.auth.Authenticator

DNE, FAILURE, SKIP_LIFERAY_CHECK, SUCCESS

Constructor Summary

Constructors

Constructor and Description
LDAPAuth()

Method Summary

Methods

Modifier and Type	Method and Description
protected LDAPAuthResult	authenticate(javax.naming.ldap.LdapContext ctx, long companyId, javax.naming.directory.Attributes attributes, java.lang.String userDN, java.lang.String password)
protected int	authenticate(long ldapServerId, long companyId, java.lang.String emailAddress, java.lang.String screenName, long userId, java.lang.String password)
protected int	authenticate(long companyId, java.lang.String emailAddress, java.lang.String screenName, long userId, java.lang.String password)
protected int	authenticateAgainstPreferredLDAPServer(long companyId, java.lang.String emailAddress, java.lang.String screenName, long userId, java.lang.String password)
int	authenticateByEmailAddress(long companyId, java.lang.String emailAddress, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
int	authenticateByScreenName(long companyId, java.lang.String screenName, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
int	authenticateByUserId(long companyId, long userId, java.lang.String password, java.util.Map<java.lang.String,java.lang.String[]> headerMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
protected int	authenticateOmniadmin(long companyId, java.lang.String emailAddress, java.lang.String screenName, long userId)
protected int	authenticateRequired(long companyId, long userId, java.lang.String emailAddress, java.lang.String screenName, boolean allowOmniadmin, int failureCode)
protected LDAPAuthResult	getFailedLDAPAuthResult(java.util.Map<java.lang.String,java.lang.Object> env)
protected java.lang.String	getKey(java.util.Map<java.lang.String,java.lang.Object> env)
protected void	setFailedLDAPAuthResult(java.util.Map<java.lang.String,java.lang.Object> env, LDAPAuthResult ldapAuthResult)

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_METHOD_BIND

public static final java.lang.String AUTH_METHOD_BIND

See Also:

Constant Field Values

AUTH_METHOD_PASSWORD_COMPARE

public static final java.lang.String AUTH_METHOD_PASSWORD_COMPARE

See Also:

Constant Field Values

RESULT_PASSWORD_EXP_WARNING

public static final java.lang.String RESULT_PASSWORD_EXP_WARNING

See Also:

Constant Field Values

RESULT_PASSWORD_RESET

public static final java.lang.String RESULT_PASSWORD_RESET

See Also:

Constant Field Values

Constructor Detail

LDAPAuth

public LDAPAuth()

Method Detail

authenticateByEmailAddress

public int authenticateByEmailAddress(long companyId,
                             java.lang.String emailAddress,
                             java.lang.String password,
                             java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                             java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
                               throws com.liferay.portal.security.auth.AuthException

Specified by:

authenticateByEmailAddress in interface com.liferay.portal.security.auth.Authenticator

Throws:

com.liferay.portal.security.auth.AuthException

authenticateByScreenName

public int authenticateByScreenName(long companyId,
                           java.lang.String screenName,
                           java.lang.String password,
                           java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                           java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
                             throws com.liferay.portal.security.auth.AuthException

Specified by:

authenticateByScreenName in interface com.liferay.portal.security.auth.Authenticator

Throws:

com.liferay.portal.security.auth.AuthException

authenticateByUserId

public int authenticateByUserId(long companyId,
                       long userId,
                       java.lang.String password,
                       java.util.Map<java.lang.String,java.lang.String[]> headerMap,
                       java.util.Map<java.lang.String,java.lang.String[]> parameterMap)
                         throws com.liferay.portal.security.auth.AuthException

Specified by:

authenticateByUserId in interface com.liferay.portal.security.auth.Authenticator

Throws:

com.liferay.portal.security.auth.AuthException

authenticate

protected LDAPAuthResult authenticate(javax.naming.ldap.LdapContext ctx,
                          long companyId,
                          javax.naming.directory.Attributes attributes,
                          java.lang.String userDN,
                          java.lang.String password)
                               throws java.lang.Exception

Throws:

java.lang.Exception

authenticate

protected int authenticate(long ldapServerId,
               long companyId,
               java.lang.String emailAddress,
               java.lang.String screenName,
               long userId,
               java.lang.String password)
                    throws java.lang.Exception

Throws:

java.lang.Exception

authenticate

protected int authenticate(long companyId,
               java.lang.String emailAddress,
               java.lang.String screenName,
               long userId,
               java.lang.String password)
                    throws java.lang.Exception

Throws:

java.lang.Exception

authenticateAgainstPreferredLDAPServer

protected int authenticateAgainstPreferredLDAPServer(long companyId,
                                         java.lang.String emailAddress,
                                         java.lang.String screenName,
                                         long userId,
                                         java.lang.String password)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

authenticateOmniadmin

protected int authenticateOmniadmin(long companyId,
                        java.lang.String emailAddress,
                        java.lang.String screenName,
                        long userId)
                             throws java.lang.Exception

Throws:

java.lang.Exception

authenticateRequired

protected int authenticateRequired(long companyId,
                       long userId,
                       java.lang.String emailAddress,
                       java.lang.String screenName,
                       boolean allowOmniadmin,
                       int failureCode)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getFailedLDAPAuthResult

protected LDAPAuthResult getFailedLDAPAuthResult(java.util.Map<java.lang.String,java.lang.Object> env)

getKey

protected java.lang.String getKey(java.util.Map<java.lang.String,java.lang.Object> env)

setFailedLDAPAuthResult

protected void setFailedLDAPAuthResult(java.util.Map<java.lang.String,java.lang.Object> env,
                           LDAPAuthResult ldapAuthResult)