org.opensaml.saml.metadata.resolver.impl

Class FunctionDrivenDynamicHTTPMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.FunctionDrivenDynamicHTTPMetadataResolver

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

public class FunctionDrivenDynamicHTTPMetadataResolver
extends AbstractDynamicHTTPMetadataResolver

Simple implementation of an HTTP-based dynamic metadata resolver which builds the request URL to process based on a Function instance.

The function defaults to an instance of HTTPEntityIDRequestURLBuilder, thereby implementing the "well-known location" resolution mechanism defined in the SAML 2 metadata specification if the entity ID is an HTTP or HTTPS URL.

Nested Class Summary

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

AbstractDynamicHTTPMetadataResolver.BasicMetadataResponseHandler

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 inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractDynamicHTTPMetadataResolver

DEFAULT_CONTENT_TYPES

Constructor Summary

Constructors

Constructor and Description
FunctionDrivenDynamicHTTPMetadataResolver(org.apache.http.client.HttpClient client) Constructor.
FunctionDrivenDynamicHTTPMetadataResolver(Timer backgroundTaskTimer, org.apache.http.client.HttpClient client) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildRequestURL(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Build the request URL based on the input criteria set.
com.google.common.base.Function<String,String>	getRequestURLBuilder() Get the function which builds the request URL.
void	setRequestURLBuilder(com.google.common.base.Function<String,String> builder) Set the function which builds the request URL.

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

buildHttpClientContext, buildHttpRequest, checkTLSCredentialTrusted, doDestroy, fetchFromOriginSource, getSupportedContentTypes, initMetadataResolver, setBasicCredentials, setBasicCredentialsWithScope, setCredentialsProvider, setSupportedContentTypes, setTLSTrustEngine

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

computeExpirationTime, computeRefreshTriggerTime, createNewBackingStore, getBackingStore, getCleanupTaskInterval, getMaxCacheDuration, getMaxIdleEntityData, getMinCacheDuration, getRefreshDelayFactor, isRemoveIdleEntityData, lookupEntityID, preProcessEntityDescriptor, processNewMetadata, resolve, resolveFromOriginSource, setCleanupTaskInterval, setMaxCacheDuration, setMaxIdleEntityData, setMinCacheDuration, setRefreshDelayFactor, setRemoveIdleEntityData, shouldAttemptRefresh

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

doInitialize, filterMetadata, getMetadataFilter, getParserPool, getUnmarshallerFactory, indexEntityDescriptor, isFailFastInitialization, isRequireValidMetadata, isValid, lookupIndexedEntityID, preProcessEntitiesDescriptor, 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

Constructor Detail

FunctionDrivenDynamicHTTPMetadataResolver

public FunctionDrivenDynamicHTTPMetadataResolver(org.apache.http.client.HttpClient client)

Constructor.

Parameters:

client - the instance of HttpClient used to fetch remote metadata

FunctionDrivenDynamicHTTPMetadataResolver

public FunctionDrivenDynamicHTTPMetadataResolver(@Nullable
                                                 Timer backgroundTaskTimer,
                                                 @Nonnull
                                                 org.apache.http.client.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

getRequestURLBuilder

@Nonnull
public com.google.common.base.Function<String,String> getRequestURLBuilder()

Get the function which builds the request URL.

Defaults to an instance of HTTPEntityIDRequestURLBuilder.

Returns:

the request URL builder function instance

setRequestURLBuilder

public void setRequestURLBuilder(@Nonnull
                                 com.google.common.base.Function<String,String> builder)

Set the function which builds the request URL.

Defaults to an instance of HTTPEntityIDRequestURLBuilder.

Parameters:

builder - the reqeust URL builder function instance

buildRequestURL

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

Build the request URL based on the input criteria set.

Specified by:

buildRequestURL in class AbstractDynamicHTTPMetadataResolver

Parameters:

criteria - the input criteria set

Returns:

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