Package net.shibboleth.oidc.metadata.impl

Class FilesystemProviderMetadataResolver

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

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

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

net.shibboleth.oidc.metadata.impl.AbstractFileOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Issuer,com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata>

net.shibboleth.oidc.metadata.impl.FilesystemProviderMetadataResolver

All Implemented Interfaces:

ProviderMetadataResolver, RefreshableProviderMetadataResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata,CriteriaSet>

public class FilesystemProviderMetadataResolver
extends AbstractFileOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Issuer,com.nimbusds.openid.connect.sdk.op.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 org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,net.shibboleth.idp.profile.context.RelyingPartyContext>	relyingPartyContextLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected com.nimbusds.oauth2.sdk.id.Issuer	getKey(com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata value)	Gets the identifier for the given entity.
protected List<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata>	parse(byte[] bytes)	Parses an entity from the byte array.
Iterable<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata>	resolve(CriteriaSet criteria)
com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	resolveSingle(CriteriaSet criteria)
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,net.shibboleth.idp.profile.context.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

doDestroy, 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.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

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.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.oidc.metadata.RefreshableProviderMetadataResolver

getLastRefresh, getLastUpdate, refresh

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,net.shibboleth.idp.profile.context.RelyingPartyContext> relyingPartyContextLookupStrategy

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

Constructor Detail

FilesystemProviderMetadataResolver

public FilesystemProviderMetadataResolver(@Nonnull
                                          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
                                          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 Detail

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
                                                 Function<ProfileRequestContext,net.shibboleth.idp.profile.context.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

@Nullable
public Iterable<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata> resolve(@Nullable
                                                                                 CriteriaSet criteria)
                                                                          throws ResolverException

Specified by:

resolve in interface Resolver<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata,CriteriaSet>

Throws:

ResolverException

resolveSingle

@Nullable
public com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata resolveSingle(@Nullable
                                                                             CriteriaSet criteria)
                                                                      throws ResolverException

Specified by:

resolveSingle in interface Resolver<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata,CriteriaSet>

Throws:

ResolverException

parse

protected List<com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata> parse(byte[] bytes)
                                                                       throws com.nimbusds.oauth2.sdk.ParseException

Parses an entity from the byte array.

Specified by:

parse in class AbstractReloadingOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Issuer,com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata>

Parameters:

bytes - The encoded entity

Returns:

The parsed entity

Throws:

com.nimbusds.oauth2.sdk.ParseException - if parse fails

getKey

protected com.nimbusds.oauth2.sdk.id.Issuer getKey(@Nonnull
                                                   com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata value)

Gets the identifier for the given entity.

Specified by:

getKey in class AbstractReloadingOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Issuer,com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata>

Parameters:

value - The entity whose identifier will be returned.

Returns:

The identifier for the given entity.