Interface EncryptionMethod
-
- All Known Implementing Classes:
XMLCipher.Factory.EncryptionMethodImpl
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:
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addEncryptionMethodInformation(org.w3c.dom.Element information)
Adds encryption method information.java.lang.String
getAlgorithm()
Returns the algorithm applied to the cipher data.java.lang.String
getDigestAlgorithm()
Get the Digest Algorithm to usejava.util.Iterator<org.w3c.dom.Element>
getEncryptionMethodInformation()
Returns an iterator over all the additional elements contained in theEncryptionMethod
.int
getKeySize()
Returns the key size of the key of the algorithm applied to the cipher data.java.lang.String
getMGFAlgorithm()
Get the MGF Algorithm to usebyte[]
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
setDigestAlgorithm(java.lang.String digestAlgorithm)
Set the Digest Algorithm to usevoid
setKeySize(int size)
Sets the size of the key of the algorithm applied to the cipher data.void
setMGFAlgorithm(java.lang.String mgfAlgorithm)
Set the MGF Algorithm to usevoid
setOAEPparams(byte[] parameters)
Sets the OAEP parameters.
-
-
-
Method Detail
-
getAlgorithm
java.lang.String getAlgorithm()
Returns the algorithm applied to the cipher data.- Returns:
- the encryption algorithm.
-
getKeySize
int getKeySize()
Returns the key size of the key of the algorithm applied to the cipher data.- Returns:
- the key size.
-
setKeySize
void setKeySize(int size)
Sets the size of the key of the algorithm applied to the cipher data.- Parameters:
size
- the key size.
-
getOAEPparams
byte[] getOAEPparams()
Returns the OAEP parameters of the algorithm applied applied to the cipher data.- Returns:
- the OAEP parameters.
-
setOAEPparams
void setOAEPparams(byte[] parameters)
Sets the OAEP parameters.- Parameters:
parameters
- the OAEP parameters.
-
setDigestAlgorithm
void setDigestAlgorithm(java.lang.String digestAlgorithm)
Set the Digest Algorithm to use- Parameters:
digestAlgorithm
- the Digest Algorithm to use
-
getDigestAlgorithm
java.lang.String getDigestAlgorithm()
Get the Digest Algorithm to use- Returns:
- the Digest Algorithm to use
-
setMGFAlgorithm
void setMGFAlgorithm(java.lang.String mgfAlgorithm)
Set the MGF Algorithm to use- Parameters:
mgfAlgorithm
- the MGF Algorithm to use
-
getMGFAlgorithm
java.lang.String getMGFAlgorithm()
Get the MGF Algorithm to use- Returns:
- the MGF Algorithm to use
-
getEncryptionMethodInformation
java.util.Iterator<org.w3c.dom.Element> getEncryptionMethodInformation()
Returns an iterator over all the additional elements contained in theEncryptionMethod
.- Returns:
- an
Iterator
over all the additional information about theEncryptionMethod
.
-
addEncryptionMethodInformation
void addEncryptionMethodInformation(org.w3c.dom.Element information)
Adds encryption method information.- Parameters:
information
- additional encryption method information.
-
removeEncryptionMethodInformation
void removeEncryptionMethodInformation(org.w3c.dom.Element information)
Removes encryption method information.- Parameters:
information
- the information to remove from theEncryptionMethod
.
-
-