Package org.apereo.cas.authentication

Interface ChainingMultifactorAuthenticationProvider

All Superinterfaces:

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

public interface ChainingMultifactorAuthenticationProvider
extends MultifactorAuthenticationProvider

This is ChainingMultifactorAuthenticationProvider.

Since:

6.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_IDENTIFIER	The identifier for the chained provider.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
MultifactorAuthenticationProvider	addMultifactorAuthenticationProvider(MultifactorAuthenticationProvider provider)	Add multifactor authentication provider multifactor authentication provider.
void	addMultifactorAuthenticationProviders(java.util.Collection<MultifactorAuthenticationProvider> providers)	Add multifactor authentication providers.
default void	addMultifactorAuthenticationProviders(MultifactorAuthenticationProvider... providers)	Add multifactor authentication providers.
default org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes	getFailureMode()	This method will return the failure mode for the provider.
default java.lang.String	getFriendlyName()	Gets the friendly-name for this provider.
default java.lang.String	getId()	Gets id for this provider.
java.util.Collection<MultifactorAuthenticationProvider>	getMultifactorAuthenticationProviders()	Gets multifactor authentication providers.
default int	getOrder()
default boolean	isAvailable(org.apereo.cas.services.RegisteredService service)	Ensure the provider is available.
default boolean	matches(java.lang.String identifier)	Does provider match/support this identifier? The identifier passed may be formed as a regular expression.

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

getBypassEvaluator, getFailureModeEvaluator

Field Detail

DEFAULT_IDENTIFIER

static final java.lang.String DEFAULT_IDENTIFIER

The identifier for the chained provider.

See Also:

Constant Field Values

Method Detail

getMultifactorAuthenticationProviders

java.util.Collection<MultifactorAuthenticationProvider> getMultifactorAuthenticationProviders()

Gets multifactor authentication providers.

Returns:

the multifactor authentication providers

addMultifactorAuthenticationProvider

MultifactorAuthenticationProvider addMultifactorAuthenticationProvider(MultifactorAuthenticationProvider provider)

Add multifactor authentication provider multifactor authentication provider.

Parameters:

provider - the provider

Returns:

the multifactor authentication provider

addMultifactorAuthenticationProviders

void addMultifactorAuthenticationProviders(java.util.Collection<MultifactorAuthenticationProvider> providers)

Add multifactor authentication providers.

Parameters:

providers - the providers

addMultifactorAuthenticationProviders

default void addMultifactorAuthenticationProviders(MultifactorAuthenticationProvider... providers)

Add multifactor authentication providers.

Parameters:

providers - the providers

isAvailable

default boolean isAvailable(org.apereo.cas.services.RegisteredService service)
                     throws org.apereo.cas.authentication.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:

org.apereo.cas.authentication.AuthenticationException - the authentication exception

getId

default java.lang.String getId()

Description copied from interface: MultifactorAuthenticationProvider

Gets id for this provider.

Specified by:

getId in interface MultifactorAuthenticationProvider

Returns:

the id

getFriendlyName

default java.lang.String getFriendlyName()

Description copied from interface: MultifactorAuthenticationProvider

Gets the friendly-name for this provider.

Specified by:

getFriendlyName in interface MultifactorAuthenticationProvider

Returns:

the name

matches

default boolean matches(java.lang.String identifier)

Description copied from interface: MultifactorAuthenticationProvider

Does provider match/support this identifier? The identifier passed may be formed as a regular expression.

Specified by:

matches in interface MultifactorAuthenticationProvider

Parameters:

identifier - the identifier

Returns:

true/false

getFailureMode

default org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes getFailureMode()

Description copied from interface: MultifactorAuthenticationProvider

This method will return the failure mode for the provider.

Specified by:

getFailureMode in interface MultifactorAuthenticationProvider

Returns:

the FailureMode

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered