org.apache.xml.security.encryption
Interface EncryptionMethod


public interface EncryptionMethod

EncryptionMethod describes the encryption algorithm applied to the cipher data. If the element is absent, the encryption algorithm must be known by the recipient or the decryption will fail.

It is defined as follows:

<complexType name='EncryptionMethodType' mixed='true'> <sequence> <element name='KeySize' minOccurs='0' type='xenc:KeySizeType'/> <element name='OAEPparams' minOccurs='0' type='base64Binary'/> <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/> </sequence> <attribute name='Algorithm' type='anyURI' use='required'/> </complexType>

Author:
Axl Mattheus

Method Summary
 void addEncryptionMethodInformation(org.w3c.dom.Element information)
          Adds encryption method information.
 java.lang.String getAlgorithm()
          Returns the algorithm applied to the cipher data.
 java.util.Iterator getEncryptionMethodInformation()
          Returns an iterator over all the additional elements contained in the EncryptionMethod.
 int getKeySize()
          Returns the key size of the key of the algorithm applied to the cipher data.
 byte[] getOAEPparams()
          Returns the OAEP parameters of the algorithm applied applied to the cipher data.
 void removeEncryptionMethodInformation(org.w3c.dom.Element information)
          Removes encryption method information.
 void setKeySize(int size)
          Sets the size of the key of the algorithm applied to the cipher data.
 void setOAEPparams(byte[] parameters)
          Sets the OAEP parameters.
 

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()
Returns the algorithm applied to the cipher data.

Returns:
the encryption algorithm.

getKeySize

public int getKeySize()
Returns the key size of the key of the algorithm applied to the cipher data.

Returns:
the key size.

setKeySize

public void setKeySize(int size)
Sets the size of the key of the algorithm applied to the cipher data.

Parameters:
size - the key size.

getOAEPparams

public byte[] getOAEPparams()
Returns the OAEP parameters of the algorithm applied applied to the cipher data.

Returns:
the OAEP parameters.

setOAEPparams

public void setOAEPparams(byte[] parameters)
Sets the OAEP parameters.

Parameters:
parameters - the OAEP parameters.

getEncryptionMethodInformation

public java.util.Iterator getEncryptionMethodInformation()
Returns an iterator over all the additional elements contained in the EncryptionMethod.

Returns:
an Iterator over all the additional infomation about the EncryptionMethod.

addEncryptionMethodInformation

public void addEncryptionMethodInformation(org.w3c.dom.Element information)
Adds encryption method information.

Parameters:
information - additional encryption method information.

removeEncryptionMethodInformation

public void removeEncryptionMethodInformation(org.w3c.dom.Element information)
Removes encryption method information.

Parameters:
information - the information to remove from the EncryptionMethod.