org.opensaml.saml.metadata.resolver.impl

Class TemplateRequestURLBuilder

java.lang.Object

org.opensaml.saml.metadata.resolver.impl.TemplateRequestURLBuilder

All Implemented Interfaces:

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

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

Function which produces a URL by substituting an entity ID value from criteria into a Velocity template string.

The entity ID will be replaced in the template string according to the template variable entityID, e.g. "https://metadataservice.com/entity/${entityID}".

The value of the encodingStyle parameter determines whether and how the entity ID will be encoded prior to substitution, and accepts an enum value from TemplateRequestURLBuilder.EncodingStyle. Legacy deprecated constructors accept an encoded parameter, where true means TemplateRequestURLBuilder.EncodingStyle.form and false means TemplateRequestURLBuilder.EncodingStyle.none.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateRequestURLBuilder.EncodingStyle EntityID Encoding style.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_KEY_ENTITY_ID The Velocity context variable name for the entity ID.
private TemplateRequestURLBuilder.EncodingStyle	entityIDEncodingStyle Enum value indicating whether and how to encode the entity ID value before substitution.
private Logger	log Logger.
private net.shibboleth.utilities.java.support.velocity.Template	template Velocity template instance used to render the request URL.
private String	templateText The template text, for logging purposes.
private com.google.common.base.Function<String,String>	transformer Function which transforms the entityID prior to substitution into the template.

Constructor Summary

Constructors

Constructor and Description
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, boolean encoded) Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, boolean encoded, com.google.common.base.Function<String,String> transform) Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, boolean encoded, com.google.common.base.Function<String,String> transform, Charset charSet) Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, TemplateRequestURLBuilder.EncodingStyle encodingStyle) Constructor.
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, TemplateRequestURLBuilder.EncodingStyle encodingStyle, com.google.common.base.Function<String,String> transform) Constructor.
TemplateRequestURLBuilder(VelocityEngine engine, String templateString, TemplateRequestURLBuilder.EncodingStyle encodingStyle, com.google.common.base.Function<String,String> transform, Charset charSet) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	apply(net.shibboleth.utilities.java.support.resolver.CriteriaSet 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

CONTEXT_KEY_ENTITY_ID

public static final String CONTEXT_KEY_ENTITY_ID

The Velocity context variable name for the entity ID.

See Also:

Constant Field Values

log

private final Logger log

Logger.

template

private net.shibboleth.utilities.java.support.velocity.Template template

Velocity template instance used to render the request URL.

templateText

private String templateText

The template text, for logging purposes.

transformer

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

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

entityIDEncodingStyle

private TemplateRequestURLBuilder.EncodingStyle entityIDEncodingStyle

Enum value indicating whether and how to encode the entity ID value before substitution.

Constructor Detail

TemplateRequestURLBuilder

@Deprecated
public TemplateRequestURLBuilder(@Nonnull
                                    VelocityEngine engine,
                                    @Nonnull@NotEmpty
                                    String templateString,
                                    boolean encoded)

Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle

Constructor.

The template character set will be US ASCII.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

encoded - true if entity ID should be URL form-encoded prior to substitution, false otherwise

TemplateRequestURLBuilder

@Deprecated
public TemplateRequestURLBuilder(@Nonnull
                                    VelocityEngine engine,
                                    @Nonnull@NotEmpty
                                    String templateString,
                                    boolean encoded,
                                    @Nullable
                                    com.google.common.base.Function<String,String> transform)

Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle

Constructor.

The template character set will be US ASCII.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

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

encoded - true if entity ID should be URL form-encoded prior to substitution, false otherwise

TemplateRequestURLBuilder

@Deprecated
public TemplateRequestURLBuilder(@Nonnull
                                    VelocityEngine engine,
                                    @Nonnull@NotEmpty
                                    String templateString,
                                    boolean encoded,
                                    @Nullable
                                    com.google.common.base.Function<String,String> transform,
                                    @Nullable
                                    Charset charSet)

Deprecated. Replacement is the variant which accepts an instance of TemplateRequestURLBuilder.EncodingStyle

Constructor.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

encoded - true if entity ID should be URL form-encoded prior to substitution, false otherwise

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

charSet - character set of the template, may be null

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                         VelocityEngine engine,
                         @Nonnull@NotEmpty
                         String templateString,
                         @Nullable
                         TemplateRequestURLBuilder.EncodingStyle encodingStyle)

Constructor.

The template character set will be US ASCII.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

encodingStyle - the style for encoding the entity ID prior to substitution, null means TemplateRequestURLBuilder.EncodingStyle.none

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                         VelocityEngine engine,
                         @Nonnull@NotEmpty
                         String templateString,
                         @Nullable
                         TemplateRequestURLBuilder.EncodingStyle encodingStyle,
                         @Nullable
                         com.google.common.base.Function<String,String> transform)

Constructor.

The template character set will be US ASCII.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

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

encodingStyle - the style for encoding the entity ID prior to substitution, null means TemplateRequestURLBuilder.EncodingStyle.none

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                         VelocityEngine engine,
                         @Nonnull@NotEmpty
                         String templateString,
                         TemplateRequestURLBuilder.EncodingStyle encodingStyle,
                         @Nullable
                         com.google.common.base.Function<String,String> transform,
                         @Nullable
                         Charset charSet)

Constructor.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

encodingStyle - the style for encoding the entity ID prior to substitution, null means TemplateRequestURLBuilder.EncodingStyle.none

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

charSet - character set of the template, 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>