AbstractChainingCredentialResolver (OpenSAML :: Security Implementation 4.0.0 API)

java.lang.Object
- org.opensaml.security.credential.impl.AbstractCredentialResolver
- - org.opensaml.security.credential.impl.AbstractChainingCredentialResolver<ResolverType>

Type Parameters:

ResolverType - the subtype of CredentialResolver to be chained

All Implemented Interfaces:

net.shibboleth.utilities.java.support.resolver.Resolver<org.opensaml.security.credential.Credential,net.shibboleth.utilities.java.support.resolver.CriteriaSet>, org.opensaml.security.credential.CredentialResolver

Direct Known Subclasses:

ChainingCredentialResolver
```
public abstract class AbstractChainingCredentialResolver<ResolverType extends org.opensaml.security.credential.CredentialResolver>
extends AbstractCredentialResolver
```
An abstract implementation of CredentialResolver which chains together one or more underlying credential resolver implementations. Resolved credentials are returned from all underlying resolvers in the chain, in the order implied by the order of the resolvers in the chain.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`AbstractChainingCredentialResolver.CredentialIterable`	Implementation of `Iterable` to be returned by `ChainingCredentialResolver`.
`class`	`AbstractChainingCredentialResolver.CredentialIterator`	Implementation of `Iterator` to be returned (indirectly) by `ChainingCredentialResolver`.

Field Summary

Fields
Modifier and Type Field Description

private org.slf4j.Logger log
Logger.

private List<ResolverType> resolvers
List of credential resolvers in the chain.

Constructor Summary

Constructors
Constructor Description

AbstractChainingCredentialResolver(List<ResolverType> credResolvers)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ResolverType>`	`getResolverChain()`	Get the unmodifiable list of credential resolvers which comprise the resolver chain.
`Iterable<org.opensaml.security.credential.Credential>`	`resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)`

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

log

@Nonnull
private final org.slf4j.Logger log

Logger.

resolvers

@Nonnull
@NonnullElements
private List<ResolverType extends org.opensaml.security.credential.CredentialResolver> resolvers

List of credential resolvers in the chain.

Constructor Detail

AbstractChainingCredentialResolver

public AbstractChainingCredentialResolver(@Nonnull @NonnullElements
                                          List<ResolverType> credResolvers)

Constructor.

Parameters:: credResolvers - the list of chained credential resolvers

Method Detail
- getResolverChain
```
@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<ResolverType> getResolverChain()
```
  Get the unmodifiable list of credential resolvers which comprise the resolver chain.
  
  Returns:
  
  the list of credential resolvers in the chain
- resolve
```
@Nonnull
public Iterable<org.opensaml.security.credential.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<org.opensaml.security.credential.Credential,net.shibboleth.utilities.java.support.resolver.CriteriaSet>
  
  Specified by:
  
  resolve in class AbstractCredentialResolver
  
  Throws:
  
  net.shibboleth.utilities.java.support.resolver.ResolverException