Package net.shibboleth.oidc.metadata.impl

Class AbstractFileOIDCEntityResolver<Key extends Identifier,Value>

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

Type Parameters:

Key - The identifier type in the backing store

Value - The entity type in the backing store

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

FilesystemClientInformationResolver, FilesystemProviderMetadataResolver

public abstract class AbstractFileOIDCEntityResolver<Key extends Identifier,Value>
extends AbstractReloadingOIDCEntityResolver<Key,Value>

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 File	metadataFile	The metadata file.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileOIDCEntityResolver(Timer backgroundTaskTimer, Resource metadata)	Constructor.
protected	AbstractFileOIDCEntityResolver(Resource metadata)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected byte[]	fetchMetadata()	Fetches metadata from a source.
protected String	getMetadataIdentifier()	Gets an identifier which may be used to distinguish this metadata in logging statements.
protected Instant	getMetadataUpdateTime()	Get the time for the last update/modification of the metadata file.
protected void	setMetadataFile(File file)	Sets the file from which metadata is read.

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

getKey, getLastRefresh, getLastUpdate, initOIDCResolver, parse, 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

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

metadataFile

@Nonnull
private File metadataFile

The metadata file.

Constructor Details

AbstractFileOIDCEntityResolver

protected AbstractFileOIDCEntityResolver(@Nonnull
 Resource metadata)
                                  throws IOException

Constructor.

Parameters:

metadata - the metadata file

Throws:

IOException - If the metedata cannot be loaded.

AbstractFileOIDCEntityResolver

protected AbstractFileOIDCEntityResolver(@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 Details

setMetadataFile

protected void setMetadataFile(@Nonnull
 File file)

Sets the file from which metadata is read.

Parameters:

file - path to the metadata file

getMetadataIdentifier

@Nonnull
protected String getMetadataIdentifier()

Gets an identifier which may be used to distinguish this metadata in logging statements.

Specified by:

getMetadataIdentifier in class AbstractReloadingOIDCEntityResolver<Key extends Identifier,Value>

Returns:

identifier which may be used to distinguish this metadata in logging statements

getMetadataUpdateTime

protected Instant getMetadataUpdateTime()

Get the time for the last update/modification of the metadata file.

Returns:

The last update time.

fetchMetadata

protected byte[] fetchMetadata()
                        throws ResolverException

Fetches metadata from a source.

Specified by:

fetchMetadata in class AbstractReloadingOIDCEntityResolver<Key extends Identifier,Value>

Returns:

the fetched metadata, or null if the metadata is known not to have changed since the last retrieval

Throws:

ResolverException - thrown if there is a problem fetching the metadata