org.opensaml.security.credential.impl

Class AbstractCredentialResolver

java.lang.Object

org.opensaml.security.credential.impl.AbstractCredentialResolver

All Implemented Interfaces:

Resolver<Credential,CriteriaSet>, CredentialResolver

Direct Known Subclasses:

AbstractChainingCredentialResolver, AbstractCriteriaFilteringCredentialResolver, StaticCredentialResolver

public abstract class AbstractCredentialResolver
extends Object
implements CredentialResolver

Abstract base class for CredentialResolver implementations.

Constructor Summary

Constructors

Constructor and Description
AbstractCredentialResolver()

Method Summary

Modifier and Type	Method and Description
abstract Iterable<Credential>	resolve(CriteriaSet criteriaSet) Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.
Credential	resolveSingle(CriteriaSet criteriaSet) Process the specified criteria and return a single instance of the product type which satisfies the criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCredentialResolver

public AbstractCredentialResolver()

Method Detail

resolveSingle

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

Process the specified criteria and return a single instance of the product type which satisfies the criteria. If multiple items satisfy the criteria, the choice of which single item to return is implementation-dependent.

Specified by:

resolveSingle in interface Resolver<Credential,CriteriaSet>

Parameters:

criteriaSet - the criteria to evaluate or process

Returns:

a single instance satisfying the criteria, or null

Throws:

ResolverException - thrown if there is an error processing the specified criteria

resolve

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

Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.

Specified by:

resolve in interface Resolver<Credential,CriteriaSet>

Parameters:

criteriaSet - the criteria to evaluate or process

Returns:

instances which satisfy the criteria

Throws:

ResolverException - thrown if there is an error processing the specified criteria