org.opensaml.security.credential.impl

Class AbstractCriteriaFilteringCredentialResolver

java.lang.Object

org.opensaml.security.credential.impl.AbstractCredentialResolver

org.opensaml.security.credential.impl.AbstractCriteriaFilteringCredentialResolver

All Implemented Interfaces:

net.shibboleth.utilities.java.support.resolver.Resolver<Credential,net.shibboleth.utilities.java.support.resolver.CriteriaSet>, CredentialResolver

Direct Known Subclasses:

CollectionCredentialResolver, FilesystemCredentialResolver, KeyStoreCredentialResolver

public abstract class AbstractCriteriaFilteringCredentialResolver
extends AbstractCredentialResolver

An abstract implementation of CredentialResolver that filters the returned Credentials based on the instances of Predicate which are present in the set of criteria as instances of EvaluableCredentialCriterion, or which are obtained via lookup in the EvaluableCredentialCriteriaRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	satisfyAllPredicates Flag which determines whether predicates used in filtering are connected by a logical 'AND' or by logical 'OR'.

Constructor Summary

Constructors

Constructor and Description
AbstractCriteriaFilteringCredentialResolver() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private Set<com.google.common.base.Predicate<Credential>>	getPredicates(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet) Construct a set of credential predicates based on the criteria set.
boolean	isSatisfyAllPredicates() Get the flag indicating whether resolved credentials must satisfy all predicates (i.e.
Iterable<Credential>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
protected abstract Iterable<Credential>	resolveFromSource(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet) Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.
void	setSatisfyAllPredicates(boolean flag) Set the flag indicating whether resolved credentials must satisfy all predicates (i.e.

Methods inherited from class org.opensaml.security.credential.impl.AbstractCredentialResolver

resolveSingle

Methods inherited from class java.lang.Object

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

Field Detail

satisfyAllPredicates

private boolean satisfyAllPredicates

Flag which determines whether predicates used in filtering are connected by a logical 'AND' or by logical 'OR'.

Constructor Detail

AbstractCriteriaFilteringCredentialResolver

public AbstractCriteriaFilteringCredentialResolver()

Constructor.

Method Detail

resolve

@Nonnull
public Iterable<Credential> resolve(@Nullable
                                   net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
                             throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolve in interface net.shibboleth.utilities.java.support.resolver.Resolver<Credential,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Specified by:

resolve in class AbstractCredentialResolver

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

isSatisfyAllPredicates

public boolean isSatisfyAllPredicates()

Get the flag indicating whether resolved credentials must satisfy all predicates (i.e. connected by logical 'AND') or only one or more (connected by logical 'OR').

Returns:

true if must satisfy all, false otherwise

setSatisfyAllPredicates

public void setSatisfyAllPredicates(boolean flag)

Set the flag indicating whether resolved credentials must satisfy all predicates (i.e. connected by logical 'AND') or only one or more (connected by logical 'OR').

Parameters:

flag - true if must satisfy all, false otherwise

resolveFromSource

@Nonnull
protected abstract Iterable<Credential> resolveFromSource(@Nullable
                                             net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
                                                   throws net.shibboleth.utilities.java.support.resolver.ResolverException

Subclasses are required to implement this method to resolve credentials from the implementation-specific type of underlying credential source.

Parameters:

criteriaSet - the set of criteria used to resolve credentials from the credential source

Returns:

an Iterable for the resolved set of credentials

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is an error resolving credentials from the credential source

getPredicates

private Set<com.google.common.base.Predicate<Credential>> getPredicates(@Nullable
                                                              net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
                                                                 throws net.shibboleth.utilities.java.support.resolver.ResolverException

Construct a set of credential predicates based on the criteria set.

Parameters:

criteriaSet - the set of credential criteria to process.

Returns:

a set of Credential predicates

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is an error obtaining an instance of EvaluableCredentialCriterion from the EvaluableCredentialCriteriaRegistry