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

クラス BaseAttributeDefinition

java.lang.Object

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

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

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

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

直系の既知のサブクラス:

CryptoTransientIdAttributeDefinition, MappedAttributeDefinition, PrescopedAttributeDefinition, PrincipalAuthenticationMethodDefinition, PrincipalNameDefinition, RegexSplitAttributeDefinition, SAML1NameIdentifierAttributeDefinition, SAML2NameIDAttributeDefinition, ScopedAttributeDefinition, ScriptedAttributeDefinition, SimpleAttributeDefinition, TemplateAttributeDefinition, TransientIdAttributeDefinition

public abstract class BaseAttributeDefinition
extends AbstractResolutionPlugIn<BaseAttribute>
implements AttributeDefinition

Base class for AttributeDefinition plug-ins.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseAttributeDefinition() Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected abstract BaseAttribute	doResolve(ShibbolethResolutionContext resolutionContext) Creates and populates the values for the resolved attribute.
List<AttributeEncoder>	getAttributeEncoders() Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.
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	getSourceAttributeID() Return the source attribute.
protected Collection<Object>	getValuesFromAllDependencies(ShibbolethResolutionContext context) Get values from dependencies.
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	setDependencyOnly(boolean isDependencyOnly) Sets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.
void	setSourceAttributeID(String newSourceAttributeID) Set the source attribute.

クラスから継承されたメソッド 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, validate

コンストラクタの詳細

BaseAttributeDefinition

public BaseAttributeDefinition()

Constructor.

メソッドの詳細

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

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

setDependencyOnly

public void setDependencyOnly(boolean isDependencyOnly)

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

パラメータ:

isDependencyOnly - whether this attribute definition is only a dependency

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

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

doResolve

protected abstract 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.

パラメータ:

resolutionContext - current attribute resolution context

戻り値:

resolved attribute

例外:

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

getValuesFromAllDependencies

protected Collection<Object> getValuesFromAllDependencies(ShibbolethResolutionContext context)

Get values from dependencies.

パラメータ:

context - resolution context

戻り値:

collection of values

getSourceAttributeID

public String getSourceAttributeID()

Return the source attribute. If the source attribute is null, return the definition ID.

戻り値:

Returns the sourceAttribute.

setSourceAttributeID

public void setSourceAttributeID(String newSourceAttributeID)

Set the source attribute.

パラメータ:

newSourceAttributeID - The sourceAttribute to set.