org.apereo.cas.services

Class AbstractMultifactorAuthenticationProvider

java.lang.Object

org.apereo.cas.services.AbstractMultifactorAuthenticationProvider

All Implemented Interfaces:

java.io.Serializable, MultifactorAuthenticationProvider, org.springframework.core.Ordered

Direct Known Subclasses:

AuthyMultifactorAuthenticationProvider, AzureAuthenticatorMultifactorAuthenticationProvider, DefaultDuoMultifactorAuthenticationProvider, DefaultVariegatedMultifactorAuthenticationProvider, GoogleAuthenticatorMultifactorAuthenticationProvider, RadiusMultifactorAuthenticationProvider, SwivelMultifactorAuthenticationProvider, U2FMultifactorAuthenticationProvider, YubiKeyMultifactorAuthenticationProvider

public abstract class AbstractMultifactorAuthenticationProvider
extends java.lang.Object
implements MultifactorAuthenticationProvider, java.io.Serializable

The AbstractMultifactorAuthenticationProvider is responsible for as the parent of all providers.

Since:

4.3

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractMultifactorAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getId() Gets id for this provider.
int	getOrder()
int	hashCode()
protected boolean	isAvailable() Is provider available?
boolean	isAvailable(RegisteredService service) Ensure the provider is available.
boolean	matches(java.lang.String identifier) Does provider match/support this identifier?
void	setBypassEvaluator(MultifactorAuthenticationProviderBypass bypassEvaluator)
void	setGlobalFailureMode(java.lang.String globalFailureMode)
void	setId(java.lang.String id)
void	setOrder(int order)
boolean	supports(org.springframework.webflow.execution.Event e, Authentication authentication, RegisteredService registeredService) Indicates whether the current active event is supported by this mfa provider based on the given authentication and service definition.
protected boolean	supportsInternal(org.springframework.webflow.execution.Event e, Authentication authentication, RegisteredService registeredService) Determine internally if provider is able to support this authentication request for multifactor, and account for bypass rules..
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractMultifactorAuthenticationProvider

public AbstractMultifactorAuthenticationProvider()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: MultifactorAuthenticationProvider

Gets id for this provider.

Specified by:

getId in interface MultifactorAuthenticationProvider

Returns:

the id

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setId

public void setId(java.lang.String id)

setOrder

public void setOrder(int order)

setGlobalFailureMode

public void setGlobalFailureMode(java.lang.String globalFailureMode)

supports

public final boolean supports(org.springframework.webflow.execution.Event e,
                              Authentication authentication,
                              RegisteredService registeredService)

Description copied from interface: MultifactorAuthenticationProvider

Indicates whether the current active event is supported by this mfa provider based on the given authentication and service definition. This allows each mfa provider to design bypass rules based on traits of the service or authentication, or both.

Specified by:

supports in interface MultifactorAuthenticationProvider

Parameters:

e - the event

authentication - the authentication

registeredService - the registered service

Returns:

true if supported

supportsInternal

protected boolean supportsInternal(org.springframework.webflow.execution.Event e,
                                   Authentication authentication,
                                   RegisteredService registeredService)

Determine internally if provider is able to support this authentication request for multifactor, and account for bypass rules..

Parameters:

e - the event

authentication - the authentication

registeredService - the registered service

Returns:

the boolean

isAvailable

public boolean isAvailable(RegisteredService service)
                    throws AuthenticationException

Description copied from interface: MultifactorAuthenticationProvider

Ensure the provider is available.

Specified by:

isAvailable in interface MultifactorAuthenticationProvider

Parameters:

service - the service

Returns:

true /false flag once verification is successful.

Throws:

AuthenticationException - the authentication exception

isAvailable

protected boolean isAvailable()

Is provider available?

Returns:

the true/false

setBypassEvaluator

public void setBypassEvaluator(MultifactorAuthenticationProviderBypass bypassEvaluator)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

matches

public boolean matches(java.lang.String identifier)

Description copied from interface: MultifactorAuthenticationProvider

Does provider match/support this identifier?

Specified by:

matches in interface MultifactorAuthenticationProvider

Parameters:

identifier - the identifier

Returns:

the boolean