org.apache.xml.security.encryption
Interface EncryptionProperties


public interface EncryptionProperties

EncryptionProperties can hold additional information concerning the generation of the EncryptedData or EncryptedKey. This information is wraped int an EncryptionProperty element. Examples of additional information is e.g., a date/time stamp or the serial number of cryptographic hardware used during encryption).

It is defined as follows:

<element name='EncryptionProperties' type='xenc:EncryptionPropertiesType'/> <complexType name='EncryptionPropertiesType'> <sequence> <element ref='xenc:EncryptionProperty' maxOccurs='unbounded'/> </sequence> <attribute name='Id' type='ID' use='optional'/> </complexType>

Author:
Axl Mattheus

Method Summary
 void addEncryptionProperty(EncryptionProperty property)
          Adds an EncryptionProperty.
 Iterator<EncryptionProperty> getEncryptionProperties()
          Returns an Iterator over all the EncryptionPropterty elements contained in this EncryptionProperties.
 String getId()
          Returns the EncryptionProperties' id.
 void removeEncryptionProperty(EncryptionProperty property)
          Removes the specified EncryptionProperty.
 void setId(String id)
          Sets the id.
 

Method Detail

getId

String getId()
Returns the EncryptionProperties' id.

Returns:
the id.

setId

void setId(String id)
Sets the id.

Parameters:
id - the id.

getEncryptionProperties

Iterator<EncryptionProperty> getEncryptionProperties()
Returns an Iterator over all the EncryptionPropterty elements contained in this EncryptionProperties.

Returns:
an Iterator over all the encryption properties.

addEncryptionProperty

void addEncryptionProperty(EncryptionProperty property)
Adds an EncryptionProperty.

Parameters:
property -

removeEncryptionProperty

void removeEncryptionProperty(EncryptionProperty property)
Removes the specified EncryptionProperty.

Parameters:
property -


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