org.apereo.cas.authentication.support

Class DefaultAccountStateHandler

java.lang.Object

org.apereo.cas.authentication.support.DefaultAccountStateHandler

All Implemented Interfaces:

AccountStateHandler

Direct Known Subclasses:

OptionalWarningAccountStateHandler

public class DefaultAccountStateHandler
extends java.lang.Object
implements AccountStateHandler

Default account state handler.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<org.ldaptive.auth.AccountState.Error,javax.security.auth.login.LoginException>	errorMap Map of account state error to CAS authentication exception.
protected org.slf4j.Logger	logger Logger instance.

Constructor Summary

Constructors

Constructor and Description
DefaultAccountStateHandler() Instantiates a new account state handler, that populates the error map with LDAP error codes and corresponding exceptions.

Method Summary

Modifier and Type	Method and Description
java.util.List<MessageDescriptor>	handle(org.ldaptive.auth.AuthenticationResponse response, LdapPasswordPolicyConfiguration configuration) Handles the account state producing an error or warning messages as appropriate to the state.
protected void	handleError(org.ldaptive.auth.AccountState.Error error, org.ldaptive.auth.AuthenticationResponse response, LdapPasswordPolicyConfiguration configuration, java.util.List<MessageDescriptor> messages) Handle an account state error produced by ldaptive account state machinery.
protected void	handlePolicyAttributes(org.ldaptive.auth.AuthenticationResponse response) Maps boolean attribute values to their corresponding exception.
protected void	handleWarning(org.ldaptive.auth.AccountState.Warning warning, org.ldaptive.auth.AuthenticationResponse response, LdapPasswordPolicyConfiguration configuration, java.util.List<MessageDescriptor> messages) Handle an account state warning produced by ldaptive account state machinery.
void	setAttributesToErrorMap(java.util.Map<java.lang.String,java.lang.Class<javax.security.auth.login.LoginException>> attributesToErrorMap)

Methods inherited from class java.lang.Object

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

Field Detail

errorMap

protected java.util.Map<org.ldaptive.auth.AccountState.Error,javax.security.auth.login.LoginException> errorMap

Map of account state error to CAS authentication exception.

logger

protected transient org.slf4j.Logger logger

Logger instance.

Constructor Detail

DefaultAccountStateHandler

public DefaultAccountStateHandler()

Instantiates a new account state handler, that populates the error map with LDAP error codes and corresponding exceptions.

Method Detail

handle

public java.util.List<MessageDescriptor> handle(org.ldaptive.auth.AuthenticationResponse response,
                                                LdapPasswordPolicyConfiguration configuration)
                                         throws javax.security.auth.login.LoginException

Description copied from interface: AccountStateHandler

Handles the account state producing an error or warning messages as appropriate to the state.

Specified by:

handle in interface AccountStateHandler

Parameters:

response - LDAP authentication response containing attributes, response controls, and account state that can be used to determine user account state.

configuration - Password policy configuration.

Returns:

List of warning messages.

Throws:

javax.security.auth.login.LoginException - When account state causes authentication failure.

handleError

protected void handleError(org.ldaptive.auth.AccountState.Error error,
                           org.ldaptive.auth.AuthenticationResponse response,
                           LdapPasswordPolicyConfiguration configuration,
                           java.util.List<MessageDescriptor> messages)
                    throws javax.security.auth.login.LoginException

Handle an account state error produced by ldaptive account state machinery.

Override this method to provide custom error handling.

Parameters:

error - Account state error.

response - Ldaptive authentication response.

configuration - Password policy configuration.

messages - Container for messages produced by account state error handling.

Throws:

javax.security.auth.login.LoginException - On errors that should be communicated as login exceptions.

handleWarning

protected void handleWarning(org.ldaptive.auth.AccountState.Warning warning,
                             org.ldaptive.auth.AuthenticationResponse response,
                             LdapPasswordPolicyConfiguration configuration,
                             java.util.List<MessageDescriptor> messages)

Handle an account state warning produced by ldaptive account state machinery.

Override this method to provide custom warning message handling.

Parameters:

warning - the account state warning messages.

response - Ldaptive authentication response.

configuration - Password policy configuration.

messages - Container for messages produced by account state warning handling.

setAttributesToErrorMap

public void setAttributesToErrorMap(java.util.Map<java.lang.String,java.lang.Class<javax.security.auth.login.LoginException>> attributesToErrorMap)

handlePolicyAttributes

protected void handlePolicyAttributes(org.ldaptive.auth.AuthenticationResponse response)

Maps boolean attribute values to their corresponding exception. This handles ad-hoc password policies.

Parameters:

response - the authentication response.