org.jasig.cas.authentication.support

Class DefaultAccountStateHandler

java.lang.Object

org.jasig.cas.authentication.support.DefaultAccountStateHandler

All Implemented Interfaces:

AccountStateHandler

Direct Known Subclasses:

OptionalWarningAccountStateHandler

public class DefaultAccountStateHandler
extends Object
implements AccountStateHandler

Default account state handler.

Since:

4.0.0

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger instance.

Constructor Summary

Constructors

Constructor and Description
DefaultAccountStateHandler()

Method Summary

Methods

Modifier and Type	Method and Description
List<Message>	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, List<Message> messages) Handle an account state error produced by ldaptive account state machinery.
protected void	handleWarning(org.ldaptive.auth.AccountState.Warning warning, org.ldaptive.auth.AuthenticationResponse response, LdapPasswordPolicyConfiguration configuration, List<Message> messages) Handle an account state warning produced by ldaptive account state machinery.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger instance.

Constructor Detail

DefaultAccountStateHandler

public DefaultAccountStateHandler()

Method Detail

handle

public List<Message> handle(org.ldaptive.auth.AuthenticationResponse response,
                   LdapPasswordPolicyConfiguration configuration)
                     throws 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:

LoginException - When account state causes authentication failure.

handleError

protected void handleError(org.ldaptive.auth.AccountState.Error error,
               org.ldaptive.auth.AuthenticationResponse response,
               LdapPasswordPolicyConfiguration configuration,
               List<Message> messages)
                    throws 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:

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,
                 List<Message> messages)

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

Override this method to provide custom warning message handling.

Parameters:

error - Account state warning.

response - Ldaptive authentication response.

configuration - Password policy configuration.

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