Package net.shibboleth.oidc.metadata.policy.impl

Class MetadataPolicyViaLocationFetchingStrategy

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.metadata.impl.AbstractDynamicHTTPFetchingStrategy<Map<String,MetadataPolicy>>

net.shibboleth.oidc.metadata.policy.impl.MetadataPolicyViaLocationFetchingStrategy

All Implemented Interfaces:

Function<CriteriaSet,Map<String,MetadataPolicy>>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class MetadataPolicyViaLocationFetchingStrategy
extends AbstractDynamicHTTPFetchingStrategy<Map<String,MetadataPolicy>>
implements Function<CriteriaSet,Map<String,MetadataPolicy>>

A fetching strategy that exploits ResourceLocationCriterion from the given CriteriaSet to resolve a location for metadata policy. If the value starts with http:// or https://, the policy is fetched via HttpClient. In other cases the location is expected to be a file path. Possibly existing file: prefix is removed before loading the file.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<byte[],List<Map<String,MetadataPolicy>>>	parsingStrategy	The parsing strategy used for parsing metadata policies.

Fields inherited from class net.shibboleth.oidc.metadata.impl.AbstractDynamicHTTPFetchingStrategy

MDC_ATTRIB_CURRENT_REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
MetadataPolicyViaLocationFetchingStrategy(org.apache.hc.client5.http.classic.HttpClient client, org.apache.hc.core5.http.io.HttpClientResponseHandler<Map<String,MetadataPolicy>> handler)	Constructor.

Method Summary

Modifier and Type	Method	Description
Map<String,MetadataPolicy>	apply(CriteriaSet criteriaSet)
protected String	buildRequestURL(CriteriaSet criteria)	Build the request URL based on the input criteria set.
protected void	doInitialize()
void	setParsingStrategy(Function<byte[],List<Map<String,MetadataPolicy>>> strategy)	Set the parsing strategy used for parsing metadata policies.

Methods inherited from class net.shibboleth.oidc.metadata.impl.AbstractDynamicHTTPFetchingStrategy

getSupportedContentTypes, setHttpClientSecurityParameters, setSupportedContentTypes

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, 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 java.util.function.Function

andThen, compose

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

parsingStrategy

@NonnullAfterInit
private Function<byte[],List<Map<String,MetadataPolicy>>> parsingStrategy

The parsing strategy used for parsing metadata policies.

Constructor Details

MetadataPolicyViaLocationFetchingStrategy

public MetadataPolicyViaLocationFetchingStrategy(@Nonnull
 org.apache.hc.client5.http.classic.HttpClient client,
 @Nonnull
 org.apache.hc.core5.http.io.HttpClientResponseHandler<Map<String,MetadataPolicy>> handler)

Constructor.

Parameters:

client - the instance of HttpClient used to fetch remote metadata policy.

handler - the response handler used to convert the HTTP response to the metadata policy.

Method Details

setParsingStrategy

public void setParsingStrategy(@Nonnull
 Function<byte[],List<Map<String,MetadataPolicy>>> strategy)

Set the parsing strategy used for parsing metadata policies.

Parameters:

strategy - What to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractDynamicHTTPFetchingStrategy<Map<String,MetadataPolicy>>

Throws:

ComponentInitializationException

apply

@Nullable
public Map<String,MetadataPolicy> apply(@Nullable
 CriteriaSet criteriaSet)

Specified by:

apply in interface Function<CriteriaSet,Map<String,MetadataPolicy>>

Overrides:

apply in class AbstractDynamicHTTPFetchingStrategy<Map<String,MetadataPolicy>>

buildRequestURL

protected String buildRequestURL(@Nullable
 CriteriaSet criteria)

Build the request URL based on the input criteria set.

Specified by:

buildRequestURL in class AbstractDynamicHTTPFetchingStrategy<Map<String,MetadataPolicy>>

Parameters:

criteria - the input criteria set

Returns:

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