Package org.opensaml.saml.metadata.resolver.impl

Class AbstractDynamicHTTPMetadataResolver

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.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:
Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<EntityDescriptor,CriteriaSet>, ClearableMetadataResolver, DynamicMetadataResolver, MetadataResolver
Direct Known Subclasses:
FunctionDrivenDynamicHTTPMetadataResolver
public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynamicMetadataResolver
Abstract subclass for dynamic metadata resolvers that implement metadata resolution based on HTTP requests.

  • Field Details

    • DEFAULT_CONTENT_TYPES

      @Nonnull @NotEmpty public static final String[] DEFAULT_CONTENT_TYPES
      Default list of supported content MIME types.

    • MDC_ATTRIB_CURRENT_REQUEST_URI

      @Nonnull @NotEmpty public static final String MDC_ATTRIB_CURRENT_REQUEST_URI
      MDC attribute representing the current request URI. Will be available during the execution of the configured HttpClientResponseHandler.

    • log

      @Nonnull private final org.slf4j.Logger log
      Class logger.

    • httpClient

      @NonnullAfterInit private org.apache.hc.client5.http.classic.HttpClient httpClient
      HTTP Client used to pull the metadata.

    • supportedContentTypes

      @NonnullAfterInit private List<String> supportedContentTypes
      List of supported MIME types for use in Accept request header and validation of response Content-Type header.

    • supportedContentTypesValue

      @NonnullAfterInit private String supportedContentTypesValue
      Generated Accept request header value.

    • supportedMediaTypes

      @NonnullAfterInit private Set<MediaType> supportedMediaTypes
      Supported MediaType instances, constructed from the supportedContentTypes list.

    • responseHandler

      @Nonnull private org.apache.hc.core5.http.io.HttpClientResponseHandler<XMLObject> responseHandler
      HttpClient ResponseHandler instance to use.

    • httpClientSecurityParameters

      @Nullable private HttpClientSecurityParameters httpClientSecurityParameters
      Optional HttpClient security parameters.

  • Constructor Details

    • AbstractDynamicHTTPMetadataResolver

      public AbstractDynamicHTTPMetadataResolver(@Nonnull org.apache.hc.client5.http.classic.HttpClient client)
      Constructor.
      Parameters:
      client - the instance of HttpClient used to fetch remote metadata

    • AbstractDynamicHTTPMetadataResolver

      public AbstractDynamicHTTPMetadataResolver(@Nullable Timer backgroundTaskTimer, @Nonnull org.apache.hc.client5.http.classic.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 Details

    • getHttpClientSecurityParameters

      @Nullable protected HttpClientSecurityParameters getHttpClientSecurityParameters()
      Get the instance of HttpClientSecurityParameters which provides various parameters to influence the security behavior of the HttpClient instance.
      Returns:
      the parameters instance, or null

    • setHttpClientSecurityParameters

      public void setHttpClientSecurityParameters(@Nullable HttpClientSecurityParameters params)
      Set an instance of HttpClientSecurityParameters which provides various parameters to influence the security behavior of the HttpClient instance.

      For all TLS-related parameters, must be used in conjunction with an HttpClient instance which is configured with either:

      For convenience methods for building a TLSSocketFactory, see HttpClientSupport.

      If the appropriate TLS socket factory is not configured and a trust engine is specified, then this will result in no TLS trust evaluation being performed and a ResolverException will ultimately be thrown.

      Parameters:
      params - the security parameters

    • getSupportedMediaTypes

      @NonnullAfterInit @NotLive @Unmodifiable protected Set<MediaType> getSupportedMediaTypes()
      Get the list of supported MIME MediaType instances used in validation of the response Content-Type header.

      Is generated at init time from getSupportedContentTypes().

      Returns:
      the supported content types

    • 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. Values will be effectively lower-cased at runtime.
      Parameters:
      types - the new supported content types to set

    • 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 AbstractDynamicMetadataResolver
      Throws:
      ComponentInitializationException - thrown if there is a problem initializing the provider

    • doDestroy

      protected void doDestroy()
      Overrides:
      doDestroy in class AbstractDynamicMetadataResolver

    • fetchFromOriginSource

      @Nullable protected XMLObject fetchFromOriginSource(@Nullable CriteriaSet criteria) throws IOException
      Fetch the metadata from the origin source.
      Specified by:
      fetchFromOriginSource in class AbstractDynamicMetadataResolver
      Parameters:
      criteria - the input criteria set
      Returns:
      the resolved metadata root XMLObject, or null if metadata could not be fetched
      Throws:
      IOException - if there is a fatal error fetching metadata from the origin source

    • buildHttpRequest

      @Nullable protected org.apache.hc.core5.http.ClassicHttpRequest buildHttpRequest(@Nullable CriteriaSet criteria)
      Build an appropriate instance of ClassicHttpRequest 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(@Nullable 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

    • buildHttpClientContext

      @Nonnull protected org.apache.hc.client5.http.protocol.HttpClientContext buildHttpClientContext(@Nonnull org.apache.hc.core5.http.ClassicHttpRequest request)
      Build the HttpClientContext instance which will be used to invoke the HttpClient request.
      Parameters:
      request - the current HTTP request
      Returns:
      a new instance of HttpClientContext