org.opensaml.saml.metadata.resolver.impl

Class AbstractDynamicMetadataResolver

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.AbstractDynamicMetadataResolver

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

public abstract class AbstractDynamicMetadataResolver
extends AbstractMetadataResolver

Abstract subclass for metadata resolvers that resolve metadata dynamically, as needed and on demand.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDynamicMetadataResolver.BackingStoreCleanupSweeper
protected class	AbstractDynamicMetadataResolver.DynamicEntityBackingStore Specialized entity backing store implementation for dynamic metadata resolvers.
protected class	AbstractDynamicMetadataResolver.EntityManagementData

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

AbstractMetadataResolver.EntityBackingStore

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	createdOwnTaskTimer Whether we created our own task timer during object construction.
static String[]	DEFAULT_CONTENT_TYPES Default list of supported content MIME types.
private HttpClient	httpClient HTTP Client used to pull the metadata.
private Logger	log Class logger.
private long	maxLastAccessedInterval
private List<String>	supportedContentTypes List of supported MIME types for use in Accept request header and validation of response Content-Type header.
private String	supportedContentTypesValue Generated Accept request header value.
private Timer	taskTimer Timer used to schedule background metadata update tasks.

Constructor Summary

Constructors

Constructor and Description
AbstractDynamicMetadataResolver(HttpClient client) Constructor.
AbstractDynamicMetadataResolver(Timer backgroundTaskTimer, HttpClient client) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected HttpUriRequest	buildHttpRequest(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
protected abstract String	buildRequestURL(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
protected void	closeResponse(org.apache.http.HttpResponse response, URI requestURI)
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	createNewBackingStore() Create a new backing store instance for EntityDescriptor data.
protected void	doDestroy()
protected Iterable<EntityDescriptor>	fetchByCriteria(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	getBackingStore() Get the EntityDescriptor backing store currently in use by the metadata resolver.
List<String>	getSupportedContentTypes() Get the list of supported MIME types for use in Accept request header and validation of response Content-Type header.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
protected List<EntityDescriptor>	lookupEntityID(String entityID)
protected void	processNewMetadata(org.opensaml.core.xml.XMLObject root) Process the specified new metadata document, including metadata filtering.
protected void	processResponse(org.apache.http.HttpResponse response, URI requestURI)
Iterable<EntityDescriptor>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
void	setSupportedContentTypes(List<String> types) Set the list of supported MIME types for use in Accept request header and validation of response Content-Type header.
void	validateResponse(org.apache.http.HttpResponse response, URI requestURI)

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

doInitialize, filterMetadata, getMetadataFilter, getParserPool, getUnmarshallerFactory, indexEntityDescriptor, isFailFastInitialization, isRequireValidMetadata, isValid, lookupIndexedEntityID, preProcessEntitiesDescriptor, preProcessEntityDescriptor, releaseMetadataDOM, 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 net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

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

initialize, isInitialized

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

destroy, isDestroyed

Field Detail

DEFAULT_CONTENT_TYPES

public static final String[] DEFAULT_CONTENT_TYPES

Default list of supported content MIME types.

log

private final Logger log

Class logger.

httpClient

private HttpClient httpClient

HTTP Client used to pull the metadata.

taskTimer

private Timer taskTimer

Timer used to schedule background metadata update tasks.

createdOwnTaskTimer

private boolean createdOwnTaskTimer

Whether we created our own task timer during object construction.

supportedContentTypes

private List<String> supportedContentTypes

List of supported MIME types for use in Accept request header and validation of response Content-Type header.

supportedContentTypesValue

private String supportedContentTypesValue

Generated Accept request header value.

maxLastAccessedInterval

private long maxLastAccessedInterval

Constructor Detail

AbstractDynamicMetadataResolver

public AbstractDynamicMetadataResolver(HttpClient client)

Constructor.

Parameters:

client -

AbstractDynamicMetadataResolver

public AbstractDynamicMetadataResolver(Timer backgroundTaskTimer,
                               HttpClient client)

Constructor.

Parameters:

backgroundTaskTimer -

client -

Method Detail

getSupportedContentTypes

public List<String> getSupportedContentTypes()

Get the list of supported MIME types for use in Accept request header and validation of response Content-Type header.

Returns:

the supported content types

setSupportedContentTypes

public void setSupportedContentTypes(List<String> types)

Set the list of supported MIME types for use in Accept request header and validation of response Content-Type header.

Parameters:

types - the new supported content types to set

resolve

@Nonnull
public Iterable<EntityDescriptor> resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                   throws net.shibboleth.utilities.java.support.resolver.ResolverException

Throws:

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

fetchByCriteria

protected Iterable<EntityDescriptor> fetchByCriteria(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                              throws net.shibboleth.utilities.java.support.resolver.ResolverException

Parameters:

criteria -

Returns:

Throws:

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

lookupEntityID

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

Overrides:

lookupEntityID in class AbstractMetadataResolver

Throws:

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

buildHttpRequest

protected HttpUriRequest buildHttpRequest(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)

Parameters:

url -

Returns:

buildRequestURL

protected abstract String buildRequestURL(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)

Parameters:

criteria -

Returns:

processResponse

protected void processResponse(org.apache.http.HttpResponse response,
                   URI requestURI)
                        throws net.shibboleth.utilities.java.support.resolver.ResolverException

Parameters:

response -

requestURI -

Throws:

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

closeResponse

protected void closeResponse(org.apache.http.HttpResponse response,
                 URI requestURI)

Parameters:

response -

requestURI -

validateResponse

public void validateResponse(org.apache.http.HttpResponse response,
                    URI requestURI)
                      throws net.shibboleth.utilities.java.support.resolver.ResolverException

Parameters:

response -

requestURI -

Throws:

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

processNewMetadata

@Nonnull
protected void processNewMetadata(@Nonnull
                              org.opensaml.core.xml.XMLObject root)
                           throws FilterException

Process the specified new metadata document, including metadata filtering.

Parameters:

root - the root of the new metadata document being processed

Throws:

FilterException - if there is a problem filtering the metadata

createNewBackingStore

@Nonnull
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore 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 AbstractDynamicMetadataResolver.DynamicEntityBackingStore 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 net.shibboleth.utilities.java.support.component.ComponentInitializationException

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

Overrides:

initMetadataResolver in class AbstractMetadataResolver

Throws:

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMetadataResolver