org.apereo.cas.authentication.policy

Class AnyAuthenticationPolicy

java.lang.Object

org.apereo.cas.authentication.policy.AnyAuthenticationPolicy

All Implemented Interfaces:

org.apereo.cas.authentication.AuthenticationPolicy, org.springframework.core.Ordered

Direct Known Subclasses:

NotPreventedAuthenticationPolicy

public class AnyAuthenticationPolicy
extends java.lang.Object
implements org.apereo.cas.authentication.AuthenticationPolicy

Authentication policy that is satisfied by at least one successfully authenticated 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
AnyAuthenticationPolicy() Instantiates a new Any authentication policy.
AnyAuthenticationPolicy(boolean tryAll) Instantiates a new Any authentication policy.

Method Summary

Modifier and Type	Method and Description
boolean	isSatisfiedBy(org.apereo.cas.authentication.Authentication authn)
void	setTryAll(boolean tryAll) Sets the flag to try all credentials before the policy is satisfied.

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

AnyAuthenticationPolicy

public AnyAuthenticationPolicy()

Instantiates a new Any authentication policy.

AnyAuthenticationPolicy

public AnyAuthenticationPolicy(boolean tryAll)

Instantiates a new Any authentication policy.

Parameters:

tryAll - the try all

Method Detail

setTryAll

public void setTryAll(boolean 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 successfully authenticated credential. Defaults to false.

Parameters:

tryAll - True to force all credentials to be authenticated, false otherwise.

isSatisfiedBy

public boolean isSatisfiedBy(org.apereo.cas.authentication.Authentication authn)
                      throws java.lang.Exception

Specified by:

isSatisfiedBy in interface org.apereo.cas.authentication.AuthenticationPolicy

Throws:

java.lang.Exception