edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition

クラス TemplateAttributeDefinition

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn<BaseAttribute>

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.BaseAttributeDefinition

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.TemplateAttributeDefinition

すべての実装されたインタフェース:

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

public class TemplateAttributeDefinition
extends BaseAttributeDefinition

An AttributeDefinition that constructs its values based on the values of its dependencies using the Velocity Template Language. Dependencies may have multiple values, however multiples 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.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
TemplateAttributeDefinition(org.apache.velocity.app.VelocityEngine newVelocityEngine) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected BaseAttribute	doResolve(ShibbolethResolutionContext resolutionContext) Creates and populates the values for the resolved attribute.
String	getAttributeTemplate() Get the attribute template.
List<String>	getSourceAttributes() Get the source attribute IDs.
void	initialize() Initialize the attribute definition and prepare it for use.
protected void	registerTemplate() Registers the template with template engine.
void	setAttributeTemplate(String newAttributeTemplate) Set the attribute template.
void	setSourceAttributes(List<String> newSourceAttributes) Set the source attribute IDs.
void	validate() Validate the internal state of this plug-in.

クラスから継承されたメソッド edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.BaseAttributeDefinition

getAttributeEncoders, getDisplayDescriptions, getDisplayNames, getSourceAttributeID, getValuesFromAllDependencies, isDependencyOnly, resolve, setDependencyOnly, setSourceAttributeID

クラスから継承されたメソッド edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn

getDependencyIds, getId, getValuesFromAllDependencies, getValuesFromAttributeDependency, getValuesFromConnectorDependency, setId

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn

getDependencyIds, getId

コンストラクタの詳細

TemplateAttributeDefinition

public TemplateAttributeDefinition(org.apache.velocity.app.VelocityEngine newVelocityEngine)

Constructor.

パラメータ:

newVelocityEngine - velocity engine used to parse template.

メソッドの詳細

doResolve

protected BaseAttribute doResolve(ShibbolethResolutionContext resolutionContext)
                           throws AttributeResolutionException

Creates and populates the values for the resolved attribute. Implementations should *not* set, or otherwise manage, the attribute encoders for the resolved attribute.

定義:

doResolve クラス内 BaseAttributeDefinition

パラメータ:

resolutionContext - current attribute resolution context

戻り値:

resolved attribute

例外:

AttributeResolutionException - thrown if there is a problem resolving and creating the attribute

initialize

public void initialize()
                throws Exception

Initialize the attribute definition and prepare it for use.

例外:

Exception - if unable to initialize attribute definition

registerTemplate

protected void registerTemplate()

Registers the template with template engine.

validate

public void validate()
              throws AttributeResolutionException

Validate the internal state of this plug-in. This process may not rely on information from any dependency.

例外:

AttributeResolutionException - if the plug-in has an invalid internal state

getAttributeTemplate

public String getAttributeTemplate()

Get the attribute template.

戻り値:

the attribute template

setAttributeTemplate

public void setAttributeTemplate(String newAttributeTemplate)

Set the attribute template.

パラメータ:

newAttributeTemplate - the attribute template

getSourceAttributes

public List<String> getSourceAttributes()

Get the source attribute IDs.

戻り値:

the source attribute IDs

setSourceAttributes

public void setSourceAttributes(List<String> newSourceAttributes)

Set the source attribute IDs.

パラメータ:

newSourceAttributes - the source attribute IDs