Package net.shibboleth.oidc.metadata.impl

Class ChainingProviderMetadataResolver

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.metadata.impl.ChainingProviderMetadataResolver

All Implemented Interfaces:

ProviderMetadataResolver, RefreshableProviderMetadataResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<OIDCProviderMetadata,CriteriaSet>

public class ChainingProviderMetadataResolver
extends AbstractIdentifiableInitializableComponent
implements RefreshableProviderMetadataResolver

A provider metadata provider that uses registered resolvers, in turn, to answer queries. The Iterable of provider metadata returned is the first non-null and non-empty Iterable found while iterating over the registered resolvers in resolver list order.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private List<ProviderMetadataResolver>	resolvers	Registered resolvers.

Constructor Summary

Constructors

Constructor	Description
ChainingProviderMetadataResolver()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected int	countClients(ProviderMetadataResolver resolver)	Counts the clients found from the given resolver.
protected void	doDestroy()
protected void	doInitialize()
Instant	getLastRefresh()	Gets the time the last refresh cycle occurred.
Instant	getLastUpdate()	Get the time that the currently available metadata was last updated.
List<ProviderMetadataResolver>	getResolvers()	Get an immutable the list of currently registered resolvers.
void	refresh()	Refresh the data exposed by the resolver.
Iterable<OIDCProviderMetadata>	resolve(CriteriaSet criteria)
OIDCProviderMetadata	resolveSingle(CriteriaSet criteria)
void	setResolvers(List<? extends ProviderMetadataResolver> newResolvers)	Set the registered provider metadata resolvers.

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

setId

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

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

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

checkComponentActive, checkSetterPreconditions, destroy, 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.

resolvers

@Nonnull
@NonnullElements
private List<ProviderMetadataResolver> resolvers

Registered resolvers.

Constructor Details

ChainingProviderMetadataResolver

public ChainingProviderMetadataResolver()

Constructor.

Method Details

getResolvers

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<ProviderMetadataResolver> getResolvers()

Get an immutable the list of currently registered resolvers.

Returns:

list of currently registered resolvers

setResolvers

public void setResolvers(@Nullable @NonnullElements
 List<? extends ProviderMetadataResolver> newResolvers)
                  throws ResolverException

Set the registered provider metadata resolvers.

Parameters:

newResolvers - the provider metadata resolvers to use

Throws:

ResolverException - thrown if there is a problem adding the provider metadata resolvers

resolveSingle

@Nullable
public OIDCProviderMetadata resolveSingle(@Nullable
 CriteriaSet criteria)
                                   throws ResolverException

Specified by:

resolveSingle in interface Resolver<OIDCProviderMetadata,CriteriaSet>

Throws:

ResolverException

resolve

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

Specified by:

resolve in interface Resolver<OIDCProviderMetadata,CriteriaSet>

Throws:

ResolverException

refresh

public void refresh()
             throws ResolverException

Refresh the data exposed by the resolver.

An implementation of this method should typically be either synchronized or make use other locking mechanisms to protect against concurrent access.

Specified by:

refresh in interface RefreshableProviderMetadataResolver

Throws:

ResolverException - if the refresh operation was unsuccessful

getLastUpdate

@Nullable
public Instant getLastUpdate()

Get the time that the currently available metadata was last updated. Note, this may be different than the time retrieved by RefreshableProviderMetadataResolver.getLastRefresh() if the metadata was known not to have changed during the last refresh cycle.

Specified by:

getLastUpdate in interface RefreshableProviderMetadataResolver

Returns:

time when the currently metadata was last updated, null if it has never successfully been read

getLastRefresh

@Nullable
public Instant getLastRefresh()

Gets the time the last refresh cycle occurred.

Specified by:

getLastRefresh in interface RefreshableProviderMetadataResolver

Returns:

time the last refresh cycle occurred

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractInitializableComponent

countClients

protected int countClients(ProviderMetadataResolver resolver)

Counts the clients found from the given resolver.

Parameters:

resolver - The resolver whose clients are counted.

Returns:

The amount of resolvable clients.