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
402
|
<!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: DSIGTransform 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>DSIGTransform Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGTransform_8hpp-source.html">DSIGTransform.hpp</a>></code>
<p>
Inheritance diagram for DSIGTransform:<p><center><img src="classDSIGTransform__inherit__graph.png" border="0" usemap="#DSIGTransform__inherit__map" alt="Inheritance graph"></center>
<map name="DSIGTransform__inherit__map">
<area href="classDSIGTransformBase64.html" shape="rect" coords="185,8,345,32" alt="">
<area href="classDSIGTransformC14n.html" shape="rect" coords="191,56,338,80" alt="">
<area href="classDSIGTransformEnvelope.html" shape="rect" coords="179,104,350,128" alt="">
<area href="classDSIGTransformXPath.html" shape="rect" coords="189,152,341,176" alt="">
<area href="classDSIGTransformXPathFilter.html" shape="rect" coords="174,200,355,224" alt="">
<area href="classDSIGTransformXSL.html" shape="rect" coords="194,248,335,272" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DSIGTransform:<p><center><img src="classDSIGTransform__coll__graph.png" border="0" usemap="#DSIGTransform__coll__map" alt="Collaboration graph"></center>
<map name="DSIGTransform__coll__map">
<area href="classXSECEnv.html" shape="rect" coords="184,281,266,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="8,190,189,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="85,9,168,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="176,99,293,123" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="213,190,349,214" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDSIGTransform-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The base class for transforms.
<p>
The DSIGTransform class is the base class used to hold <Transform> elements within a document.<p>
It does not in actually perform any transformations - only hold the information about a transform in a <Signature> structure.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTXFMBase.html">TXFMBase</a> </dd></dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Utility Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z56_0">createTransformNode</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the basic node structure of a transform. <a href="#z56_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z56_1">mp_txfmNode</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z56_2">mp_env</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z54_0">DSIGTransform</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contructor used for existing XML signatures. <a href="#z54_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z54_1">DSIGTransform</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contructor used for new signatures. <a href="#z54_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z54_2">~DSIGTransform</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z54_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="DSIGConstants_8hpp.html#a105">transformType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z55_0">getTransformType</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the transform type. <a href="#z55_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z55_1">appendTransformer</a> (<a class="el" href="classTXFMChain.html">TXFMChain</a> *input)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the transformer element and append to an existing Chain. <a href="#z55_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="classDSIGTransform.html#z55_2">createBlankTransform</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *parentDoc)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new transform. <a href="#z55_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransform.html#z55_3">load</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a DOM structure. <a href="#z55_3"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z54_0" doxytag="DSIGTransform::DSIGTransform"></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">DSIGTransform::DSIGTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname" nowrap> <em>env</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname" nowrap> <em>node</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Contructor used for existing XML signatures.
<p>
The Node structure already exists, so this type of Transform constructor will generally read the nodes in.<p>
<dl compact><dt><b>Note:</b></dt><dd>DSIGTransform structures should only ever be created via calls to a <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> object.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The environment in which this transform operates </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>The DOM node (within doc) that is to be used as the base of the Transform. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classDSIGTransform.html#z55_3">load</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z54_1" doxytag="DSIGTransform::DSIGTransform"></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">DSIGTransform::DSIGTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>env</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Contructor used for new signatures.
<p>
The Node structure will have to be created by the implementation class<p>
<dl compact><dt><b>Note:</b></dt><dd>DSIGTransform structures should only ever be created via calls to a <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> object.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The environment descriptor for the object </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z54_2" doxytag="DSIGTransform::~DSIGTransform"></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 DSIGTransform::~DSIGTransform </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>
Destructor.
<p>
Destroy the <a class="el" href="classDSIGSignature.html">DSIGSignature</a> elements.<p>
Does not destroy any associated DOM Nodes </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z55_1" doxytag="DSIGTransform::appendTransformer"></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 void DSIGTransform::appendTransformer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classTXFMChain.html">TXFMChain</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>input</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>
Create the transformer element and append to an existing Chain.
<p>
Implemented by each Transform class and used by the <a class="el" href="classDSIGSignature.html">DSIGSignature</a> to construct a complete Transform chain (<a class="el" href="classTXFMChain.html">TXFMChain</a>).
<p>
Implemented in <a class="el" href="classDSIGTransformBase64.html#z58_1">DSIGTransformBase64</a>, <a class="el" href="classDSIGTransformC14n.html#z60_1">DSIGTransformC14n</a>, <a class="el" href="classDSIGTransformEnvelope.html#z63_1">DSIGTransformEnvelope</a>, <a class="el" href="classDSIGTransformXPath.html#z67_1">DSIGTransformXPath</a>, <a class="el" href="classDSIGTransformXPathFilter.html#z70_1">DSIGTransformXPathFilter</a>, and <a class="el" href="classDSIGTransformXSL.html#z73_1">DSIGTransformXSL</a>. </td>
</tr>
</table>
<a class="anchor" name="z55_2" doxytag="DSIGTransform::createBlankTransform"></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* DSIGTransform::createBlankTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * </td>
<td class="mdname1" valign="top" nowrap> <em>parentDoc</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>
Construct a new transform.
<p>
Instruct the implementation to create the required transform and return the newly constructed DOMNode structure
<p>
Implemented in <a class="el" href="classDSIGTransformBase64.html#z58_2">DSIGTransformBase64</a>, <a class="el" href="classDSIGTransformC14n.html#z60_2">DSIGTransformC14n</a>, <a class="el" href="classDSIGTransformEnvelope.html#z63_2">DSIGTransformEnvelope</a>, <a class="el" href="classDSIGTransformXPath.html#z67_2">DSIGTransformXPath</a>, <a class="el" href="classDSIGTransformXPathFilter.html#z70_2">DSIGTransformXPathFilter</a>, and <a class="el" href="classDSIGTransformXSL.html#z73_2">DSIGTransformXSL</a>. </td>
</tr>
</table>
<a class="anchor" name="z56_0" doxytag="DSIGTransform::createTransformNode"></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">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGTransform::createTransformNode </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> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create the basic node structure of a transform.
<p>
</td>
</tr>
</table>
<a class="anchor" name="z55_0" doxytag="DSIGTransform::getTransformType"></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="DSIGConstants_8hpp.html#a105">transformType</a> DSIGTransform::getTransformType </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>
Determine the transform type.
<p>
Used to determine what the type of the transform is.
<p>
Implemented in <a class="el" href="classDSIGTransformBase64.html#z58_0">DSIGTransformBase64</a>, <a class="el" href="classDSIGTransformC14n.html#z60_0">DSIGTransformC14n</a>, <a class="el" href="classDSIGTransformEnvelope.html#z63_0">DSIGTransformEnvelope</a>, <a class="el" href="classDSIGTransformXPath.html#z67_0">DSIGTransformXPath</a>, <a class="el" href="classDSIGTransformXPathFilter.html#z70_0">DSIGTransformXPathFilter</a>, and <a class="el" href="classDSIGTransformXSL.html#z73_0">DSIGTransformXSL</a>. </td>
</tr>
</table>
<a class="anchor" name="z55_3" doxytag="DSIGTransform::load"></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 void DSIGTransform::load </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>
Load a DOM structure.
<p>
Take the original node and load any sub nodes in the transform (if necessary)
<p>
Implemented in <a class="el" href="classDSIGTransformBase64.html#z58_3">DSIGTransformBase64</a>, <a class="el" href="classDSIGTransformC14n.html#z60_3">DSIGTransformC14n</a>, <a class="el" href="classDSIGTransformEnvelope.html#z63_3">DSIGTransformEnvelope</a>, <a class="el" href="classDSIGTransformXPath.html#z67_3">DSIGTransformXPath</a>, <a class="el" href="classDSIGTransformXPathFilter.html#z70_3">DSIGTransformXPathFilter</a>, and <a class="el" href="classDSIGTransformXSL.html#z73_3">DSIGTransformXSL</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z56_2" doxytag="DSIGTransform::mp_env"></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">const <a class="el" href="classXSECEnv.html">XSECEnv</a>* <a class="el" href="classDSIGTransform.html#z56_2">DSIGTransform::mp_env</a><code> [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="z56_1" doxytag="DSIGTransform::mp_txfmNode"></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">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* <a class="el" href="classDSIGTransform.html#z56_1">DSIGTransform::mp_txfmNode</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGTransform_8hpp-source.html">DSIGTransform.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:25 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>
|
