XENCEncryptionMethod Class Reference
[XML Encryption Implementation]

#include <XENCEncryptionMethod.hpp>

List of all members.

---

Detailed Description

Interface definition for the EncryptionMethod object.

The <EncryptionMethod> element holds information about the encryption algorithm being used.

This element is optional within an EncryptedType derivative, but applications not making use of this need to know the this information, otherwise the library will not be able to decrypt the data.

It is defined as :

  <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>
  

Public Member Functions
	XENCEncryptionMethod ()
virtual	~XENCEncryptionMethod ()
Getter Methods
virtual const XMLCh *	getAlgorithm (void) const =0
	Get the algorithm.
virtual const XMLCh *	getDigestMethod (void) const =0
	Get the digest method URI.
virtual const XMLCh *	getOAEPparams (void) const =0
	Get the value of the OAEPparams string.
virtual int	getKeySize (void) const =0
	Get the KeySize that was set in this EncryptionMethod.
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	getElement (void) const =0
	Get the DOM Element Node of this structure.
Setter Methods
virtual void	setDigestMethod (const XMLCh *method)=0
	Set the value of the DigestMethod.
virtual void	setOAEPparams (const XMLCh *params)=0
	Set the value of the OAEPparams string.
virtual void	setKeySize (int size)=0
	Set the KeySize that in this EncryptionMethod.

---

Constructor & Destructor Documentation

XENCEncryptionMethod::XENCEncryptionMethod (   )  [inline]

virtual XENCEncryptionMethod::~XENCEncryptionMethod (   )  [inline, virtual]

---

Member Function Documentation

virtual const XMLCh* XENCEncryptionMethod::getAlgorithm (  void   )  const [pure virtual]

Get the algorithm. Return the Algorithm URI representing the encryption type for this encrypted data Returns: the URI representing the algorithm

virtual const XMLCh* XENCEncryptionMethod::getDigestMethod (  void   )  const [pure virtual]

Get the digest method URI. Return the Algorithm URI represtenting the Digest Method for those encryption algorithms that require it (such as RSA with OAEP padding) Returns: the URI representing the digest method algorithm

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XENCEncryptionMethod::getElement (  void   )  const [pure virtual]

Get the DOM Element Node of this structure. Returns: the DOM Element Node representing the <EncryptionMethod> element

virtual int XENCEncryptionMethod::getKeySize (  void   )  const [pure virtual]

Get the KeySize that was set in this EncryptionMethod. This field would not normally be used for the encryption algorithms explicitly referenced in the XML Encryption standard. It is provided mainly for stream ciphers that have a variable key length

virtual const XMLCh* XENCEncryptionMethod::getOAEPparams (  void   )  const [pure virtual]

Get the value of the OAEPparams string. The OAEP RSA padding method allows a user to set an optional params string (that will be used as input to the Digest algorithm). Returns: The string (base64 encoded value) representing the OAEP params

virtual void XENCEncryptionMethod::setDigestMethod (  const XMLCh *  method  )  [pure virtual]

Set the value of the DigestMethod. Sets the DigestMethod element's Algorithm attribute to the passed in value - should be a URI string Parameters: method  String to set in the Algorithm attribute. Will create a <DigestMethod> element if one does not already exist

virtual void XENCEncryptionMethod::setKeySize (  int  size  )  [pure virtual]

Set the KeySize that in this EncryptionMethod. This field would not normally be used for the encryption algorithms explicitly referenced in the XML Encryption standard. It is provided mainly for stream ciphers that have a variable key length

virtual void XENCEncryptionMethod::setOAEPparams (  const XMLCh *  params  )  [pure virtual]

Set the value of the OAEPparams string. Sets the OAEPparams element's Text node child to the passed in value - should be a base64 encoded value Parameters: params  String to set in the OAEPparams text node. Will create a <OAEPparams> element if one does not already exist

---

The documentation for this class was generated from the following file:

• XENCEncryptionMethod.hpp

---