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

クラス ScriptedAttributeDefinition

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.ScriptedAttributeDefinition

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

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

public class ScriptedAttributeDefinition
extends BaseAttributeDefinition

An attribute definition the computes the attribute definition by executing a script written in some JSR-223 supporting language.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
ScriptedAttributeDefinition(String language) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected void	compileScript() Compiles the script if the scripting engine supports it.
protected BaseAttribute<?>	doResolve(ShibbolethResolutionContext resolutionContext) Creates and populates the values for the resolved attribute.
String	getScript() Gets the script that will be executed.
protected ScriptContext	getScriptContext(ShibbolethResolutionContext resolutionContext) Creates the script execution context from the resolution context.
String	getScriptLanguage() Gets the scripting language used.
void	initialize() Initializes this attribute definition.
void	setScript(String newScript) Sets the script that will be executed.
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

コンストラクタの詳細

ScriptedAttributeDefinition

public ScriptedAttributeDefinition(String language)

Constructor.

パラメータ:

language - the scripting language that will be used

メソッドの詳細

getScriptLanguage

public String getScriptLanguage()

Gets the scripting language used.

戻り値:

scripting language used

getScript

public String getScript()

Gets the script that will be executed.

戻り値:

script that will be executed

setScript

public void setScript(String newScript)

Sets the script that will be executed.

パラメータ:

newScript - script that will be executed

initialize

public void initialize()

Initializes this attribute definition.

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

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

compileScript

protected void compileScript()

Compiles the script if the scripting engine supports it.

getScriptContext

protected ScriptContext getScriptContext(ShibbolethResolutionContext resolutionContext)
                                  throws AttributeResolutionException

Creates the script execution context from the resolution context.

パラメータ:

resolutionContext - current resolution context

戻り値:

constructed script context

例外:

AttributeResolutionException - thrown if dependent data connectors or attribute definitions can not be resolved