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:

com.google.common.base.Function<ProfileRequestContext,T>

public class DefaultPrincipalDeterminationStrategy<T extends Principal>
extends Object
implements com.google.common.base.Function<ProfileRequestContext,T>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DefaultPrincipalDeterminationStrategy.WeightedComparator A Comparator that compares the mapped weights of the two operands, using a weight of zero for any unmapped values.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext>	authnContextLookupStrategy Authentication context lookup strategy.
private T	defaultPrincipal Default Principal to return.
private Class<T>	principalType Type of Principal to return.
private Map<T,Integer>	weightMap A map supplying weighted preference to particular Principals.

Constructor Summary

Constructors

Constructor and Description
DefaultPrincipalDeterminationStrategy(Class<T> type, T principal) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
T	apply(ProfileRequestContext input)
void	setAuthenticationContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> strategy) Set lookup strategy for AuthenticationContext.
void	setWeightMap(Map<T,Integer> map) Set the map of Principals to weight values to impose a sort order on any matching Principals found in the authentication result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

principalType

@Nonnull
private final Class<T extends Principal> principalType

Type of Principal to return.

defaultPrincipal

@Nonnull
private final T extends Principal defaultPrincipal

Default Principal to return.

weightMap

@Nonnull
@NonnullElements
private Map<T extends Principal,Integer> weightMap

A map supplying weighted preference to particular Principals.

authnContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> authnContextLookupStrategy

Authentication context lookup strategy.

Constructor Detail

DefaultPrincipalDeterminationStrategy

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

Constructor.

Parameters:

type - class type for Principal type

principal - default Principal to return

Method Detail

setWeightMap

public void setWeightMap(@Nullable@NonnullElements
                Map<T,Integer> map)

Set the map of Principals to weight values to impose a sort order on any matching Principals found in the authentication result.

Parameters:

map - map to set

setAuthenticationContextLookupStrategy

public void setAuthenticationContextLookupStrategy(@Nonnull
                                          com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> strategy)

Set lookup strategy for AuthenticationContext.

Parameters:

strategy - lookup strategy

apply

@Nullable
public T apply(@Nullable
               ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Function<ProfileRequestContext,T extends Principal>