1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XENCCipherReference Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>XENCCipherReference Class Reference<br>
<small>
[<a class="el" href="group__xenc.html">XML Encryption Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XENCCipherReference_8hpp-source.html">XENCCipherReference.hpp</a>></code>
<p>
<a href="classXENCCipherReference-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the CipherReference object.
<p>
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.<p>
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,<p>
The schema for CipherReference is as follows:<p>
<div class="fragment"><pre class="fragment"> <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>
</pre></div>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Constructors and Destructors</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z241_0">~XENCCipherReference</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z241_1">XENCCipherReference</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z242_0">getTransforms</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the transforms for this CipherReference. <a href="#z242_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z242_1">getURI</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the URI for this CipherReference. <a href="#z242_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z242_2">getElement</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the DOM Node of this structure. <a href="#z242_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Set Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformBase64.html">DSIGTransformBase64</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z243_0">appendBase64Transform</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a Base64 Transform to the Reference. <a href="#z243_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z243_1">appendXPathTransform</a> (const char *expr)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XPath Transform to the Reference. <a href="#z243_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z243_2">appendXPathFilterTransform</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XPath-Filter2 Transform to the Reference. <a href="#z243_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformXSL.html">DSIGTransformXSL</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z243_3">appendXSLTransform</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *stylesheet)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XSLT Transform to the Reference. <a href="#z243_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGTransformC14n.html">DSIGTransformC14n</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherReference.html#z243_4">appendCanonicalizationTransform</a> (<a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a Canonicalization Transform to the Reference. <a href="#z243_4"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z241_1" doxytag="XENCCipherReference::XENCCipherReference"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XENCCipherReference::XENCCipherReference </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z241_0" doxytag="XENCCipherReference::~XENCCipherReference"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XENCCipherReference::~XENCCipherReference </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z243_0" doxytag="XENCCipherReference::appendBase64Transform"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformBase64.html">DSIGTransformBase64</a>* XENCCipherReference::appendBase64Transform </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a Base64 Transform to the Reference.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created Base64 transform. </dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>Move to <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> rather than re-implement in both <a class="el" href="classDSIGReference.html">DSIGReference</a> and XENCCipherReference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z243_4" doxytag="XENCCipherReference::appendCanonicalizationTransform"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformC14n.html">DSIGTransformC14n</a>* XENCCipherReference::appendCanonicalizationTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> </td>
<td class="mdname1" valign="top" nowrap> <em>cm</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a Canonicalization Transform to the Reference.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cm</em> </td><td>The type of canonicalisation to be added. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly create canonicalisation transform </dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000013">Todo:</a></b></dt><dd>Move to <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> rather than re-implement in both <a class="el" href="classDSIGReference.html">DSIGReference</a> and XENCCipherReference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z243_2" doxytag="XENCCipherReference::appendXPathFilterTransform"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a>* XENCCipherReference::appendXPathFilterTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XPath-Filter2 Transform to the Reference.
<p>
The returned <a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a> will have no actual filter expressions loaded, but calls can be made to DSIGTransformXPathFilter::appendTransform to add them.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created XPath Filter transform </dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>Move to <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> rather than re-implement in both <a class="el" href="classDSIGReference.html">DSIGReference</a> and XENCCipherReference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z243_1" doxytag="XENCCipherReference::appendXPathTransform"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a>* XENCCipherReference::appendXPathTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>expr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XPath Transform to the Reference.
<p>
Append an XPath transform. Namespaces can be added to the transform directly using the returned <em><a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a></em> structure<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>The XPath expression to be placed in the transform. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created XPath transform </dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>Move to <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> rather than re-implement in both <a class="el" href="classDSIGReference.html">DSIGReference</a> and XENCCipherReference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z243_3" doxytag="XENCCipherReference::appendXSLTransform"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformXSL.html">DSIGTransformXSL</a>* XENCCipherReference::appendXSLTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>stylesheet</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XSLT Transform to the Reference.
<p>
The caller must have already create the stylesheet and turned it into a DOM structure that is passed in as the stylesheet parameter.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stylesheet</em> </td><td>The stylesheet DOM structure to be placed in the reference. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly create XSLT transform </dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000012">Todo:</a></b></dt><dd>Move to <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> rather than re-implement in both <a class="el" href="classDSIGReference.html">DSIGReference</a> and XENCCipherReference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z242_2" doxytag="XENCCipherReference::getElement"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XENCCipherReference::getElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the DOM Node of this structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the DOM Node representing the <CipherValue> element </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z242_0" doxytag="XENCCipherReference::getTransforms"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a>* XENCCipherReference::getTransforms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Obtain the transforms for this CipherReference.
<p>
Get the <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> object for this CipherReference. Can be used to obtain information about the transforms and also change the the transforms </td>
</tr>
</table>
<a class="anchor" name="z242_1" doxytag="XENCCipherReference::getURI"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const XMLCh* XENCCipherReference::getURI </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Obtain the URI for this CipherReference.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the URI string for this CipherReference </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XENCCipherReference_8hpp-source.html">XENCCipherReference.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:43:52 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|