edu.internet2.middleware.shibboleth.common.attribute.encoding

インタフェース AttributeEncoder<EncodedType>

型パラメータ:

EncodedType - the type of object created by encoding the attribute

既知のサブインタフェースのリスト:

SAML1AttributeEncoder, SAML1NameIdentifierEncoder, SAML2AttributeEncoder, SAML2NameIDEncoder, SAMLNameIdentifierEncoder<NameIDType>, XMLObjectAttributeEncoder<XMLObjectType>

既知の実装クラスのリスト:

AbstractAttributeEncoder, AbstractSAML1AttributeEncoder, AbstractSAML2AttributeEncoder, AbstractScopedAttributeEncoder, SAML1Base64AttributeEncoder, SAML1ScopedStringAttributeEncoder, SAML1StringAttributeEncoder, SAML1StringNameIdentifierEncoder, SAML1XMLObjectAttributeEncoder, SAML2Base64AttributeEncoder, SAML2ScopedStringAttributeEncoder, SAML2StringAttributeEncoder, SAML2StringNameIDEncoder, SAML2XMLObjectAttributeEncoder

public interface AttributeEncoder<EncodedType>

Attribute encoders convert BaseAttributes into protocol specific representations. Encoders may have contain a category that can be used to distingush encoder types from each other. This inteded to be used to look up an encoder that can be used to encode attributes in accordance with a defined specification or tranmission protcol. Encoders MUST be thread-safe and stateless.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
EncodedType	encode(BaseAttribute attribute) Enocdes the attribute into a protocol specific representations.
String	getAttributeName() Get the name of the attribute.
void	setAttributeName(String attributeName) Sets the name of the attribute.

メソッドの詳細

getAttributeName

String getAttributeName()

Get the name of the attribute.

戻り値:

name of the attribute

setAttributeName

void setAttributeName(String attributeName)

Sets the name of the attribute.

パラメータ:

attributeName - name of the attribute

encode

EncodedType encode(BaseAttribute attribute)
                   throws AttributeEncodingException

Enocdes the attribute into a protocol specific representations.

パラメータ:

attribute - the attribute to encode

戻り値:

the Object the attribute was encoded into

例外:

AttributeEncodingException - if unable to successfully encode attribute