Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

XENCCipherData Class Reference
[XML Encryption Implementation]

#include <XENCCipherData.hpp>

List of all members.


Detailed Description

Interface definition for the CipherData object.

The <CipherData> element either holds the encrypted data (via a CipherValue element) or a reference to the encrypted data.

Within the library, the CipherData element can only be used to hold and read the encrypted data. To actually decrypt/encrypt data, an XENCEncryptedType derivative object of XENCCipher object should be used.

The schema for CipherData is as follows:

<element name='CipherData' type='xenc:CipherDataType'/>
  <complexType name='CipherDataType'>
     <choice>
       <element name='CipherValue' type='base64Binary'/>
       <element ref='xenc:CipherReference'/>
     </choice>
   </complexType>


Constructors and Destructors

virtual ~XENCCipherData ()
 XENCCipherData ()

Public Types

enum  XENCCipherDataType {
  NO_TYPE = 0,
  VALUE_TYPE = 1,
  REFERENCE_TYPE = 2
}

Public Member Functions

Get Interface Methods
virtual XENCCipherDataType getCipherDataType (void)=0
 Find the type of Cipher Data held.
virtual XENCCipherValuegetCipherValue (void)=0
 Get the CipherValue element.
virtual XENCCipherReferencegetCipherReference (void)=0
 Get the CipherReference element.
virtual XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
getElement (void)=0
 Get the DOM Node of this structure.


Member Enumeration Documentation

enum XENCCipherData::XENCCipherDataType
 

CipherDataType

Enumeration values:
NO_TYPE 
VALUE_TYPE  Not Set
REFERENCE_TYPE 


Constructor & Destructor Documentation

XENCCipherData::XENCCipherData  )  [inline, protected]
 

virtual XENCCipherData::~XENCCipherData  )  [inline, virtual]
 


Member Function Documentation

virtual XENCCipherDataType XENCCipherData::getCipherDataType void   )  [pure virtual]
 

Find the type of Cipher Data held.

CipherData elements can hold either a CipherValue element (whose text is the encrypted data) or a CipherReference element, where the contents tell the library how to retrieve the encrypted data from elsewhere.

Returns:
The type of CipherData

virtual XENCCipherReference* XENCCipherData::getCipherReference void   )  [pure virtual]
 

Get the CipherReference element.

Returns:
the CipherReference element, or NULL if one is not held

virtual XENCCipherValue* XENCCipherData::getCipherValue void   )  [pure virtual]
 

Get the CipherValue element.

Returns:
the CipherValue element, or NULL if one is not held

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XENCCipherData::getElement void   )  [pure virtual]
 

Get the DOM Node of this structure.

Returns:
the DOM Node representing the <CipherData> element


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:43:52 2005 for XML-Security-C by  doxygen 1.4.2