net.shibboleth.idp.authn.principal

Class PrincipalEvalPredicateFactoryRegistry

java.lang.Object

net.shibboleth.idp.authn.principal.PrincipalEvalPredicateFactoryRegistry

public final class PrincipalEvalPredicateFactoryRegistry
extends Object

A registry of mappings between a custom Principal subtype with a matching operator and a corresponding PrincipalEvalPredicateFactory that returns predicates enforcing a particular set of matching rules for that operator and subtype.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private Map<Pair<Class<? extends Principal>,String>,PrincipalEvalPredicateFactory>	registry Storage for the registry mappings.

Constructor Summary

Constructors

Constructor and Description
PrincipalEvalPredicateFactoryRegistry() Constructor.
PrincipalEvalPredicateFactoryRegistry(Map<Pair<Class<? extends Principal>,String>,PrincipalEvalPredicateFactory> fromMap) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	deregister(Class<? extends Principal> principalType, String operator) Deregister a predicate factory for a given operator string.
PrincipalEvalPredicateFactory	lookup(Class<? extends Principal> principalType, String operator) Get a registered predicate factory for a given principal type and operator string, if any.
void	register(Class<? extends Principal> principalType, String operator, PrincipalEvalPredicateFactory factory) Register a predicate factory for a given operator string.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

registry

@Nonnull
@NonnullElements
private Map<Pair<Class<? extends Principal>,String>,PrincipalEvalPredicateFactory> registry

Storage for the registry mappings.

Constructor Detail

PrincipalEvalPredicateFactoryRegistry

public PrincipalEvalPredicateFactoryRegistry()

Constructor.

PrincipalEvalPredicateFactoryRegistry

public PrincipalEvalPredicateFactoryRegistry(@Nonnull@NonnullElements@ParameterName(name="fromMap")
                                     Map<Pair<Class<? extends Principal>,String>,PrincipalEvalPredicateFactory> fromMap)

Constructor.

Parameters:

fromMap - map to populate registry with

Method Detail

lookup

@Nullable
public PrincipalEvalPredicateFactory lookup(@Nonnull
                                            Class<? extends Principal> principalType,
                                            @Nonnull@NotEmpty
                                            String operator)

Get a registered predicate factory for a given principal type and operator string, if any.

Parameters:

principalType - a principal subtype

operator - an operator string

Returns:

a corresponding predicate factory, or null

register

public void register(@Nonnull
            Class<? extends Principal> principalType,
            @Nonnull@NotEmpty
            String operator,
            @Nonnull
            PrincipalEvalPredicateFactory factory)

Register a predicate factory for a given operator string.

Parameters:

principalType - a principal subtype

operator - an operator string

factory - the predicate factory to register

deregister

public void deregister(@Nonnull
              Class<? extends Principal> principalType,
              @Nonnull@NotEmpty
              String operator)

Deregister a predicate factory for a given operator string.

Parameters:

principalType - a principal subtype

operator - an operator string