Attribute (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.identity.saml2.assertion
インタフェース Attribute

public interface Attribute

The Attribute element identifies an attribute by name and optionally includes its value(s). It has the AttributeType complex type.

 <complexType name="AttributeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         AttributeValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="FriendlyName"
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="Name" use="required"
       type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="NameFormat"
       type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </restriction>
   </complexContent>
 </complexType>

メソッドの概要
`EncryptedAttribute`	`encrypt(Key recipientPublicKey, String dataEncAlgorithm, int dataEncStrength, String recipientEntityID)` Returns an `EncryptedAttribute` object.
`Map`	`getAnyAttribute()` Returns the `anyAttribute` of the attribute.
`List`	`getAttributeValue()` Returns the `AttributeValue`(s) of the `Attribute`.
`List`	`getAttributeValueString()` Returns the `AttributeValue`(s) of the `Attribute`.
`String`	`getFriendlyName()` Returns the `FriendlyName` of the attribute.
`String`	`getName()` Returns the `Name` of the attribute.
`String`	`getNameFormat()` Returns the `NameFormat` of the attribute.
`boolean`	`isMutable()` Returns the mutability of the object.
`void`	`makeImmutable()` Makes the object immutable.
`void`	`setAnyAttribute(Map value)` Sets the `anyAttribute` of the attribute.
`void`	`setAttributeValue(List value)` Sets the `AttributeValue`(s) of the `Attribute`.
`void`	`setAttributeValueString(List value)` Sets the value of `AttributeValue` element(s).
`void`	`setFriendlyName(String value)` Sets the `FriendlyName` of the attribute.
`void`	`setName(String value)` Sets the `Name` of the attribute.
`void`	`setNameFormat(String value)` Sets the `NameFormat` of the attribute.
`String`	`toXMLString()` Returns a String representation of the element.
`String`	`toXMLString(boolean includeNS, boolean declareNS)` Returns a String representation of the element.

メソッドの詳細

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

戻り値:: true if the object is mutable; false otherwise.

getAttributeValue

List getAttributeValue()

Returns the AttributeValue(s) of the Attribute.

戻り値:: List of xml String representing AttributeValue(s) of the Attribute.
関連項目:: Attribute.setAttributeValue(List)

setAttributeValue

void setAttributeValue(List value)
                       throws SAML2Exception

Sets the AttributeValue(s) of the Attribute.

パラメータ:: value - List of xml String representing the new AttributeValue element(s).
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getAttributeValue()

getAttributeValueString

List getAttributeValueString()

Returns the AttributeValue(s) of the Attribute.

戻り値:: List of String representing the value of AttributeValue(s).
関連項目:: Attribute.setAttributeValueString(List)

setAttributeValueString

void setAttributeValueString(List value)
                             throws SAML2Exception

Sets the value of AttributeValue element(s).

パラメータ:: value - List of String representing the value of the new AttributeValue element(s).
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getAttributeValueString()

getName

String getName()

Returns the Name of the attribute.

戻り値:: the Name of the attribute.
関連項目:: Attribute.setName(String)

setName

void setName(String value)
             throws SAML2Exception

Sets the Name of the attribute.

パラメータ:: value - new Name of the attribute.
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getName()

getNameFormat

String getNameFormat()

Returns the NameFormat of the attribute.

戻り値:: the value of NameFormat.
関連項目:: Attribute.setNameFormat(String)

setNameFormat

void setNameFormat(String value)
                   throws SAML2Exception

Sets the NameFormat of the attribute.

パラメータ:: value - new NameFormat of the attribute.
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getNameFormat()

getFriendlyName

String getFriendlyName()

Returns the FriendlyName of the attribute.

戻り値:: the value of FriendlyName of the attribute.
関連項目:: Attribute.setFriendlyName(String)

setFriendlyName

void setFriendlyName(String value)
                     throws SAML2Exception

Sets the FriendlyName of the attribute.

パラメータ:: value - new FriendlyName of the attribute.
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getFriendlyName()

getAnyAttribute

Map getAnyAttribute()

Returns the anyAttribute of the attribute.

戻り値:: A Map containing name/value pairs of anyAttribute. Both the name and value are String object types.
関連項目:: Attribute.setAnyAttribute(Map)

setAnyAttribute

void setAnyAttribute(Map value)
                     throws SAML2Exception

Sets the anyAttribute of the attribute.

パラメータ:: value - Map of name/value pairs to be set. Both the name and value are String object types.
例外:: SAML2Exception - if the object is immutable.
関連項目:: Attribute.getAnyAttribute()

encrypt

EncryptedAttribute encrypt(Key recipientPublicKey,
                           String dataEncAlgorithm,
                           int dataEncStrength,
                           String recipientEntityID)
                           throws SAML2Exception

Returns an EncryptedAttribute object.

パラメータ:: recipientPublicKey - Public key used to encrypt the data encryption (secret) key, it is the public key of the recipient of the XML document to be encrypted.; dataEncAlgorithm - Data encryption algorithm.; dataEncStrength - Data encryption strength.; recipientEntityID - Unique identifier of the recipient, it is used as the index to the cached secret key so that the key can be reused for the same recipient; It can be null in which case the secret key will be generated every time and will not be cached and reused. Note that the generation of a secret key is a relatively expensive operation.
戻り値:: EncryptedAttribute object
例外:: SAML2Exception - if error occurs during the encryption process.

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

戻り値:: A string containing the valid XML for this element. By default name space name is prepended to the element name.
例外:: SAML2Exception - if the object does not conform to the schema.

toXMLString

String toXMLString(boolean includeNS,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

パラメータ:: includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted; declareNS - Determines whether or not the namespace is declared within the Element.
戻り値:: A string containing the valid XML for this element
例外:: SAML2Exception - if the object does not conform to the schema.