org.opensaml.saml.metadata.resolver.impl

Class MetadataQueryProtocolRequestURLBuilder

java.lang.Object

org.opensaml.saml.metadata.resolver.impl.MetadataQueryProtocolRequestURLBuilder

All Implemented Interfaces:

com.google.common.base.Function<net.shibboleth.utilities.java.support.resolver.CriteriaSet,String>

public class MetadataQueryProtocolRequestURLBuilder
extends Object
implements com.google.common.base.Function<net.shibboleth.utilities.java.support.resolver.CriteriaSet,String>

Function which produces a URL according to the Metadata Query Protocol (MDQ) specification.

Support for building request URLs per the MDQ SAML profile based on an EntityIdCriterion is built-in.

Support for building request URLs via other criteria may be specified via ordered instances of MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder. These are evaluated in the supplied order, and the first non-null result will be returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder Interface for a component which builds a Metadata Query Protocol request URL from a base URL and criteria.

Field Summary

Fields

Modifier and Type	Field and Description
private String	base The request base URL per the specification.
private Logger	log Logger.
private com.google.common.escape.Escaper	pathEscaper Path escaper for escaping the input value inserted into the URL path.
private com.google.common.base.Function<String,String>	transformer Function which transforms the entityID prior to substitution into the URL.
private List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder>	urlBuilders List of secondary URL builders.

Constructor Summary

Constructors

Constructor and Description
MetadataQueryProtocolRequestURLBuilder(String baseURL) Constructor.
MetadataQueryProtocolRequestURLBuilder(String baseURL, com.google.common.base.Function<String,String> transform) Constructor.
MetadataQueryProtocolRequestURLBuilder(String baseURL, com.google.common.base.Function<String,String> transform, List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder> secondaryURLBuilders) Constructor.
MetadataQueryProtocolRequestURLBuilder(String baseURL, List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder> secondaryURLBuilders) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	apply(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
private String	buildFromEntityID(String inputEntityID) Build request URL from entityID.
private String	buildFromSecondaryLookups(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Build request URL from secondary lookup criteria.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

log

private final Logger log

Logger.

base

private String base

The request base URL per the specification.

transformer

private com.google.common.base.Function<String,String> transformer

Function which transforms the entityID prior to substitution into the URL.

pathEscaper

private com.google.common.escape.Escaper pathEscaper

Path escaper for escaping the input value inserted into the URL path.

urlBuilders

private List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder> urlBuilders

List of secondary URL builders.

Constructor Detail

MetadataQueryProtocolRequestURLBuilder

public MetadataQueryProtocolRequestURLBuilder(@ParameterName(name="baseURL")@Nonnull@NotEmpty
                                      String baseURL)

Constructor.

Parameters:

baseURL - the base URL for the metadata responder

MetadataQueryProtocolRequestURLBuilder

public MetadataQueryProtocolRequestURLBuilder(@ParameterName(name="baseURL")@Nonnull@NotEmpty
                                      String baseURL,
                                      @ParameterName(name="transform")@Nullable
                                      com.google.common.base.Function<String,String> transform)

Constructor.

Parameters:

baseURL - the base URL for the metadata responder

transform - function which transforms the entityID prior to URL construction substitution, may be null

MetadataQueryProtocolRequestURLBuilder

public MetadataQueryProtocolRequestURLBuilder(@ParameterName(name="baseURL")@Nonnull@NotEmpty
                                      String baseURL,
                                      @ParameterName(name="secondaryURLBuilders")@Nullable
                                      List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder> secondaryURLBuilders)

Constructor.

Parameters:

baseURL - the base URL for the metadata responder

secondaryURLBuilders - the list of secondary URL builders, may be null

MetadataQueryProtocolRequestURLBuilder

public MetadataQueryProtocolRequestURLBuilder(@ParameterName(name="baseURL")@Nonnull@NotEmpty
                                      String baseURL,
                                      @ParameterName(name="transform")@Nullable
                                      com.google.common.base.Function<String,String> transform,
                                      @ParameterName(name="secondaryURLBuilders")@Nullable
                                      List<MetadataQueryProtocolRequestURLBuilder.MetadataQueryProtocolURLBuilder> secondaryURLBuilders)

Constructor.

Parameters:

baseURL - the base URL for the metadata responder

transform - function which transforms the entityID prior to URL construction substitution, may be null

secondaryURLBuilders - the list of secondary URL builders, may be null

Method Detail

apply

@Nullable
public String apply(@Nonnull
                    net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)

Specified by:

apply in interface com.google.common.base.Function<net.shibboleth.utilities.java.support.resolver.CriteriaSet,String>

buildFromEntityID

private String buildFromEntityID(@Nonnull
                       String inputEntityID)

Build request URL from entityID.

Parameters:

inputEntityID - the entityID

Returns:

the request URL, or null

buildFromSecondaryLookups

private String buildFromSecondaryLookups(@Nonnull
                               net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)

Build request URL from secondary lookup criteria.

Parameters:

criteria - the criteria

Returns:

the request URL, or null