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>
*
* @supported.all.api
*/
@JsonDeserialize(as=AttributeImpl.class)
public interface Attribute {
/**
* Makes the object immutable.
*/
void makeImmutable();
/**
* Returns the mutability of the object.
*
* @return true if the object is mutable;
* false otherwise.
*/
boolean isMutable();
/**
* Returns the AttributeValue(s) of the Attribute.
*
* @return List of xml String representing AttributeValue(s)
* of the Attribute.
* @see #setAttributeValue(List)
*/
List getAttributeValue();
/**
* Sets the AttributeValue(s) of the Attribute.
*
* @param value List of xml String representing the new
* AttributeValue element(s).
* @throws SAML2Exception if the object is immutable.
* @see #getAttributeValue()
*/
void setAttributeValue(List value) throws SAML2Exception;
/**
* Returns the AttributeValue(s) of the Attribute.
*
* @return List of String representing the value of
* AttributeValue(s).
* @see #setAttributeValueString(List)
*/
List getAttributeValueString();
/**
* Sets the value of AttributeValue element(s).
*
* @param value List of String representing the value of the new
* AttributeValue element(s).
* @throws SAML2Exception if the object is immutable.
* @see #getAttributeValueString()
*/
void setAttributeValueString(List value) throws SAML2Exception;
/**
* Returns the Name of the attribute.
*
* @return the Name of the attribute.
* @see #setName(String)
*/
String getName();
/**
* Sets the Name of the attribute.
*
* @param value new Name of the attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getName()
*/
void setName(String value) throws SAML2Exception;
/**
* Returns the NameFormat of the attribute.
*
* @return the value of NameFormat.
* @see #setNameFormat(String)
*/
String getNameFormat();
/**
* Sets the NameFormat of the attribute.
*
* @param value new NameFormat of the attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getNameFormat()
*/
void setNameFormat(String value) throws SAML2Exception;
/**
* Returns the FriendlyName of the attribute.
*
* @return the value of FriendlyName of the attribute.
* @see #setFriendlyName(String)
*/
String getFriendlyName();
/**
* Sets the FriendlyName of the attribute.
*
* @param value new FriendlyName of the attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getFriendlyName()
*/
void setFriendlyName(String value) throws SAML2Exception;
/**
* Returns the anyAttribute of the attribute.
*
* @return A Map containing name/value pairs of anyAttribute.
* Both the name and value are String object types.
* @see #setAnyAttribute(Map)
*/
Map getAnyAttribute();
/**
* Sets the anyAttribute of the attribute.
*
* @param value Map of name/value pairs to be set. Both the name and value
* are String object types.
* @throws SAML2Exception if the object is immutable.
* @see #getAnyAttribute()
*/
void setAnyAttribute(Map value) throws SAML2Exception;
/**
* Returns an EncryptedAttribute object.
*
* @param 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.
* @param dataEncAlgorithm Data encryption algorithm.
* @param dataEncStrength Data encryption strength.
* @param 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.
* @return EncryptedAttribute object
* @throws SAML2Exception if error occurs during the encryption process.
*/
EncryptedAttribute encrypt(Key recipientPublicKey, String dataEncAlgorithm,
int dataEncStrength, String recipientEntityID) throws SAML2Exception;
/**
* Returns a String representation of the element.
*
* @return A string containing the valid XML for this element.
* By default name space name is prepended to the element name.
* @throws SAML2Exception if the object does not conform to the schema.
*/
String toXMLString() throws SAML2Exception;
/**
* Returns a String representation of the element.
*
* @param includeNS Determines whether or not the namespace qualifier is
* prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return A string containing the valid XML for this element
* @throws SAML2Exception if the object does not conform to the schema.
*/
String toXMLString(boolean includeNS, boolean declareNS) throws SAML2Exception;
}