Package org.wildfly.security.auth.server

Interface MechanismConfigurationSelector

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MechanismConfigurationSelector

A selector to choose which MechanismConfiguration to use based on information know about the current authentication attempt.

Author:

Darran Lofthouse

Method Summary

Modifier and Type	Method	Description
static MechanismConfigurationSelector	aggregate(MechanismConfigurationSelector... configurationSelectors)	Create a MechanismConfigurationSelector that is an aggregation of other selectors, when called the selectors will be called in order and the first MechanismConfiguration returned will be used.
static MechanismConfigurationSelector	constantSelector(MechanismConfiguration mechanismConfiguration)	Create a constant MechanismConfigurationSelector which will always return the same MechanismConfiguration instance.
static MechanismConfigurationSelector	predicateSelector(Predicate<MechanismInformation> predicate, MechanismConfiguration mechanismConfiguration)	Create a simple MechanismConfigurationSelector that is paired with a Predicate to test if the configuration should be used for the supplied information.
MechanismConfiguration	selectConfiguration(MechanismInformation mechanismInformation)	Select the MechanismConfiguration to use for the current authentication attempt.

Method Details

selectConfiguration

MechanismConfiguration selectConfiguration(MechanismInformation mechanismInformation)

Select the MechanismConfiguration to use for the current authentication attempt.

Parameters:

mechanismInformation - information about the current authentication attempt.

Returns:

the MechanismConfiguration to use for the current authentication attempt.

predicateSelector

static MechanismConfigurationSelector predicateSelector(Predicate<MechanismInformation> predicate,
 MechanismConfiguration mechanismConfiguration)

Create a simple MechanismConfigurationSelector that is paired with a Predicate to test if the configuration should be used for the supplied information.

Parameters:

predicate - the predicate to test the MechanismInformation

mechanismConfiguration - the MechanismConfiguration to return if the test passes.

Returns:

a simple MechanismConfigurationSelector backed by a Predicate to test if the configuration should be returned.

aggregate

static MechanismConfigurationSelector aggregate(MechanismConfigurationSelector... configurationSelectors)

Create a MechanismConfigurationSelector that is an aggregation of other selectors, when called the selectors will be called in order and the first MechanismConfiguration returned will be used.

Parameters:

configurationSelectors - the MechanismConfigurationSelector instances to aggregate.

Returns:

the MechanismConfigurationSelector that is an aggregation of the supplied selectors.

constantSelector

static MechanismConfigurationSelector constantSelector(MechanismConfiguration mechanismConfiguration)

Create a constant MechanismConfigurationSelector which will always return the same MechanismConfiguration instance.

Parameters:

mechanismConfiguration - a configuration which will be always returned by created selector

Returns:

the new configuration selector