org.opensaml.saml.metadata.resolver.impl

Class AbstractBatchMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.AbstractBatchMetadataResolver

All Implemented Interfaces:

Iterable<EntityDescriptor>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<EntityDescriptor,CriteriaSet>, IterableMetadataSource, BatchMetadataResolver, MetadataResolver

Direct Known Subclasses:

AbstractReloadingMetadataResolver, DOMMetadataResolver

public abstract class AbstractBatchMetadataResolver
extends AbstractMetadataResolver
implements BatchMetadataResolver, IterableMetadataSource

Abstract subclass for metadata resolvers that process and resolve metadata at a given point in time from a single metadata source document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractBatchMetadataResolver.BatchEntityBackingStore Specialized entity backing store implementation which is capable of storing the original metadata document on which the backing store is based.

Nested classes/interfaces inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver

AbstractMetadataResolver.EntityBackingStore

Constructor Summary

Constructors

Constructor and Description
AbstractBatchMetadataResolver() Constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractBatchMetadataResolver.BatchEntityBackingStore	createNewBackingStore() Create a new backing store instance for EntityDescriptor data.
protected AbstractBatchMetadataResolver.BatchEntityBackingStore	getBackingStore() Get the EntityDescriptor backing store currently in use by the metadata resolver.
protected XMLObject	getCachedFilteredMetadata() Convenience method for getting the current effective cached filtered metadata.
protected XMLObject	getCachedOriginalMetadata() Convenience method for getting the current effective cached original metadata.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
protected boolean	isCacheSourceMetadata() Get whether to cache the original source metadata document.
Iterator<EntityDescriptor>	iterator()
protected AbstractBatchMetadataResolver.BatchEntityBackingStore	preProcessNewMetadata(XMLObject root) Process the specified new metadata document, including metadata filtering and return its data in a new entity backing store instance.
Iterable<EntityDescriptor>	resolve(CriteriaSet criteria) Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.
protected void	setCacheSourceMetadata(boolean flag) Set whether to cache the original source metadata document.

Methods inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver

doDestroy, doInitialize, filterMetadata, getMetadataFilter, getParserPool, getUnmarshallerFactory, indexEntityDescriptor, isFailFastInitialization, isRequireValidMetadata, isValid, lookupEntityID, lookupIndexedEntityID, preProcessEntitiesDescriptor, preProcessEntityDescriptor, releaseMetadataDOM, removeByEntityID, resolveSingle, setBackingStore, setFailFastInitialization, setMetadataFilter, setParserPool, setRequireValidMetadata, unmarshallMetadata

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 org.opensaml.saml.metadata.resolver.MetadataResolver

getMetadataFilter, isRequireValidMetadata, setMetadataFilter, setRequireValidMetadata

Methods inherited from interface net.shibboleth.utilities.java.support.resolver.Resolver

resolveSingle

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

getId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractBatchMetadataResolver

public AbstractBatchMetadataResolver()

Constructor.

Method Detail

iterator

public Iterator<EntityDescriptor> iterator()

Specified by:

iterator in interface Iterable<EntityDescriptor>

isCacheSourceMetadata

protected boolean isCacheSourceMetadata()

Get whether to cache the original source metadata document.

Returns:

true if source should be cached, false otherwise

setCacheSourceMetadata

protected void setCacheSourceMetadata(boolean flag)

Set whether to cache the original source metadata document.

Parameters:

flag - true if source should be cached, false otherwise

resolve

@Nonnull
public Iterable<EntityDescriptor> resolve(CriteriaSet criteria)
                                            throws ResolverException

Process the specified criteria and return the resulting instances of the product type which satisfy the criteria.

Specified by:

resolve in interface Resolver<EntityDescriptor,CriteriaSet>

Parameters:

criteria - the criteria to evaluate or process

Returns:

instances which satisfy the criteria

Throws:

ResolverException - thrown if there is an error processing the specified criteria

createNewBackingStore

@Nonnull
protected AbstractBatchMetadataResolver.BatchEntityBackingStore 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 AbstractMetadataResolver.setBackingStore(EntityBackingStore) to make it the effective instance in use.

Overrides:

createNewBackingStore in class AbstractMetadataResolver

Returns:

the new backing store instance

getBackingStore

@Nonnull
protected AbstractBatchMetadataResolver.BatchEntityBackingStore getBackingStore()

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

Overrides:

getBackingStore in class AbstractMetadataResolver

Returns:

the current effective entity backing store

initMetadataResolver

protected void initMetadataResolver()
                             throws ComponentInitializationException

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

Overrides:

initMetadataResolver in class AbstractMetadataResolver

Throws:

ComponentInitializationException - thrown if there is a problem initializing the provider

getCachedOriginalMetadata

@Nullable
protected XMLObject getCachedOriginalMetadata()

Convenience method for getting the current effective cached original metadata.

Note: may or may not be the same as that obtained from getCachedFilteredMetadata(), depending on what metadata filtering produced from the original metadata document.

Returns:

the current effective cached metadata document

getCachedFilteredMetadata

@Nullable
protected XMLObject getCachedFilteredMetadata()

Convenience method for getting the current effective cached filtered metadata.

Note: may or may not be the same as that obtained from getCachedOriginalMetadata(), depending on what metadata filtering produced from the original metadata document.

Returns:

the current effective cached metadata document

preProcessNewMetadata

@Nonnull
protected AbstractBatchMetadataResolver.BatchEntityBackingStore preProcessNewMetadata(@Nonnull
                                                                                               XMLObject root)
                                                                                        throws FilterException

Process the specified new metadata document, including metadata filtering and return its data in a new entity backing store instance.

Parameters:

root - the root of the new metadata document being processed

Returns:

the new backing store instance

Throws:

FilterException - if there is a problem filtering the metadata