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<java.lang.String,java.lang.String>

public class TemplateRequestURLBuilder
extends java.lang.Object
implements com.google.common.base.Function<java.lang.String,java.lang.String>

Function which produces a URL by substituting a an entity ID value 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}".

If the value of the encoded parameter is true then the entity ID will be URL encoded prior to substitution. Otherwise, the literal value of the entity ID will be substituted.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
TemplateRequestURLBuilder(org.apache.velocity.app.VelocityEngine engine, java.lang.String templateString, boolean encoded) Constructor.
TemplateRequestURLBuilder(org.apache.velocity.app.VelocityEngine engine, java.lang.String templateString, boolean encoded, com.google.common.base.Function<java.lang.String,java.lang.String> transform) Constructor.
TemplateRequestURLBuilder(org.apache.velocity.app.VelocityEngine engine, java.lang.String templateString, boolean encoded, com.google.common.base.Function<java.lang.String,java.lang.String> transform, java.nio.charset.Charset charSet) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.lang.String input)

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 java.lang.String CONTEXT_KEY_ENTITY_ID

The Velocity context variable name for the entity ID.

See Also:

Constant Field Values

log

private final org.slf4j.Logger log

Logger.

template

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

Velocity template instance used to render the request URL.

templateText

private java.lang.String templateText

The template text, for logging purposes.

transformer

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

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

encodeEntityID

private boolean encodeEntityID

Flag indicating whether to URL-encode the entity ID value before substitution.

Constructor Detail

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                                 org.apache.velocity.app.VelocityEngine engine,
                                 @Nonnull @NotEmpty
                                 java.lang.String templateString,
                                 boolean encoded)

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-encoded prior to substitution, false otherwise

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                                 org.apache.velocity.app.VelocityEngine engine,
                                 @Nonnull @NotEmpty
                                 java.lang.String templateString,
                                 boolean encoded,
                                 @Nullable
                                 com.google.common.base.Function<java.lang.String,java.lang.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

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

TemplateRequestURLBuilder

public TemplateRequestURLBuilder(@Nonnull
                                 org.apache.velocity.app.VelocityEngine engine,
                                 @Nonnull @NotEmpty
                                 java.lang.String templateString,
                                 boolean encoded,
                                 @Nullable
                                 com.google.common.base.Function<java.lang.String,java.lang.String> transform,
                                 @Nullable
                                 java.nio.charset.Charset charSet)

Constructor.

Parameters:

engine - the VelocityEngine instance to use

templateString - the Velocity template string

encoded - true if entity ID should be URL-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

Method Detail

apply

@Nullable
public java.lang.String apply(@Nonnull
                                        java.lang.String input)

Specified by:

apply in interface com.google.common.base.Function<java.lang.String,java.lang.String>