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

Class FilesystemProviderMetadataResolver

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicFilesystemProviderMetadataResolver

public class FilesystemProviderMetadataResolver
extends AbstractFileOIDCEntityResolver<Issuer,OIDCProviderMetadata>
implements RefreshableProviderMetadataResolver

Based on FilesystemMetadataResolver.

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 final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Constructor Summary

Constructors

Constructor	Description
FilesystemProviderMetadataResolver(Timer backgroundTaskTimer, org.springframework.core.io.Resource metadata)	Constructor.
FilesystemProviderMetadataResolver(org.springframework.core.io.Resource metadata)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Issuer	getKey(OIDCProviderMetadata value)
protected List<OIDCProviderMetadata>	parse(byte[] bytes)
Iterable<OIDCProviderMetadata>	resolve(ProfileRequestContext profileRequestContext)
OIDCProviderMetadata	resolveSingle(ProfileRequestContext profileRequestContext)
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

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

fetchMetadata, getMetadataIdentifier, getMetadataUpdateTime, 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.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Constructor Details

FilesystemProviderMetadataResolver

public FilesystemProviderMetadataResolver(@Nonnull
 org.springframework.core.io.Resource metadata)
                                   throws IOException

Constructor.

Parameters:

metadata - the metadata file

Throws:

IOException - If the metedata cannot be loaded.

FilesystemProviderMetadataResolver

public FilesystemProviderMetadataResolver(@Nullable
 Timer backgroundTaskTimer,
 @Nonnull
 org.springframework.core.io.Resource metadata)
                                   throws IOException

Constructor.

Parameters:

metadata - the metadata file

backgroundTaskTimer - timer used to refresh metadata in the background

Throws:

IOException - If the metedata cannot be loaded.

Method Details

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext

resolve

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

Specified by:

resolve in interface Resolver<OIDCProviderMetadata,ProfileRequestContext>

Throws:

ResolverException

resolveSingle

@Nullable
public OIDCProviderMetadata resolveSingle(@Nullable
 ProfileRequestContext profileRequestContext)
                                   throws ResolverException

Specified by:

resolveSingle in interface Resolver<OIDCProviderMetadata,ProfileRequestContext>

Throws:

ResolverException

parse

@Nonnull
protected List<OIDCProviderMetadata> parse(byte[] bytes)
                                    throws ParseException

Specified by:

parse in class AbstractReloadingOIDCEntityResolver<Issuer,OIDCProviderMetadata>

Throws:

ParseException

getKey

@Nonnull
protected Issuer getKey(@Nonnull
 OIDCProviderMetadata value)

Specified by:

getKey in class AbstractReloadingOIDCEntityResolver<Issuer,OIDCProviderMetadata>