Package org.apereo.cas.authentication.policy

Class BaseAuthenticationHandlerAuthenticationPolicy

java.lang.Object

org.apereo.cas.authentication.policy.BaseAuthenticationPolicy

org.apereo.cas.authentication.policy.BaseAuthenticationHandlerAuthenticationPolicy

All Implemented Interfaces:

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

Direct Known Subclasses:

ExcludedAuthenticationHandlerAuthenticationPolicy, RequiredAuthenticationHandlerAuthenticationPolicy

public abstract class BaseAuthenticationHandlerAuthenticationPolicy
extends BaseAuthenticationPolicy

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

Since:

4.0.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Set<String>	getHandlerNames()	Authentication handler name that is required to satisfy policy.
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.
BaseAuthenticationHandlerAuthenticationPolicy	setHandlerNames(Set<String> handlerNames)	Authentication handler name that is required to satisfy policy.
BaseAuthenticationHandlerAuthenticationPolicy	setTryAll(boolean tryAll)	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

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)

equals

public boolean equals(Object o)

Overrides:

equals in class BaseAuthenticationPolicy

hashCode

public int hashCode()

Overrides:

hashCode in class BaseAuthenticationPolicy

setHandlerNames

public BaseAuthenticationHandlerAuthenticationPolicy setHandlerNames(Set<String> handlerNames)

Authentication handler name that is required to satisfy policy.

Returns:

this.

setTryAll

public BaseAuthenticationHandlerAuthenticationPolicy setTryAll(boolean tryAll)

Flag to try all credentials before policy is satisfied.

Returns:

this.

getHandlerNames

public Set<String> getHandlerNames()

Authentication handler name that is required to satisfy policy.

isTryAll

public boolean isTryAll()

Flag to try all credentials before policy is satisfied.