Package net.shibboleth.idp.plugin.oidc.op.metadata.impl

Class DynamicFilesystemProviderMetadataResolver

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.metadata.impl.AbstractOIDCEntityResolver<Key,Value>

net.shibboleth.oidc.metadata.impl.AbstractReloadingOIDCEntityResolver<Key,Value>

net.shibboleth.oidc.metadata.impl.AbstractFileOIDCEntityResolver<Issuer,OIDCProviderMetadata>

net.shibboleth.idp.plugin.oidc.op.metadata.impl.FilesystemProviderMetadataResolver

net.shibboleth.idp.plugin.oidc.op.metadata.impl.DynamicFilesystemProviderMetadataResolver

All Implemented Interfaces:

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

public class DynamicFilesystemProviderMetadataResolver
extends FilesystemProviderMetadataResolver

An extension to FilesystemProviderMetadataResolver that enables some of the claims to be dynamically updated outside the file.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.oidc.metadata.impl.AbstractOIDCEntityResolver

AbstractOIDCEntityResolver.JsonBackingStore

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,? extends MetadataValueResolver>	dynamicResolvers	The map of dynamic metadata value resolvers, key corresponding to the name of the metadata field.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
DynamicFilesystemProviderMetadataResolver(Timer backgroundTaskTimer, Resource metadata)	Constructor.
DynamicFilesystemProviderMetadataResolver(Resource metadata)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Instant	getMetadataUpdateTime()
Iterable<OIDCProviderMetadata>	resolve(ProfileRequestContext profileRequestContext)
void	setDynamicValueResolvers(Map<String,? extends MetadataValueResolver> map)	Set dynamic metadata value resolvers.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.metadata.impl.FilesystemProviderMetadataResolver

getKey, parse, resolveSingle, setRelyingPartyContextLookupStrategy

Methods inherited from class net.shibboleth.oidc.metadata.impl.AbstractFileOIDCEntityResolver

fetchMetadata, getMetadataIdentifier, setMetadataFile

Methods inherited from class net.shibboleth.oidc.metadata.impl.AbstractReloadingOIDCEntityResolver

getLastRefresh, getLastUpdate, initOIDCResolver, refresh, scheduleNextRefresh, setMaxRefreshDelay, setMinRefreshDelay

Methods inherited from class net.shibboleth.oidc.metadata.impl.AbstractOIDCEntityResolver

createNewBackingStore, doInitialize, getBackingStore, getLogPrefix, indexEntityDescriptor, isFailFastInitialization, lookupIdentifier, lookupIndexedIdentifier, preProcessEntityDescriptor, removeByIdentifier, setBackingStore, setFailFastInitialization

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, 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

Methods inherited from interface net.shibboleth.idp.plugin.oidc.op.metadata.resolver.RefreshableProviderMetadataResolver

getLastRefresh, getLastUpdate, refresh

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

dynamicResolvers

private Map<String,? extends MetadataValueResolver> dynamicResolvers

The map of dynamic metadata value resolvers, key corresponding to the name of the metadata field.

Constructor Details

DynamicFilesystemProviderMetadataResolver

public DynamicFilesystemProviderMetadataResolver(@Nonnull
 Resource metadata)
                                          throws IOException

Constructor.

Parameters:

metadata - the metadata file

Throws:

IOException - If the metedata cannot be loaded.

DynamicFilesystemProviderMetadataResolver

public DynamicFilesystemProviderMetadataResolver(@Nullable
 Timer backgroundTaskTimer,
 @Nonnull
 Resource metadata)
                                          throws IOException

Constructor.

Parameters:

backgroundTaskTimer - timer used to refresh metadata in the background

metadata - the metadata file

Throws:

IOException - If the metedata cannot be loaded.

Method Details

setDynamicValueResolvers

public void setDynamicValueResolvers(Map<String,? extends MetadataValueResolver> map)

Set dynamic metadata value resolvers.

Parameters:

map - What to set.

resolve

public Iterable<OIDCProviderMetadata> resolve(@Nullable
 ProfileRequestContext profileRequestContext)
                                       throws ResolverException

Specified by:

resolve in interface Resolver<OIDCProviderMetadata,ProfileRequestContext>

Overrides:

resolve in class FilesystemProviderMetadataResolver

Throws:

ResolverException

getMetadataUpdateTime

protected Instant getMetadataUpdateTime()

Overrides:

getMetadataUpdateTime in class AbstractFileOIDCEntityResolver<Issuer,OIDCProviderMetadata>