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

クラス ContextualAttributeDefinition

java.lang.Object

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

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

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

public class ContextualAttributeDefinition
extends Object
implements AttributeDefinition

Wrapper for an AttributeDefinition within a ShibbolethResolutionContext. This wrapper ensures that the definition is resolved only once per context.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
ContextualAttributeDefinition(AttributeDefinition newDefinition) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	equals(Object obj)
List<AttributeEncoder>	getAttributeEncoders() Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.
List<String>	getDependencyIds() Gets the IDs of the resolution plugins this plugin is dependent on.
Map<Locale,String>	getDisplayDescriptions() Gets the localized human readable description of attribute.
Map<Locale,String>	getDisplayNames() Gets the localized human readable name of the attribute.
String	getId() Returns the unique ID of the plugin.
int	hashCode()
boolean	isDependencyOnly() Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.
BaseAttribute	resolve(ShibbolethResolutionContext resolutionContext) Performs the attribute resolution for this plugin.
void	validate() Validate the internal state of this plug-in.

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

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

コンストラクタの詳細

ContextualAttributeDefinition

public ContextualAttributeDefinition(AttributeDefinition newDefinition)

Constructor.

パラメータ:

newDefinition - attribute definition to wrap

メソッドの詳細

equals

public boolean equals(Object obj)

オーバーライド:

equals クラス内 Object

getAttributeEncoders

public List<AttributeEncoder> getAttributeEncoders()

Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.

定義:

getAttributeEncoders インタフェース内 AttributeDefinition

戻り値:

encoders to be added to attributes produced by this definition

getDependencyIds

public List<String> getDependencyIds()

Gets the IDs of the resolution plugins this plugin is dependent on.

定義:

getDependencyIds インタフェース内 ResolutionPlugIn<BaseAttribute>

戻り値:

IDs of the data connectors this plugin is dependent on

getDisplayDescriptions

public Map<Locale,String> getDisplayDescriptions()

Gets the localized human readable description of attribute.

定義:

getDisplayDescriptions インタフェース内 AttributeDefinition

戻り値:

human readable description of attribute

getDisplayNames

public Map<Locale,String> getDisplayNames()

Gets the localized human readable name of the attribute.

定義:

getDisplayNames インタフェース内 AttributeDefinition

戻り値:

human readable name of the attribute

getId

public String getId()

Returns the unique ID of the plugin.

定義:

getId インタフェース内 ResolutionPlugIn<BaseAttribute>

戻り値:

unique ID of the plugin

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

isDependencyOnly

public boolean isDependencyOnly()

Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.

定義:

isDependencyOnly インタフェース内 AttributeDefinition

戻り値:

whether this attribute definition is only a dependency

resolve

public BaseAttribute resolve(ShibbolethResolutionContext resolutionContext)
                      throws AttributeResolutionException

Performs the attribute resolution for this plugin.

定義:

resolve インタフェース内 ResolutionPlugIn<BaseAttribute>

パラメータ:

resolutionContext - the context for the resolution

戻り値:

the attributes made available by the resolution, never null

例外:

AttributeResolutionException - the problem that occurred during the resolution

validate

public void validate()
              throws AttributeResolutionException

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

定義:

validate インタフェース内 ResolutionPlugIn<BaseAttribute>

例外:

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