Package org.apereo.cas.authentication.policy

Class AtLeastOneCredentialValidatedAuthenticationPolicy

java.lang.Object

org.apereo.cas.authentication.policy.BaseAuthenticationPolicy

org.apereo.cas.authentication.policy.AtLeastOneCredentialValidatedAuthenticationPolicy

All Implemented Interfaces:

Serializable, org.apereo.cas.authentication.AuthenticationPolicy, org.apereo.cas.util.NamedObject, org.springframework.core.Ordered

Direct Known Subclasses:

NotPreventedAuthenticationPolicy

public class AtLeastOneCredentialValidatedAuthenticationPolicy
extends BaseAuthenticationPolicy

Authentication policy that is satisfied by at least one successfully authenticated credential.

Since:

4.0.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AtLeastOneCredentialValidatedAuthenticationPolicy()
AtLeastOneCredentialValidatedAuthenticationPolicy(boolean tryAll)	Creates a new AtLeastOneCredentialValidatedAuthenticationPolicy instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
org.apereo.cas.authentication.AuthenticationPolicyExecutionResult	isSatisfiedBy(org.apereo.cas.authentication.Authentication authn, Set<org.apereo.cas.authentication.AuthenticationHandler> authenticationHandlers, org.springframework.context.ConfigurableApplicationContext applicationContext, Map<String,? extends Serializable> context)
boolean	isTryAll()	Flag to try all credentials before policy is satisfied.

Methods inherited from class org.apereo.cas.authentication.policy.BaseAuthenticationPolicy

getName, getOrder, setName, setOrder

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

isSatisfiedBy, isSatisfiedBy, isSatisfiedBy, shouldResumeOnFailure

Constructor Details

AtLeastOneCredentialValidatedAuthenticationPolicy

public AtLeastOneCredentialValidatedAuthenticationPolicy()

AtLeastOneCredentialValidatedAuthenticationPolicy

public AtLeastOneCredentialValidatedAuthenticationPolicy(boolean tryAll)

Creates a new AtLeastOneCredentialValidatedAuthenticationPolicy instance.

Parameters:

tryAll - Flag to try all credentials before policy is satisfied. Defaults to false.

Method Details

isSatisfiedBy

public org.apereo.cas.authentication.AuthenticationPolicyExecutionResult isSatisfiedBy(org.apereo.cas.authentication.Authentication authn,
 Set<org.apereo.cas.authentication.AuthenticationHandler> authenticationHandlers,
 org.springframework.context.ConfigurableApplicationContext applicationContext,
 Map<String,? extends Serializable> context)
                                                                                throws Exception

Throws:

Exception

equals

public boolean equals(Object o)

Overrides:

equals in class BaseAuthenticationPolicy

hashCode

public int hashCode()

Overrides:

hashCode in class BaseAuthenticationPolicy

isTryAll

public boolean isTryAll()

Flag to try all credentials before policy is satisfied. Defaults to false.