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

Class FilesystemMetadataValueResolver

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.Identifier,Object>

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

All Implemented Interfaces:

MetadataValueResolver, RefreshableMetadataValueResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<Object,ProfileRequestContext>

public class FilesystemMetadataValueResolver
extends net.shibboleth.oidc.metadata.impl.AbstractFileOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Identifier,Object>
implements RefreshableMetadataValueResolver

An implementation to RefreshableMetadataValueResolver that fetches the information from a file.

Nested Class Summary

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

net.shibboleth.oidc.metadata.impl.AbstractOIDCEntityResolver.JsonBackingStore

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected com.nimbusds.oauth2.sdk.id.Identifier	getKey(Object value)
protected List<Object>	parse(byte[] bytes)
Iterable<Object>	resolve(ProfileRequestContext profileRequestContext)	Returns all the resolved objects.
Object	resolveSingle(ProfileRequestContext profileRequestContext)	Returns a single resolved object.

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.idp.plugin.oidc.op.metadata.resolver.RefreshableMetadataValueResolver

getLastRefresh, getLastUpdate, refresh

Constructor Detail

FilesystemMetadataValueResolver

public FilesystemMetadataValueResolver(@Nonnull
                                       Resource metadata)
                                throws IOException

Constructor.

Parameters:

metadata - the metadata file

Throws:

IOException - If the metedata cannot be loaded.

FilesystemMetadataValueResolver

public FilesystemMetadataValueResolver(@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

resolve

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

Returns all the resolved objects.

Specified by:

resolve in interface Resolver<Object,ProfileRequestContext>

Parameters:

profileRequestContext - the criteria to evaluate or process, currently ignored. May be null.

Returns:

all the resolved objects.

Throws:

ResolverException - thrown if there is an error during resolution.

resolveSingle

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

Returns a single resolved object. If many were resolved, a single one is selected randomly from the set.

Specified by:

resolveSingle in interface Resolver<Object,ProfileRequestContext>

Parameters:

profileRequestContext - the criteria to evaluate or process, currently ignored. May be null.

Returns:

a single resolved object.

Throws:

ResolverException - thrown if there is an error during resolution.

parse

protected List<Object> parse(byte[] bytes)
                      throws com.nimbusds.oauth2.sdk.ParseException

Specified by:

parse in class net.shibboleth.oidc.metadata.impl.AbstractReloadingOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Identifier,Object>

Throws:

com.nimbusds.oauth2.sdk.ParseException

getKey

protected com.nimbusds.oauth2.sdk.id.Identifier getKey(Object value)

Specified by:

getKey in class net.shibboleth.oidc.metadata.impl.AbstractReloadingOIDCEntityResolver<com.nimbusds.oauth2.sdk.id.Identifier,Object>