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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
<!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: DSIGXPathFilterExpr 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>DSIGXPathFilterExpr Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGXPathFilterExpr_8hpp-source.html">DSIGXPathFilterExpr.hpp</a>></code>
<p>
Collaboration diagram for DSIGXPathFilterExpr:<p><center><img src="classDSIGXPathFilterExpr__coll__graph.png" border="0" usemap="#DSIGXPathFilterExpr__coll__map" alt="Collaboration graph"></center>
<map name="DSIGXPathFilterExpr__coll__map">
<area href="classsafeBuffer.html" shape="rect" coords="51,9,134,33" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="101,190,282,214" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="191,99,309,123" alt="">
<area href="classXSECEnv.html" shape="rect" coords="150,281,233,305" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="306,190,442,214" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDSIGXPathFilterExpr-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Class used to hold (and manipulate) individual expressions in an XPathFilter transform.
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTXFMXPathFilter.html">TXFMXPathFilter</a> <p>
DSIGTransformXpathFilter </dd></dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="classDSIGXPathFilterExpr.html#z75_0">DSIGXPathFilterExpr</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">Constructor used for existing XML signatures. <a href="#z75_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z75_1">DSIGXPathFilterExpr</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Builder constructor. <a href="#z75_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z75_2">~DSIGXPathFilterExpr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z75_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Set and get Information</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_0">load</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read in existing structure. <a href="#z76_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="DSIGConstants_8hpp.html#a106">xpathFilterType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_1">getFilterType</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the filter type. <a href="#z76_1"></a><br></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="classDSIGXPathFilterExpr.html#z76_2">setFilter</a> (<a class="el" href="DSIGConstants_8hpp.html#a106">xpathFilterType</a> filterType, const XMLCh *filterExpr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create from blank <a href="#z76_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_3">getFilter</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the filter expression. <a href="#z76_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_4">setNamespace</a> (const XMLCh *prefix, const XMLCh *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new namespace to the list to be used. <a href="#z76_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNamedNodeMap * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_5">getNamespaces</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the list of namespaces. <a href="#z76_5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#z76_6">deleteNamespace</a> (const XMLCh *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a namespace to the list to be used. <a href="#z76_6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGXPathFilterExpr.html#n0">TXFMXPathFilter</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z75_0" doxytag="DSIGXPathFilterExpr::DSIGXPathFilterExpr"></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">DSIGXPathFilterExpr::DSIGXPathFilterExpr </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"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor used for existing XML signatures.
<p>
Node already exists and is part of an existing XPathFilter tree<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>env</em> </td><td>The operating environment </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>The node that will be used to read the expression in </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z75_1" doxytag="DSIGXPathFilterExpr::DSIGXPathFilterExpr"></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">DSIGXPathFilterExpr::DSIGXPathFilterExpr </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Builder constructor.
<p>
Used to create the DOM structure and <a class="el" href="classDSIGSignature.html">DSIGSignature</a> elements<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>env</em> </td><td>The operating Environment </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z75_2" doxytag="DSIGXPathFilterExpr::~DSIGXPathFilterExpr"></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">DSIGXPathFilterExpr::~DSIGXPathFilterExpr </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></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="z76_6" doxytag="DSIGXPathFilterExpr::deleteNamespace"></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">void DSIGXPathFilterExpr::deleteNamespace </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>prefix</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Delete a namespace to the list to be used.
<p>
Delete a namespace from the XPath Element.<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>prefix</em> </td><td>NCName of the Namespace to delete </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXSECException.html">XSECException</a></em> </td><td>if the NCName does not exist </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z76_3" doxytag="DSIGXPathFilterExpr::getFilter"></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 XMLCh* DSIGXPathFilterExpr::getFilter </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the filter expression.
<p>
Returns an XMLCh string containing the filter expression<p>
<dl compact><dt><b>Returns:</b></dt><dd>The filter expression </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z76_1" doxytag="DSIGXPathFilterExpr::getFilterType"></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"><a class="el" href="DSIGConstants_8hpp.html#a106">xpathFilterType</a> DSIGXPathFilterExpr::getFilterType </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the filter type.
<p>
Returns the type of this particular XPath filter<p>
<dl compact><dt><b>Returns:</b></dt><dd>The filter type of this expression </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z76_5" doxytag="DSIGXPathFilterExpr::getNamespaces"></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 DOMNamedNodeMap* DSIGXPathFilterExpr::getNamespaces </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the list of namespaces.
<p>
Returns the DOMNamedNodeMap of the attributes of the XPath transform node.<p>
<dl compact><dt><b>Note:</b></dt><dd>This will also contain the Filter attribute</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the NamedNodeMap </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z76_0" doxytag="DSIGXPathFilterExpr::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">void DSIGXPathFilterExpr::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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Read in existing structure.
<p>
Reads DOM structure of the XPath expression </td>
</tr>
</table>
<a class="anchor" name="z76_2" doxytag="DSIGXPathFilterExpr::setFilter"></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* DSIGXPathFilterExpr::setFilter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="DSIGConstants_8hpp.html#a106">xpathFilterType</a> </td>
<td class="mdname" nowrap> <em>filterType</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>filterExpr</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
create from blank
<p>
Given the filter type and XPath expression, setup the DOMNodes and variables to allow signing and validation<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>filterType</em> </td><td>Type of this filter to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filterExpr</em> </td><td>The XPath expression </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z76_4" doxytag="DSIGXPathFilterExpr::setNamespace"></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">void DSIGXPathFilterExpr::setNamespace </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>prefix</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a new namespace to the list to be used.
<p>
Add a new namespace to the XPath Element.<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>prefix</em> </td><td>NCName of the Namespace to set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The string with the URI to set </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="n0" doxytag="DSIGXPathFilterExpr::TXFMXPathFilter"></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">friend class <a class="el" href="classTXFMXPathFilter.html">TXFMXPathFilter</a><code> [friend]</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="DSIGXPathFilterExpr_8hpp-source.html">DSIGXPathFilterExpr.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:50 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>
|
