org.apache.xml.security.encryption
Interface EncryptionProperty


public interface EncryptionProperty

Additional information items concerning the generation of the EncryptedData or EncryptedKey can be placed in an EncryptionProperty element (e.g., date/time stamp or the serial number of cryptographic hardware used during encryption). The Target attribute identifies the EncryptedType structure being described. anyAttribute permits the inclusion of attributes from the XML namespace to be included (i.e., xml:space, xml:lang, and xml:base).

It is defined as follows:

<element name='EncryptionProperty' type='xenc:EncryptionPropertyType'/> <complexType name='EncryptionPropertyType' mixed='true'> <choice maxOccurs='unbounded'> <any namespace='##other' processContents='lax'/> </choice> <attribute name='Target' type='anyURI' use='optional'/> <attribute name='Id' type='ID' use='optional'/> <anyAttribute namespace="http://www.w3.org/XML/1998/namespace"/> </complexType>

Author:
Axl Mattheus

Method Summary
 void addEncryptionInformation(Element information)
          Adds encryption information.
 String getAttribute(String attribute)
          Returns the attribute's value in the xml namespace.
 Iterator<Element> getEncryptionInformation()
          Returns the properties of the EncryptionProperty.
 String getId()
          Returns the id of the EncryptionProperty.
 String getTarget()
          Returns the EncryptedType being described.
 void removeEncryptionInformation(Element information)
          Removes encryption information.
 void setAttribute(String attribute, String value)
          Set the attribute value.
 void setId(String id)
          Sets the id.
 void setTarget(String target)
          Sets the target.
 

Method Detail

getTarget

String getTarget()
Returns the EncryptedType being described.

Returns:
the EncryptedType being described by this EncryptionProperty.

setTarget

void setTarget(String target)
Sets the target.

Parameters:
target -

getId

String getId()
Returns the id of the EncryptionProperty.

Returns:
the id.

setId

void setId(String id)
Sets the id.

Parameters:
id -

getAttribute

String getAttribute(String attribute)
Returns the attribute's value in the xml namespace.

Parameters:
attribute -
Returns:
the attribute's value.

setAttribute

void setAttribute(String attribute,
                  String value)
Set the attribute value.

Parameters:
attribute - the attribute's name.
value - the attribute's value.

getEncryptionInformation

Iterator<Element> getEncryptionInformation()
Returns the properties of the EncryptionProperty.

Returns:
an Iterator over all the additional encryption information contained in this class.

addEncryptionInformation

void addEncryptionInformation(Element information)
Adds encryption information.

Parameters:
information - the additional encryption information.

removeEncryptionInformation

void removeEncryptionInformation(Element information)
Removes encryption information.

Parameters:
information - the information to remove.


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.