net.shibboleth.idp.attribute.resolver.ad.impl

Class TemplateAttributeDefinition

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin<IdPAttribute>

net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

net.shibboleth.idp.attribute.resolver.ad.impl.TemplateAttributeDefinition

All Implemented Interfaces:

AttributeDefinition, ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, org.springframework.beans.factory.DisposableBean

@ThreadSafeAfterInit
public class TemplateAttributeDefinition
extends AbstractAttributeDefinition

An attribute definition that constructs its values based on the values of its dependencies using the Velocity Template Language. Dependencies may have multiple values, however multiple dependencies must have the same number of values. In the case of multi-valued dependencies, the template will be evaluated multiples times, iterating over each dependency.

The template is inserted into the engine with a unique name derived from this class and from the id supplied for this attribute.

Field Summary

Fields

Modifier and Type	Field and Description
private VelocityEngine	engine VelocityEngine.
private org.slf4j.Logger	log Class logger.
private List<String>	sourceAttributes The names of the attributes we need.
private Template	template Template to be evaluated.
private String	templateText Template (as Text) to be evaluated.

Constructor Summary

Constructors

Constructor and Description
TemplateAttributeDefinition() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected IdPAttribute	doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext)
protected void	doInitialize()
List<String>	getSourceAttributes() Get the source attribute IDs.
Template	getTemplate() Get the template text to be evaluated.
String	getTemplateText() Get the template text to be evaluated.
VelocityEngine	getVelocityEngine() Get the VelocityEngine to be used.
void	setSourceAttributes(List<String> newSourceAttributes) Set the source attribute IDs.
void	setTemplateText(String velocityTemplate) Set the literal text of the template to be evaluated.
private int	setupSourceValues(AttributeResolverWorkContext workContext, Map<String,Iterator<IdPAttributeValue<?>>> sourceValues) Set up a map which can be used to populate the template.
void	setVelocityEngine(VelocityEngine velocityEngine) Set the VelocityEngine to be used.

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

doResolve, getAttributeEncoders, getDisplayDescriptions, getDisplayNames, getLogPrefix, getSourceAttributeId, isDependencyOnly, setAttributeEncoders, setDependencyOnly, setDisplayDescriptions, setDisplayNames, setSourceAttributeId

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin

doDestroy, equals, getActivationCondition, getDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, resolve, setActivationCondition, setDependencies, setProfileContextStrategy, setPropagateResolutionExceptions

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getDependencies, isPropagateResolutionExceptions, resolve

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

template

@NonnullAfterInit
private Template template

Template to be evaluated.

templateText

@NonnullAfterInit
private String templateText

Template (as Text) to be evaluated.

engine

@NonnullAfterInit
private VelocityEngine engine

VelocityEngine.

sourceAttributes

@Nonnull
@NonnullElements
private List<String> sourceAttributes

The names of the attributes we need.

Constructor Detail

TemplateAttributeDefinition

public TemplateAttributeDefinition()

Constructor.

Method Detail

getSourceAttributes

@Nonnull
@Unmodifiable
@NonnullElements
public List<String> getSourceAttributes()

Get the source attribute IDs.

Returns:

the source attribute IDs

setSourceAttributes

public void setSourceAttributes(@Nonnull@NullableElements
                       List<String> newSourceAttributes)

Set the source attribute IDs.

Parameters:

newSourceAttributes - the source attribute IDs

getTemplate

@NonnullAfterInit
public Template getTemplate()

Get the template text to be evaluated.

Returns:

the template

getTemplateText

@NonnullAfterInit
public String getTemplateText()

Get the template text to be evaluated.

Returns:

the template

setTemplateText

public void setTemplateText(@Nullable
                   String velocityTemplate)

Set the literal text of the template to be evaluated.

Parameters:

velocityTemplate - template to be evaluated

getVelocityEngine

@NonnullAfterInit
public VelocityEngine getVelocityEngine()

Get the VelocityEngine to be used.

Returns:

the template

setVelocityEngine

public void setVelocityEngine(@Nonnull
                     VelocityEngine velocityEngine)

Set the VelocityEngine to be used.

Parameters:

velocityEngine - engine to be used

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractAttributeDefinition

Throws:

ComponentInitializationException

doAttributeDefinitionResolve

@Nonnull
protected IdPAttribute doAttributeDefinitionResolve(@Nonnull
                                                AttributeResolutionContext resolutionContext,
                                                @Nonnull
                                                AttributeResolverWorkContext workContext)
                                             throws ResolutionException

Specified by:

doAttributeDefinitionResolve in class AbstractAttributeDefinition

Throws:

ResolutionException

setupSourceValues

private int setupSourceValues(@Nonnull
                    AttributeResolverWorkContext workContext,
                    @Nonnull@NonnullElements
                    Map<String,Iterator<IdPAttributeValue<?>>> sourceValues)
                       throws ResolutionException

Set up a map which can be used to populate the template. The key is the attribute name and the value is the iterator to give all the names. We also return how deep the iteration will be and throw an exception if there is a mismatch in number of elements in any attribute.

Finally, the names of the source attributes is checked against the dependency attributes and if there is a mismatch then a warning is emitted.

Parameters:

workContext - source for dependencies

sourceValues - to populate with the attribute iterators

Returns:

how many values in the attributes

Throws:

ResolutionException - if there is a mismatched count of attributes