org.opensaml.saml.metadata.resolver.impl

Class AbstractDynamicHTTPMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.AbstractDynamicHTTPMetadataResolver

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>, DynamicMetadataResolver, MetadataResolver

Direct Known Subclasses:

SimpleDynamicHTTPMetadataResolver

public abstract class AbstractDynamicHTTPMetadataResolver
extends AbstractDynamicMetadataResolver

Abstract subclass for dynamic metadata resolvers that implement metadata resolution based on HTTP requests.

Nested Class Summary

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

AbstractDynamicMetadataResolver.BackingStoreCleanupSweeper, AbstractDynamicMetadataResolver.DynamicEntityBackingStore, 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
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 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.

Constructor Summary

Constructors

Constructor and Description
AbstractDynamicHTTPMetadataResolver(HttpClient client) Constructor.
AbstractDynamicHTTPMetadataResolver(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) Build an appropriate instance of HttpUriRequest based on the input criteria set.
protected abstract String	buildRequestURL(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Build the request URL based on the input criteria set.
protected void	closeResponse(org.apache.http.HttpResponse response, URI requestURI) Close the HTTP response instance.
protected void	doDestroy()
protected Iterable<EntityDescriptor>	fetchByCriteria(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Fetch metadata from an origin source based on the input criteria, store it in the backing store and then return it.
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 void	processResponse(org.apache.http.HttpResponse response, URI requestURI, String expectedEntityID) Process the received HTTP response, including validating the response, unmarshalling the received metadata, and storing the metadata in the backing store.
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	validateHttpResponse(org.apache.http.HttpResponse response, URI requestURI) Validate the received HTTP response instance, such as checking for supported content types.

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

createNewBackingStore, getBackingStore, getCleanupTaskInterval, getMaxIdleEntityData, lookupEntityID, processNewMetadata, resolve, setCleanupTaskInterval, setMaxIdleEntityData

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

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.

Constructor Detail

AbstractDynamicHTTPMetadataResolver

public AbstractDynamicHTTPMetadataResolver(@Nonnull
                                   HttpClient client)

Constructor.

Parameters:

client - the instance of HttpClient used to fetch remote metadata

AbstractDynamicHTTPMetadataResolver

public AbstractDynamicHTTPMetadataResolver(@Nullable
                                   Timer backgroundTaskTimer,
                                   @Nonnull
                                   HttpClient client)

Constructor.

Parameters:

backgroundTaskTimer - the Timer instance used to run resolver background managment tasks

client - the instance of HttpClient used to fetch remote metadata

Method Detail

getSupportedContentTypes

@NonnullAfterInit
@NotLive
@Unmodifiable
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(@Nullable
                            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

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 AbstractDynamicMetadataResolver

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 AbstractDynamicMetadataResolver

fetchByCriteria

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

Fetch metadata from an origin source based on the input criteria, store it in the backing store and then return it.

Specified by:

fetchByCriteria in class AbstractDynamicMetadataResolver

Parameters:

criteria - the input criteria set

Returns:

the resolved metadata

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if there is a fatal error attempting to resolve the metadata

buildHttpRequest

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

Build an appropriate instance of HttpUriRequest based on the input criteria set.

Parameters:

criteria - the input criteria set

Returns:

the newly constructed request, or null if it can not be built from the supplied criteria

buildRequestURL

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

Build the request URL based on the input criteria set.

Parameters:

criteria - the input criteria set

Returns:

the request URL, or null if it can not be built based on the supplied criteria

processResponse

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

Process the received HTTP response, including validating the response, unmarshalling the received metadata, and storing the metadata in the backing store.

Parameters:

response - the received response

requestURI - the original request URI

expectedEntityID - the expected entityID of the resolved metadata

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if there is a fatal error processing the response

closeResponse

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

Close the HTTP response instance.

Parameters:

response - the received response

requestURI - the original request URI

validateHttpResponse

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

Validate the received HTTP response instance, such as checking for supported content types.

Parameters:

response - the received response

requestURI - the original request URI

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if the response was not valid, or if there is a fatal error validating the response