org.apereo.cas.authentication

Class DefaultVariegatedMultifactorAuthenticationProvider

java.lang.Object

org.apereo.cas.authentication.AbstractMultifactorAuthenticationProvider

org.apereo.cas.authentication.DefaultVariegatedMultifactorAuthenticationProvider

All Implemented Interfaces:

java.io.Serializable, org.apereo.cas.services.MultifactorAuthenticationProvider, org.apereo.cas.services.VariegatedMultifactorAuthenticationProvider, org.springframework.core.Ordered

public class DefaultVariegatedMultifactorAuthenticationProvider
extends AbstractMultifactorAuthenticationProvider
implements org.apereo.cas.services.VariegatedMultifactorAuthenticationProvider

This is DefaultVariegatedMultifactorAuthenticationProvider.

Since:

5.1.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
DefaultVariegatedMultifactorAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
void	addProvider(org.apereo.cas.services.MultifactorAuthenticationProvider provider) For variegated providers with multiple configured encapsulated variation ones, use `id` and `order` props from the first one as the top level pieces of data to be correctly used by downstream components e.g.
org.apereo.cas.services.MultifactorAuthenticationProvider	findProvider(java.lang.String identifier)
<T extends org.apereo.cas.services.MultifactorAuthenticationProvider> T	findProvider(java.lang.String identifier, java.lang.Class<T> clazz)
java.lang.String	getFriendlyName()
protected boolean	isAvailable() Is provider available?
boolean	isAvailable(org.apereo.cas.services.RegisteredService service)
boolean	matches(java.lang.String identifier)

Methods inherited from class org.apereo.cas.authentication.AbstractMultifactorAuthenticationProvider

supports, supportsInternal

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.services.VariegatedMultifactorAuthenticationProvider

getProviders

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

getId, supports

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

DefaultVariegatedMultifactorAuthenticationProvider

public DefaultVariegatedMultifactorAuthenticationProvider()

Method Detail

addProvider

public void addProvider(org.apereo.cas.services.MultifactorAuthenticationProvider provider)

For variegated providers with multiple configured encapsulated variation ones, use `id` and `order` props from the first one as the top level pieces of data to be correctly used by downstream components e.g. get correct ranking and id If in the future there will be an actual use case for utilizing concrete ids and ranking order for each individual variation of provider within variegated wrapper, then we could refactor this code to introduce more pluggable strategy API for configuring these parts.

Specified by:

addProvider in interface org.apereo.cas.services.VariegatedMultifactorAuthenticationProvider

Parameters:

provider - the provider

isAvailable

public boolean isAvailable(org.apereo.cas.services.RegisteredService service)
                    throws org.apereo.cas.authentication.AuthenticationException

Specified by:

isAvailable in interface org.apereo.cas.services.MultifactorAuthenticationProvider

Overrides:

isAvailable in class AbstractMultifactorAuthenticationProvider

Throws:

org.apereo.cas.authentication.AuthenticationException

isAvailable

protected boolean isAvailable()

Description copied from class: AbstractMultifactorAuthenticationProvider

Is provider available?

Overrides:

isAvailable in class AbstractMultifactorAuthenticationProvider

Returns:

the true/false

matches

public boolean matches(java.lang.String identifier)

Specified by:

matches in interface org.apereo.cas.services.MultifactorAuthenticationProvider

Overrides:

matches in class AbstractMultifactorAuthenticationProvider

findProvider

public org.apereo.cas.services.MultifactorAuthenticationProvider findProvider(java.lang.String identifier)

Specified by:

findProvider in interface org.apereo.cas.services.VariegatedMultifactorAuthenticationProvider

findProvider

public <T extends org.apereo.cas.services.MultifactorAuthenticationProvider> T findProvider(java.lang.String identifier,
                                                                                            @NonNull
                                                                                            java.lang.Class<T> clazz)

Specified by:

findProvider in interface org.apereo.cas.services.VariegatedMultifactorAuthenticationProvider

getFriendlyName

public java.lang.String getFriendlyName()

Specified by:

getFriendlyName in interface org.apereo.cas.services.MultifactorAuthenticationProvider