org.jasig.cas.authentication.support

Class OptionalWarningAccountStateHandler

java.lang.Object

org.jasig.cas.authentication.support.DefaultAccountStateHandler

org.jasig.cas.authentication.support.OptionalWarningAccountStateHandler

All Implemented Interfaces:

AccountStateHandler

public class OptionalWarningAccountStateHandler
extends DefaultAccountStateHandler

The component supports both opt-in and opt-out warnings on a per-user basis using a simple algorithm of three variables:

1. warningAttributeName
2. setWarningAttributeValue(String) warningAttributeValue}
3. displayWarningOnMatch

The first two parameters define an attribute on the user entry to match on, and the third parameter determines whether password expiration warnings should be displayed on match.

Deployers MUST configure LDAP components to provide warningAttributeName in the set of attributes returned from the LDAP query for user details.

Since:

4.0.0

Author:

Marvin S. Addison

Field Summary

Fields inherited from class org.jasig.cas.authentication.support.DefaultAccountStateHandler

logger

Constructor Summary

Constructors

Constructor and Description
OptionalWarningAccountStateHandler()

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	setDisplayWarningOnMatch(boolean displayWarningOnMatch) Determines whether password expiration warnings are opt-in or opt-out.
void	setWarningAttributeName(String warningAttributeName) Sets the user attribute used to determine whether to display password expiration warnings.
void	setWarningAttributeValue(String warningAttributeValue) Sets the value of warningAttributeName used as basis of comparison.

Methods inherited from class org.jasig.cas.authentication.support.DefaultAccountStateHandler

handle, handleError

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalWarningAccountStateHandler

public OptionalWarningAccountStateHandler()

Method Detail

setWarningAttributeName

public void setWarningAttributeName(String warningAttributeName)

Sets the user attribute used to determine whether to display password expiration warnings.

Parameters:

warningAttributeName - Attribute on authenticated user entry.

setWarningAttributeValue

public void setWarningAttributeValue(String warningAttributeValue)

Sets the value of warningAttributeName used as basis of comparison.

Parameters:

warningAttributeValue - Value to match against.

setDisplayWarningOnMatch

public void setDisplayWarningOnMatch(boolean displayWarningOnMatch)

Determines whether password expiration warnings are opt-in or opt-out.

Parameters:

displayWarningOnMatch - True to opt into password expiration warnings on match, false to opt out on match. Default is true.

handleWarning

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

Description copied from class: DefaultAccountStateHandler

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

Override this method to provide custom warning message handling.

Overrides:

handleWarning in class DefaultAccountStateHandler

response - Ldaptive authentication response.

configuration - Password policy configuration.

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