Package org.apereo.cas.configuration.model.support.mfa

Class MultifactorAuthenticationProviderSelectionProperties

java.lang.Object

org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderSelectionProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-authentication",
                automated=true)
public class MultifactorAuthenticationProviderSelectionProperties
extends Object
implements Serializable

This is MultifactorAuthenticationProviderSelectionProperties.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MultifactorAuthenticationProviderSelectionProperties()

Method Summary

Modifier and Type	Method	Description
MultifactorAuthenticationProviderSelectionCookieProperties	getCookie()	Cookie settings that control how the selected mfa provider should be remembered.
SpringResourceProperties	getProviderSelectorGroovyScript()	In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, by default CAS will attempt to sort the collection of providers based on their rank and will pick one with the highest priority.
boolean	isProviderSelectionEnabled()	In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, this setting will allow one to interactively choose a provider out of the list of available providers.
MultifactorAuthenticationProviderSelectionProperties	setCookie(MultifactorAuthenticationProviderSelectionCookieProperties cookie)	Cookie settings that control how the selected mfa provider should be remembered.
MultifactorAuthenticationProviderSelectionProperties	setProviderSelectionEnabled(boolean providerSelectionEnabled)	In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, this setting will allow one to interactively choose a provider out of the list of available providers.
MultifactorAuthenticationProviderSelectionProperties	setProviderSelectorGroovyScript(SpringResourceProperties providerSelectorGroovyScript)	In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, by default CAS will attempt to sort the collection of providers based on their rank and will pick one with the highest priority.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultifactorAuthenticationProviderSelectionProperties

public MultifactorAuthenticationProviderSelectionProperties()

Method Details

getProviderSelectorGroovyScript

public SpringResourceProperties getProviderSelectorGroovyScript()

In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, by default CAS will attempt to sort the collection of providers based on their rank and will pick one with the highest priority. This use case may arise if multiple triggers are defined where each decides on a different multifactor authentication provider, or the same provider instance is configured multiple times with many instances. Provider selection may also be carried out using Groovy scripting strategies more dynamically. The following example should serve as an outline of how to select multifactor providers based on a Groovy script.

isProviderSelectionEnabled

public boolean isProviderSelectionEnabled()

In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, this setting will allow one to interactively choose a provider out of the list of available providers. A trigger may be designed to support more than one provider, and rather than letting CAS auto-determine the selected provider via scripts or ranking strategies, this method puts the choice back onto the user to decide which provider makes the most sense at any given time.

getCookie

public MultifactorAuthenticationProviderSelectionCookieProperties getCookie()

Cookie settings that control how the selected mfa provider should be remembered.

setProviderSelectorGroovyScript

public MultifactorAuthenticationProviderSelectionProperties setProviderSelectorGroovyScript(SpringResourceProperties providerSelectorGroovyScript)

In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, by default CAS will attempt to sort the collection of providers based on their rank and will pick one with the highest priority. This use case may arise if multiple triggers are defined where each decides on a different multifactor authentication provider, or the same provider instance is configured multiple times with many instances. Provider selection may also be carried out using Groovy scripting strategies more dynamically. The following example should serve as an outline of how to select multifactor providers based on a Groovy script.

Returns:

this.

setProviderSelectionEnabled

public MultifactorAuthenticationProviderSelectionProperties setProviderSelectionEnabled(boolean providerSelectionEnabled)

In the event that multiple multifactor authentication providers are determined for a multifactor authentication transaction, this setting will allow one to interactively choose a provider out of the list of available providers. A trigger may be designed to support more than one provider, and rather than letting CAS auto-determine the selected provider via scripts or ranking strategies, this method puts the choice back onto the user to decide which provider makes the most sense at any given time.

Returns:

this.

setCookie

public MultifactorAuthenticationProviderSelectionProperties setCookie(MultifactorAuthenticationProviderSelectionCookieProperties cookie)

Cookie settings that control how the selected mfa provider should be remembered.

Returns:

this.