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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
<!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: DSIGObject 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>DSIGObject Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGObject_8hpp-source.html">DSIGObject.hpp</a>></code>
<p>
Collaboration diagram for DSIGObject:<p><center><img src="classDSIGObject__coll__graph.png" border="0" usemap="#DSIGObject__coll__map" alt="Collaboration graph"></center>
<map name="DSIGObject__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="classDSIGObject-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for <Object> nodes in a <Signature> element.
<p>
The DSIG spec allows for enveloping signatures, in which the signature holds the information it is signing. For these types of signatures, the data being signed can be held in an <Object> container.<p>
This class allows callers to and manipulate Object containers.
<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="classDSIGObject.html#z31_0">DSIGObject</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *dom)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct from an owning signature. <a href="#z31_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z31_1">DSIGObject</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new object. <a href="#z31_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z31_2">~DSIGObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z31_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Library functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z32_0">load</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the object from DOM. <a href="#z32_0"></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="classDSIGObject.html#z32_1">createBlankObject</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Object. <a href="#z32_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z33_0">getId</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Id for this object. <a href="#z33_0"></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="classDSIGObject.html#z33_1">getMimeType</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the MimeType string of this object. <a href="#z33_1"></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="classDSIGObject.html#z33_2">getEncoding</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Encoding string of this object. <a href="#z33_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z33_3">getElement</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Element node for this object. <a href="#z33_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z34_0">setId</a> (const XMLCh *id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Id attribute for this Object. <a href="#z34_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z34_1">setMimeType</a> (const XMLCh *type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Id attribute for this Object. <a href="#z34_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z34_2">setEncoding</a> (const XMLCh *encoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Encoding attribute for this Object. <a href="#z34_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGObject.html#z34_3">appendChild</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *child)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a child node to the Object. <a href="#z34_3"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z31_0" doxytag="DSIGObject::DSIGObject"></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">DSIGObject::DSIGObject </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>dom</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>
Construct from an owning signature.
<p>
Called by the library when an Object needs to be created from an Object in a DOM 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 environment that the Object is operating within </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dom</em> </td><td>The DOM node that will be loaded </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z31_1" doxytag="DSIGObject::DSIGObject"></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">DSIGObject::DSIGObject </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>
Construct a new object.
<p>
Called by the library to create an Object from scratch<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 environment the Object is operating within </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z31_2" doxytag="DSIGObject::~DSIGObject"></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">DSIGObject::~DSIGObject </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>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z34_3" doxytag="DSIGObject::appendChild"></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 DSIGObject::appendChild </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>child</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>
Add a child node to the Object.
<p>
This is a "ease of use" function to allow users to add a DOM structure that has been built previously into the Object element </td>
</tr>
</table>
<a class="anchor" name="z32_1" doxytag="DSIGObject::createBlankObject"></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* DSIGObject::createBlankObject </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>
Create a new Object.
<p>
Create a new Object from scratch (will generate the DOM) </td>
</tr>
</table>
<a class="anchor" name="z33_3" doxytag="DSIGObject::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">const XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGObject::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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the Element node for this object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the Element node at the head of this object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z33_2" doxytag="DSIGObject::getEncoding"></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* DSIGObject::getEncoding </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>
Returns the Encoding string of this object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the buffer containing the Encoding string </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z33_0" doxytag="DSIGObject::getId"></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* DSIGObject::getId </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 Id for this object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the URI attribute string for this object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z33_1" doxytag="DSIGObject::getMimeType"></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* DSIGObject::getMimeType </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>
Returns the MimeType string of this object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the buffer containing the Mime Type string </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z32_0" doxytag="DSIGObject::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 DSIGObject::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>
Load the object from DOM.
<p>
Called by the library to load a constructed object </td>
</tr>
</table>
<a class="anchor" name="z34_2" doxytag="DSIGObject::setEncoding"></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 DSIGObject::setEncoding </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>encoding</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>
Set the Encoding attribute for this Object.
<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>encoding</em> </td><td>String to use for the Encoding attribute </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z34_0" doxytag="DSIGObject::setId"></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 DSIGObject::setId </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>id</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>
Set the Id attribute for this Object.
<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>id</em> </td><td>String to use for the Id attribute </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z34_1" doxytag="DSIGObject::setMimeType"></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 DSIGObject::setMimeType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>type</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>
Set the Id attribute for this Object.
<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>type</em> </td><td>String to use for the MimeType attribute </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGObject_8hpp-source.html">DSIGObject.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:15 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>
|
