org.opensaml.saml.metadata.resolver.impl

Class AbstractMetadataResolver

java.lang.Object

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

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

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

org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>, MetadataResolver

Direct Known Subclasses:

AbstractBatchMetadataResolver, AbstractDynamicMetadataResolver

public abstract class AbstractMetadataResolver
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements MetadataResolver

An abstract, base, implementation of a metadata provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractMetadataResolver.EntityBackingStore The collection of data which provides the backing store for the processed metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractMetadataResolver.EntityBackingStore	entityBackingStore Backing store for runtime EntityDescriptor data.
private boolean	failFastInitialization Whether problems during initialization should cause the provider to fail or go on without metadata.
private org.slf4j.Logger	log Class logger.
private MetadataFilter	mdFilter Filter applied to all metadata.
private net.shibboleth.utilities.java.support.xml.ParserPool	parser Pool of parsers used to process XML.
private boolean	requireValidMetadata Whether metadata is required to be valid.
private UnmarshallerFactory	unmarshallerFactory Unmarshaller factory used to get an unmarshaller for the metadata DOM.

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataResolver() Constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractMetadataResolver.EntityBackingStore	createNewBackingStore() Create a new backing store instance for EntityDescriptor data.
protected void	doDestroy()
protected void	doInitialize()
protected XMLObject	filterMetadata(XMLObject metadata) Filters the given metadata.
protected AbstractMetadataResolver.EntityBackingStore	getBackingStore() Get the EntityDescriptor backing store currently in use by the metadata resolver.
MetadataFilter	getMetadataFilter() Gets the metadata filter applied to the metadata.
net.shibboleth.utilities.java.support.xml.ParserPool	getParserPool() Gets the pool of parsers to use to parse XML.
protected UnmarshallerFactory	getUnmarshallerFactory() Get the XMLObject unmarshaller factory to use.
protected void	indexEntityDescriptor(EntityDescriptor entityDescriptor, AbstractMetadataResolver.EntityBackingStore backingStore) Index the specified entity descriptor, updating the specified entity backing store instance as necessary.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
boolean	isFailFastInitialization() Gets whether problems during initialization should cause the provider to fail or go on without metadata.
boolean	isRequireValidMetadata() Gets whether the metadata returned by queries must be valid.
protected boolean	isValid(XMLObject descriptor) Returns whether the given descriptor is valid.
protected java.util.List<EntityDescriptor>	lookupEntityID(java.lang.String entityID) Get list of descriptors matching an entityID.
protected java.util.List<EntityDescriptor>	lookupIndexedEntityID(java.lang.String entityID) Lookup the specified entityID from the index.
protected void	preProcessEntitiesDescriptor(EntitiesDescriptor entitiesDescriptor, AbstractMetadataResolver.EntityBackingStore backingStore) Pre-process the specified entities descriptor, updating the specified entity backing store instance as necessary.
protected void	preProcessEntityDescriptor(EntityDescriptor entityDescriptor, AbstractMetadataResolver.EntityBackingStore backingStore) Pre-process the specified entity descriptor, updating the specified entity backing store instance as necessary.
protected void	releaseMetadataDOM(XMLObject metadata) Releases the DOM representation from the metadata object.
protected void	removeByEntityID(java.lang.String entityID, AbstractMetadataResolver.EntityBackingStore backingStore) Remove from the backing store all metadata for the entity with the given entity ID.
EntityDescriptor	resolveSingle(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
protected void	setBackingStore(AbstractMetadataResolver.EntityBackingStore newBackingStore) Set the EntityDescriptor backing store currently in use by the metadata resolver.
void	setFailFastInitialization(boolean failFast) Sets whether problems during initialization should cause the provider to fail or go on without metadata.
void	setMetadataFilter(MetadataFilter newFilter) Sets the metadata filter applied to the metadata.
void	setParserPool(net.shibboleth.utilities.java.support.xml.ParserPool pool) Sets the pool of parsers to use to parse XML.
void	setRequireValidMetadata(boolean require) Sets whether the metadata returned by queries must be valid.
protected XMLObject	unmarshallMetadata(java.io.InputStream metadataInput) Unmarshalls the metadata from the given stream.

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.resolver.Resolver

resolve

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

private final org.slf4j.Logger log

Class logger.

unmarshallerFactory

private UnmarshallerFactory unmarshallerFactory

Unmarshaller factory used to get an unmarshaller for the metadata DOM.

requireValidMetadata

private boolean requireValidMetadata

Whether metadata is required to be valid.

mdFilter

private MetadataFilter mdFilter

Filter applied to all metadata.

failFastInitialization

private boolean failFastInitialization

Whether problems during initialization should cause the provider to fail or go on without metadata. The assumption being that in most cases a provider will recover at some point in the future. Default: true.

entityBackingStore

private AbstractMetadataResolver.EntityBackingStore entityBackingStore

Backing store for runtime EntityDescriptor data.

parser

private net.shibboleth.utilities.java.support.xml.ParserPool parser

Pool of parsers used to process XML.

Constructor Detail

AbstractMetadataResolver

public AbstractMetadataResolver()

Constructor.

Method Detail

isRequireValidMetadata

public boolean isRequireValidMetadata()

Gets whether the metadata returned by queries must be valid.

At a minimum, metadata is valid only if the date expressed in the validUntil attribute of the element and all its ancestral elements has not passed. Specific implementations may add additional constraints.

Specified by:

isRequireValidMetadata in interface MetadataResolver

Returns:

whether the metadata returned by queries must be valid

setRequireValidMetadata

public void setRequireValidMetadata(boolean require)

Sets whether the metadata returned by queries must be valid.

Specified by:

setRequireValidMetadata in interface MetadataResolver

Parameters:

require - whether the metadata returned by queries must be valid

getMetadataFilter

@Nullable
public MetadataFilter getMetadataFilter()

Gets the metadata filter applied to the metadata.

Specified by:

getMetadataFilter in interface MetadataResolver

Returns:

the metadata filter applied to the metadata

setMetadataFilter

public void setMetadataFilter(@Nullable
                              MetadataFilter newFilter)

Sets the metadata filter applied to the metadata.

Specified by:

setMetadataFilter in interface MetadataResolver

Parameters:

newFilter - the metadata filter applied to the metadata

isFailFastInitialization

public boolean isFailFastInitialization()

Gets whether problems during initialization should cause the provider to fail or go on without metadata. The assumption being that in most cases a provider will recover at some point in the future.

Returns:

whether problems during initialization should cause the provider to fail

setFailFastInitialization

public void setFailFastInitialization(boolean failFast)

Sets whether problems during initialization should cause the provider to fail or go on without metadata. The assumption being that in most cases a provider will recover at some point in the future.

Parameters:

failFast - whether problems during initialization should cause the provider to fail

getParserPool

@Nonnull
public net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()

Gets the pool of parsers to use to parse XML.

Returns:

pool of parsers to use to parse XML

setParserPool

public void setParserPool(@Nonnull
                          net.shibboleth.utilities.java.support.xml.ParserPool pool)

Sets the pool of parsers to use to parse XML.

Parameters:

pool - pool of parsers to use to parse XML

resolveSingle

@Nullable
public EntityDescriptor resolveSingle(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                         throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolveSingle in interface net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

getUnmarshallerFactory

protected UnmarshallerFactory getUnmarshallerFactory()

Get the XMLObject unmarshaller factory to use.

Returns:

the unmarshaller factory instance to use

doInitialize

protected final void doInitialize()
                           throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

initMetadataResolver

protected void initMetadataResolver()
                             throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Subclasses should override this method to perform any initialization logic necessary. Default implementation is a no-op.

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException - thrown if there is a problem initializing the provider

unmarshallMetadata

@Nonnull
protected XMLObject unmarshallMetadata(@Nonnull
                                                java.io.InputStream metadataInput)
                                         throws UnmarshallingException

Unmarshalls the metadata from the given stream. The stream is closed by this method and the returned metadata released its DOM representation.

Parameters:

metadataInput - the input reader to the metadata.

Returns:

the unmarshalled metadata

Throws:

UnmarshallingException - thrown if the metadata can no be unmarshalled

filterMetadata

@Nullable
protected XMLObject filterMetadata(@Nullable
                                             XMLObject metadata)
                                      throws FilterException

Filters the given metadata.

Parameters:

metadata - the metadata to be filtered

Returns:

the filtered metadata

Throws:

FilterException - thrown if there is an error filtering the metadata

releaseMetadataDOM

protected void releaseMetadataDOM(@Nullable
                                  XMLObject metadata)

Releases the DOM representation from the metadata object.

Parameters:

metadata - the metadata object

isValid

protected boolean isValid(@Nullable
                          XMLObject descriptor)

Returns whether the given descriptor is valid. If valid metadata is not required this method always returns true.

Parameters:

descriptor - the descriptor to check

Returns:

true if valid metadata is not required or the given descriptor is valid, false otherwise

lookupEntityID

@Nonnull
 @NonnullElements
protected java.util.List<EntityDescriptor> lookupEntityID(@Nonnull @NotEmpty
                                                                                     java.lang.String entityID)
                                                                              throws net.shibboleth.utilities.java.support.resolver.ResolverException

Get list of descriptors matching an entityID.

Parameters:

entityID - entityID to lookup

Returns:

a list of descriptors

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if an error occurs

lookupIndexedEntityID

@Nonnull
 @NonnullElements
protected java.util.List<EntityDescriptor> lookupIndexedEntityID(@Nonnull @NotEmpty
                                                                                            java.lang.String entityID)

Lookup the specified entityID from the index. The returned list will be a copy of what is stored in the backing index, and is safe to be manipulated by callers.

Parameters:

entityID - the entityID to lookup

Returns:

list copy of indexed entityID's, may be empty, will never be null

createNewBackingStore

@Nonnull
protected AbstractMetadataResolver.EntityBackingStore createNewBackingStore()

Create a new backing store instance for EntityDescriptor data. Subclasses may override to return a more specialized subclass type. Note this method does not make the returned backing store the effective one in use. The caller is responsible for calling setBackingStore(EntityBackingStore) to make it the effective instance in use.

Returns:

the new backing store instance

getBackingStore

@Nonnull
protected AbstractMetadataResolver.EntityBackingStore getBackingStore()

Get the EntityDescriptor backing store currently in use by the metadata resolver.

Returns:

the current effective entity backing store

setBackingStore

protected void setBackingStore(@Nonnull
                               AbstractMetadataResolver.EntityBackingStore newBackingStore)

Set the EntityDescriptor backing store currently in use by the metadata resolver.

Parameters:

newBackingStore - the new entity backing store

preProcessEntityDescriptor

protected void preProcessEntityDescriptor(@Nonnull
                                          EntityDescriptor entityDescriptor,
                                          @Nonnull
                                          AbstractMetadataResolver.EntityBackingStore backingStore)

Pre-process the specified entity descriptor, updating the specified entity backing store instance as necessary.

Parameters:

entityDescriptor - the target entity descriptor to process

backingStore - the backing store instance to update

removeByEntityID

protected void removeByEntityID(@Nonnull
                                java.lang.String entityID,
                                @Nonnull
                                AbstractMetadataResolver.EntityBackingStore backingStore)

Remove from the backing store all metadata for the entity with the given entity ID.

Parameters:

entityID - the entity ID of the metadata to remove

backingStore - the backing store instance to update

indexEntityDescriptor

protected void indexEntityDescriptor(@Nonnull
                                     EntityDescriptor entityDescriptor,
                                     @Nonnull
                                     AbstractMetadataResolver.EntityBackingStore backingStore)

Index the specified entity descriptor, updating the specified entity backing store instance as necessary.

Parameters:

entityDescriptor - the target entity descriptor to process

backingStore - the backing store instance to update

preProcessEntitiesDescriptor

protected void preProcessEntitiesDescriptor(@Nonnull
                                            EntitiesDescriptor entitiesDescriptor,
                                            AbstractMetadataResolver.EntityBackingStore backingStore)

Pre-process the specified entities descriptor, updating the specified entity backing store instance as necessary.

Parameters:

entitiesDescriptor - the target entities descriptor to process

backingStore - the backing store instance to update