Package net.shibboleth.sp.credential

Class AbstractOrderedCredentialResolver

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.sp.credential.AbstractOrderedCredentialResolver

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<Credential,CriteriaSet>, OrderedCredentialResolver, CredentialResolver, Ordered

Direct Known Subclasses:

StaticCredentialResolver, StaticMapCredentialResolver

public abstract class AbstractOrderedCredentialResolver
extends AbstractIdentifiableInitializableComponent
implements OrderedCredentialResolver

Simple base class for resolvers to supply an Ordered implementation if they don't need a dedicated base class.

Additional "value-adds" include the component handling, the resolveSingle method, and built-in support for UsageCriterion and ProtocolCriterion filtering.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOrderedCredentialResolver.UsageCriterionPredicate	This is more or less a duplicate of an OpenSAML implementation class to filter by usage.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	filterByUsage	Whether to apply usage filteing.
private final org.slf4j.Logger	log	Class logger.
private int	order	Order.
private Set<String>	supportedProtocols	Protocol values supported by these credentials.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractOrderedCredentialResolver()	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract Iterable<Credential>	doResolve(CriteriaSet criteria)	Subclasses implement this method to resolve the underlying objects.
private Iterable<Credential>	filter(Iterable<Credential> creds, CriteriaSet criteria)	Filter the supplied credentials by type and/or usage as required.
int	getOrder()
Iterable<Credential>	resolve(CriteriaSet criteria)
Credential	resolveSingle(CriteriaSet criteriaSet)
void	setFilterByUsage(boolean flag)	Sets whether to apply UsageCriterion if supplied to the results.
void	setOrder(int i)	Set component order.
void	setProtocols(Collection<String> protocols)	Sets the protocol values supported by this resolver.

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

order

private int order

Order.

filterByUsage

private boolean filterByUsage

Whether to apply usage filteing.

supportedProtocols

private Set<String> supportedProtocols

Protocol values supported by these credentials.

Constructor Details

AbstractOrderedCredentialResolver

public AbstractOrderedCredentialResolver()

Constructor.

Method Details

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setOrder

public void setOrder(int i)

Set component order.

Defaults to Ordered.LOWEST_PRECEDENCE - 1, meaning "as low as possible except for components specifically configured to be lowest", allowing certain objects or types to be explicitly configured to be last.

Parameters:

i - order value

setFilterByUsage

public void setFilterByUsage(boolean flag)

Sets whether to apply UsageCriterion if supplied to the results.

Defaults to true.

Parameters:

flag - flag to set

setProtocols

public void setProtocols(@Nullable
 Collection<String> protocols)

Sets the protocol values supported by this resolver.

If set, any ProtocolCriterion will be enforced apriori before returning any credentials.

Parameters:

protocols - the protocols supported

resolveSingle

@Nullable
public Credential resolveSingle(@Nullable
 CriteriaSet criteriaSet)
                         throws ResolverException

Specified by:

resolveSingle in interface Resolver<Credential,CriteriaSet>

Throws:

ResolverException

resolve

@Nonnull
public Iterable<Credential> resolve(@Nullable
 CriteriaSet criteria)
                             throws ResolverException

Specified by:

resolve in interface Resolver<Credential,CriteriaSet>

Throws:

ResolverException

filter

@Nonnull
private Iterable<Credential> filter(@Nonnull
 Iterable<Credential> creds,
 @Nullable
 CriteriaSet criteria)

Filter the supplied credentials by type and/or usage as required.

Parameters:

creds - resolved credentials

criteria - input criteria

Returns:

filtered credentials

doResolve

@Nonnull
public abstract Iterable<Credential> doResolve(@Nullable
 CriteriaSet criteria)
                                        throws ResolverException

Subclasses implement this method to resolve the underlying objects.

Parameters:

criteria - criteria for resolution

Returns:

resolved credential iterator

Throws:

ResolverException - if an error occurs