org.apereo.cas.authentication.policy

Class RequiredHandlerAuthenticationPolicy

java.lang.Object

org.apereo.cas.authentication.policy.RequiredHandlerAuthenticationPolicy

All Implemented Interfaces:

AuthenticationPolicy, org.springframework.core.Ordered

public class RequiredHandlerAuthenticationPolicy
extends java.lang.Object
implements AuthenticationPolicy

Authentication security policy that is satisfied iff a specified authentication handler successfully authenticates at least one credential.

Since:

4.0.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
RequiredHandlerAuthenticationPolicy(java.lang.String requiredHandlerName) Instantiates a new required handler authentication policy.
RequiredHandlerAuthenticationPolicy(java.lang.String requiredHandlerName, boolean tryAll) Instantiates a new Required handler authentication policy.

Method Summary

Modifier and Type	Method and Description
boolean	isSatisfiedBy(Authentication authn) Determines whether an authentication event isSatisfiedBy arbitrary security policy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.authentication.AuthenticationPolicy

getOrder

Constructor Detail

RequiredHandlerAuthenticationPolicy

public RequiredHandlerAuthenticationPolicy(java.lang.String requiredHandlerName)

Instantiates a new required handler authentication policy.

Parameters:

requiredHandlerName - the required handler name

RequiredHandlerAuthenticationPolicy

public RequiredHandlerAuthenticationPolicy(java.lang.String requiredHandlerName,
                                           boolean tryAll)

Instantiates a new Required handler authentication policy.

Parameters:

requiredHandlerName - the required handler name

tryAll - Sets the flag to try all credentials before the policy is satisfied. This flag is disabled by default such that the policy is satisfied immediately upon the first credential that is successfully authenticated by the required handler.

Method Detail

isSatisfiedBy

public boolean isSatisfiedBy(Authentication authn)

Description copied from interface: AuthenticationPolicy

Determines whether an authentication event isSatisfiedBy arbitrary security policy.

Specified by:

isSatisfiedBy in interface AuthenticationPolicy

Parameters:

authn - Authentication event to examine for compliance with security policy.

Returns:

True if authentication isSatisfiedBy security policy, false otherwise.