XENCCipherReference Class Reference
[XML Encryption Implementation]

#include <XENCCipherReference.hpp>

List of all members.

---

Detailed Description

Interface definition for the CipherReference object.

The <CipherReference> element provides the information necessary for an application to find the data being referenced. Like a Reference in XML-DSIG, the CipherReference starts with a URI that provides the base location of the data in question.

A list of transforms may then be provided, which the library will apply to the data found at the provided URI. It is expected that the result of these transforms will be the raw encrypted octets,

The schema for CipherReference is as follows:

  <element name='CipherReference' type='xenc:CipherReferenceType'/>
   <complexType name='CipherReferenceType'>
       <sequence>
         <element name='Transforms' type='xenc:TransformsType' minOccurs='0'/>
       </sequence>
       <attribute name='URI' type='anyURI' use='required'/>
   </complexType>

    <complexType name='TransformsType'>
       <sequence>
         <element ref='ds:Transform' maxOccurs='unbounded'/> 
       </sequence>
     </complexType>

Constructors and Destructors
virtual	~XENCCipherReference ()
	XENCCipherReference ()
Public Member Functions
Get Interface Methods
virtual DSIGTransformList *	getTransforms (void) const =0
	Obtain the transforms for this CipherReference.
virtual const XMLCh *	getURI (void) const =0
	Obtain the URI for this CipherReference.
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	getElement (void) const =0
	Get the DOM Node of this structure.
Set Interface Methods
virtual DSIGTransformBase64 *	appendBase64Transform ()=0
	Append a Base64 Transform to the Reference.
virtual DSIGTransformXPath *	appendXPathTransform (const char *expr)=0
	Append an XPath Transform to the Reference.
virtual DSIGTransformXPathFilter *	appendXPathFilterTransform (void)=0
	Append an XPath-Filter2 Transform to the Reference.
virtual DSIGTransformXSL *	appendXSLTransform (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *stylesheet)=0
	Append an XSLT Transform to the Reference.
virtual DSIGTransformC14n *	appendCanonicalizationTransform (canonicalizationMethod cm)=0
	Append a Canonicalization Transform to the Reference.

---

Constructor & Destructor Documentation

XENCCipherReference::XENCCipherReference (   )  [inline, protected]

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

---

Member Function Documentation

virtual DSIGTransformBase64* XENCCipherReference::appendBase64Transform (   )  [pure virtual]

Append a Base64 Transform to the Reference. Returns: The newly created Base64 transform. Todo: Move to DSIGTransformList rather than re-implement in both DSIGReference and XENCCipherReference

virtual DSIGTransformC14n* XENCCipherReference::appendCanonicalizationTransform (  canonicalizationMethod  cm  )  [pure virtual]

Append a Canonicalization Transform to the Reference. Parameters: cm  The type of canonicalisation to be added. Returns: The newly create canonicalisation transform Todo: Move to DSIGTransformList rather than re-implement in both DSIGReference and XENCCipherReference

virtual DSIGTransformXPathFilter* XENCCipherReference::appendXPathFilterTransform (  void   )  [pure virtual]

Append an XPath-Filter2 Transform to the Reference. The returned DSIGTransformXPathFilter will have no actual filter expressions loaded, but calls can be made to DSIGTransformXPathFilter::appendTransform to add them. Returns: The newly created XPath Filter transform Todo: Move to DSIGTransformList rather than re-implement in both DSIGReference and XENCCipherReference

virtual DSIGTransformXPath* XENCCipherReference::appendXPathTransform (  const char *  expr  )  [pure virtual]

Append an XPath Transform to the Reference. Append an XPath transform. Namespaces can be added to the transform directly using the returned DSIGTransformXPath structure Parameters: expr  The XPath expression to be placed in the transform. Returns: The newly created XPath transform Todo: Move to DSIGTransformList rather than re-implement in both DSIGReference and XENCCipherReference

virtual DSIGTransformXSL* XENCCipherReference::appendXSLTransform (  XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  stylesheet  )  [pure virtual]

Append an XSLT Transform to the Reference. The caller must have already create the stylesheet and turned it into a DOM structure that is passed in as the stylesheet parameter. Parameters: stylesheet  The stylesheet DOM structure to be placed in the reference. Returns: The newly create XSLT transform Todo: Move to DSIGTransformList rather than re-implement in both DSIGReference and XENCCipherReference

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

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

virtual DSIGTransformList* XENCCipherReference::getTransforms (  void   )  const [pure virtual]

Obtain the transforms for this CipherReference. Get the DSIGTransformList object for this CipherReference. Can be used to obtain information about the transforms and also change the the transforms

virtual const XMLCh* XENCCipherReference::getURI (  void   )  const [pure virtual]

Obtain the URI for this CipherReference. Returns: A pointer to the URI string for this CipherReference

---

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

• XENCCipherReference.hpp

---