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

クラス SAML2NameIDAttributeDefinition

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

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

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

public class SAML2NameIDAttributeDefinition
extends BaseAttributeDefinition

An attribute definition the creates attributes whose values are NameID. When building the NameID the textual content of the NameID is the value of the source attribute. If a nameIdQualifier is provided that value is used as the NameID's name qualifier otherwise the attribute issuer's entity ID is used. The attribute requester's entity ID is always used as the NameID's SP name qualifier.

コンストラクタの概要

コンストラクタ

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

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected NameID	buildNameId(String nameIdValue, ShibbolethResolutionContext resolutionContext) Builds a name ID.
protected BaseAttribute<?>	doResolve(ShibbolethResolutionContext resolutionContext) Creates and populates the values for the resolved attribute.
String	getNameIdFormat() Gets the format for the NameID used as an attribute value.
String	getNameIdQualifier() Gets the NameQualifier for the NameID used as an attribute value.
String	getNameIdSPQualifier() Gets the SPNameQualifier for the NameID used as an attribute value.
void	setNameIdFormat(String format) Sets the format for the NameID used as an attribute value.
void	setNameIdQualifier(String qualifier) Sets the NameQualifier for the NameID used as an attribute value.
void	setNameIdSPQualifier(String qualifier) Sets the SPNameQualifier for the NameID used as an attribute value.
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

コンストラクタの詳細

SAML2NameIDAttributeDefinition

public SAML2NameIDAttributeDefinition()

Constructor.

メソッドの詳細

getNameIdFormat

public String getNameIdFormat()

Gets the format for the NameID used as an attribute value.

戻り値:

format for the NameID used as an attribute value

setNameIdFormat

public void setNameIdFormat(String format)

Sets the format for the NameID used as an attribute value.

パラメータ:

format - format for the NameID used as an attribute value

getNameIdQualifier

public String getNameIdQualifier()

Gets the NameQualifier for the NameID used as an attribute value.

戻り値:

NameQualifier for the NameID used as an attribute value

setNameIdQualifier

public void setNameIdQualifier(String qualifier)

Sets the NameQualifier for the NameID used as an attribute value.

パラメータ:

qualifier - NameQualifier for the NameID used as an attribute value

getNameIdSPQualifier

public String getNameIdSPQualifier()

Gets the SPNameQualifier for the NameID used as an attribute value.

戻り値:

SPNameQualifier for the NameID used as an attribute value

setNameIdSPQualifier

public void setNameIdSPQualifier(String qualifier)

Sets the SPNameQualifier for the NameID used as an attribute value.

パラメータ:

qualifier - SPNameQualifier for the NameID used as an attribute value

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

buildNameId

protected NameID buildNameId(String nameIdValue,
                 ShibbolethResolutionContext resolutionContext)

Builds a name ID. The provided value is the textual content of the NameID. The NameQualifier and SPNameQualifier are set according to the configuration, or to the local and requesting entityIDs respectively.

パラメータ:

nameIdValue - value of the NameID

resolutionContext - current resolution context

戻り値:

the constructed NameID

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