Package net.shibboleth.sp.util

Class TemplatedStringLookupStrategy

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.sp.util.TemplatedStringLookupStrategy

All Implemented Interfaces:

Function<ProfileRequestContext,String>, Component, DestructableComponent, InitializableComponent

public class TemplatedStringLookupStrategy
extends AbstractInitializableComponent
implements Function<ProfileRequestContext,String>

General strategy function for producing a String value from a String-based Velocity template.

Specialized inputs to the Velocity context are provided based on relevant inputs to operations by Agents.

Field Summary

Fields

Modifier and Type	Field	Description
private Object	customObject	A custom object to inject into the template.
private org.apache.velocity.app.VelocityEngine	engine	VelocityEngine.
private final Escaper	fragmentEscaper	Escaper for fragments.
private final org.slf4j.Logger	log	Class logger.
private final Escaper	paramEscaper	Escaper for form parameters.
private final Escaper	pathEscaper	Escaper for path segments.
private Template	template	Template to be evaluated.
private String	templateText	Text of template to be evaluated.

Constructor Summary

Constructors

Constructor	Description
TemplatedStringLookupStrategy()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	apply(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected String	merge(org.apache.velocity.VelocityContext context)	Invokes Template.merge(org.apache.velocity.context.Context) on the supplied context.
void	setCustomObject(Object object)	Set the custom (externally provided) object.
void	setTemplateText(String text)	Set the template to be evaluated.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)	Set the VelocityEngine to be used.

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

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

template

@NonnullAfterInit
private Template template

Template to be evaluated.

templateText

@NonnullAfterInit
private String templateText

Text of template to be evaluated.

engine

@NonnullAfterInit
private org.apache.velocity.app.VelocityEngine engine

VelocityEngine.

paramEscaper

@Nonnull
private final Escaper paramEscaper

Escaper for form parameters.

fragmentEscaper

@Nonnull
private final Escaper fragmentEscaper

Escaper for fragments.

pathEscaper

@Nonnull
private final Escaper pathEscaper

Escaper for path segments.

customObject

@Nullable
private Object customObject

A custom object to inject into the template.

Constructor Details

TemplatedStringLookupStrategy

public TemplatedStringLookupStrategy()

Constructor.

Method Details

setTemplateText

public void setTemplateText(@Nullable
 String text)

Set the template to be evaluated.

Parameters:

text - template to be evaluated

setVelocityEngine

public void setVelocityEngine(@Nonnull
 org.apache.velocity.app.VelocityEngine velocityEngine)

Set the VelocityEngine to be used.

Parameters:

velocityEngine - engine to be used

setCustomObject

public void setCustomObject(@Nullable
 Object object)

Set the custom (externally provided) object.

Parameters:

object - the custom object

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

merge

@Nonnull
@NotEmpty
protected String merge(@Nonnull
 org.apache.velocity.VelocityContext context)

Invokes Template.merge(org.apache.velocity.context.Context) on the supplied context.

Parameters:

context - to merge

Returns:

result of the merge operation

apply

@Nullable
public String apply(@Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

apply in interface Function<ProfileRequestContext,String>