Package net.shibboleth.idp.authn.principal

Class DefaultPrincipalDeterminationStrategy<T extends Principal>

java.lang.Object

net.shibboleth.idp.authn.principal.DefaultPrincipalDeterminationStrategy<T>

Type Parameters:

T - the custom Principal type to locate

All Implemented Interfaces:

Function<ProfileRequestContext,T>

@Deprecated(since="4.3.0",
            forRemoval=true)
public class DefaultPrincipalDeterminationStrategy<T extends Principal>
extends Object
implements Function<ProfileRequestContext,T>

Deprecated, for removal: This API element is subject to removal in a future version.

Function that returns the first custom Principal of a particular type found on the AuthenticationResult returned by AuthenticationContext.getAuthenticationResult().

The context is located using a lookup strategy, by default a child of the input context.

If for any reason a matching Principal can't be located, a default is returned.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,AuthenticationContext>	authnContextLookupStrategy	Deprecated, for removal: This API element is subject to removal in a future version. Authentication context lookup strategy.
private T	defaultPrincipal	Deprecated, for removal: This API element is subject to removal in a future version. Default Principal to return.
private Class<T>	principalType	Deprecated, for removal: This API element is subject to removal in a future version. Type of Principal to return.

Constructor Summary

Constructors

Constructor	Description
DefaultPrincipalDeterminationStrategy(Class<T> type, T principal)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor.

Method Summary

Modifier and Type	Method	Description
T	apply(ProfileRequestContext input)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setAuthenticationContextLookupStrategy(Function<ProfileRequestContext,AuthenticationContext> strategy)	Deprecated, for removal: This API element is subject to removal in a future version. Set lookup strategy for AuthenticationContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Detail

principalType

@Nonnull
private final Class<T extends Principal> principalType

Deprecated, for removal: This API element is subject to removal in a future version.

Type of Principal to return.

defaultPrincipal

@Nonnull
private final T extends Principal defaultPrincipal

Deprecated, for removal: This API element is subject to removal in a future version.

Default Principal to return.

authnContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AuthenticationContext> authnContextLookupStrategy

Deprecated, for removal: This API element is subject to removal in a future version.

Authentication context lookup strategy.

Constructor Detail

DefaultPrincipalDeterminationStrategy

public DefaultPrincipalDeterminationStrategy(@Nonnull @ParameterName(name="type")
                                             Class<T> type,
                                             @Nonnull @ParameterName(name="principal")
                                             T principal)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor.

Parameters:

type - class type for Principal type

principal - default Principal to return

Method Detail

setAuthenticationContextLookupStrategy

public void setAuthenticationContextLookupStrategy(@Nonnull
                                                   Function<ProfileRequestContext,AuthenticationContext> strategy)

Deprecated, for removal: This API element is subject to removal in a future version.

Set lookup strategy for AuthenticationContext.

Parameters:

strategy - lookup strategy

apply

@Nullable
public T apply(@Nullable
               ProfileRequestContext input)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

apply in interface Function<ProfileRequestContext,T extends Principal>