|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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>
| Method Summary | |
EncryptedAttribute |
encrypt(java.security.Key recipientPublicKey,
java.lang.String dataEncAlgorithm,
int dataEncStrength,
java.lang.String recipientEntityID)
Returns an EncryptedAttribute object. |
java.util.Map |
getAnyAttribute()
Returns the anyAttribute of the attribute. |
java.util.List |
getAttributeValue()
Returns the AttributeValue(s) of the Attribute. |
java.util.List |
getAttributeValueString()
Returns the AttributeValue(s) of the Attribute. |
java.lang.String |
getFriendlyName()
Returns the FriendlyName of the attribute. |
java.lang.String |
getName()
Returns the Name of the attribute. |
java.lang.String |
getNameFormat()
Returns the NameFormat of the attribute. |
boolean |
isMutable()
Returns the mutability of the object. |
void |
makeImmutable()
Makes the object immutable. |
void |
setAnyAttribute(java.util.Map value)
Sets the anyAttribute of the attribute. |
void |
setAttributeValue(java.util.List value)
Sets the AttributeValue(s) of the Attribute. |
void |
setAttributeValueString(java.util.List value)
Sets the value of AttributeValue element(s). |
void |
setFriendlyName(java.lang.String value)
Sets the FriendlyName of the attribute. |
void |
setName(java.lang.String value)
Sets the Name of the attribute. |
void |
setNameFormat(java.lang.String value)
Sets the NameFormat of the attribute. |
java.lang.String |
toXMLString()
Returns a String representation of the element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS)
Returns a String representation of the element. |
| Method Detail |
public void makeImmutable()
public boolean isMutable()
true if the object is mutable;
false otherwise.public java.util.List getAttributeValue()
AttributeValue(s) of the Attribute.
AttributeValue(s)
of the Attribute.setAttributeValue(List)
public void setAttributeValue(java.util.List value)
throws SAML2Exception
AttributeValue(s) of the Attribute.
value - List of xml String representing the new
AttributeValue element(s).
SAML2Exception - if the object is immutable.getAttributeValue()public java.util.List getAttributeValueString()
AttributeValue(s) of the Attribute.
AttributeValue(s).setAttributeValueString(List)
public void setAttributeValueString(java.util.List value)
throws SAML2Exception
AttributeValue element(s).
value - List of String representing the value of the new
AttributeValue element(s).
SAML2Exception - if the object is immutable.getAttributeValueString()public java.lang.String getName()
Name of the attribute.
Name of the attribute.setName(String)
public void setName(java.lang.String value)
throws SAML2Exception
Name of the attribute.
value - new Name of the attribute.
SAML2Exception - if the object is immutable.getName()public java.lang.String getNameFormat()
NameFormat of the attribute.
NameFormat.setNameFormat(String)
public void setNameFormat(java.lang.String value)
throws SAML2Exception
NameFormat of the attribute.
value - new NameFormat of the attribute.
SAML2Exception - if the object is immutable.getNameFormat()public java.lang.String getFriendlyName()
FriendlyName of the attribute.
FriendlyName of the attribute.setFriendlyName(String)
public void setFriendlyName(java.lang.String value)
throws SAML2Exception
FriendlyName of the attribute.
value - new FriendlyName of the attribute.
SAML2Exception - if the object is immutable.getFriendlyName()public java.util.Map getAnyAttribute()
anyAttribute of the attribute.
anyAttribute.
Both the name and value are String object types.setAnyAttribute(Map)
public void setAnyAttribute(java.util.Map value)
throws SAML2Exception
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.getAnyAttribute()
public EncryptedAttribute encrypt(java.security.Key recipientPublicKey,
java.lang.String dataEncAlgorithm,
int dataEncStrength,
java.lang.String recipientEntityID)
throws SAML2Exception
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.
public java.lang.String toXMLString()
throws SAML2Exception
SAML2Exception - if the object does not conform to the schema.
public java.lang.String toXMLString(boolean includeNS,
boolean declareNS)
throws SAML2Exception
includeNS - Determines whether or not the namespace qualifier is
prepended to the Element when converteddeclareNS - Determines whether or not the namespace is declared
within the Element.
SAML2Exception - if the object does not conform to the schema.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||