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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
|
<!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: XKMSMessageAbstractType 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>XKMSMessageAbstractType Class Reference<br>
<small>
[<a class="el" href="group__xkms.html">XML Key Management System Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XKMSMessageAbstractType_8hpp-source.html">XKMSMessageAbstractType.hpp</a>></code>
<p>
Inheritance diagram for XKMSMessageAbstractType:<p><center><img src="classXKMSMessageAbstractType__inherit__graph.png" border="0" usemap="#XKMSMessageAbstractType__inherit__map" alt="Inheritance graph"></center>
<map name="XKMSMessageAbstractType__inherit__map">
<area href="classXKMSRequestAbstractType.html" shape="rect" coords="7,83,197,107" alt="">
<area href="classXKMSResultType.html" shape="rect" coords="221,83,349,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXKMSMessageAbstractType-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the MessageAbstractType.
<p>
The <MessageAbstractType> is an abstract type on which all other XKMS messages are built. All request/response messages have : <ul>
<li>
<b>Id</b> The unique ID of this message </li>
<li>
<b>Service</b> The URI of the service for which this message is destined or comes from. </li>
<li>
<b>Nonce</b> (Optional) Random data used to defend against replay attacks. </li>
</ul>
<p>
In addition, such messages may have :<p>
<ul>
<li>
<b>Signature</b> Validating authenticity of this message </li>
<li>
<b>MessageExtension</b> Used for extensibility </li>
<li>
<b>OpaqueClientData</b> Used for application specific info </li>
</ul>
<p>
The schema definition for MessageAbstractType is as follows :<p>
<div class="fragment"><pre class="fragment"> <!-- MessageAbstractType -->
<complexType name="MessageAbstractType" abstract="true">
<sequence>
<element ref="ds:Signature" minOccurs="0"/>
<element ref="xkms:MessageExtension" minOccurs="0"
maxOccurs="unbounded"/>
<element ref="xkms:OpaqueClientData" minOccurs="0"/>
</sequence>
<attribute name="Id" type="ID" use="required"/>
<attribute name="Service" type="anyURI" use="required"/>
<attribute name="Nonce" type="base64Binary" use="optional"/>
</complexType>
<!-- /MessageAbstractType -->
</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">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z281_0">messageType</a> { <br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w0">None</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w1">CompoundRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w2">CompoundResult</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w3">LocateRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w4">LocateResult</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w5">ValidateRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w6">ValidateResult</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w7">PendingRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w8">StatusRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w9">StatusResult</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w10">Result</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w11">RegisterRequest</a>,
<br>
<a class="el" href="classXKMSMessageAbstractType.html#z281_0w12">RegisterResult</a>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z281_1">~XKMSMessageAbstractType</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z281_2">XKMSMessageAbstractType</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Message Manipulation Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSMessageAbstractType.html#z281_0">messageType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z282_0">getMessageType</a> (void)=0</td></tr>
<tr><td colspan="2"><div class="groupHeader">Getter Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z283_0">isSigned</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find out whether this is a signed Message. <a href="#z283_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGSignature.html">DSIGSignature</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z283_1">getSignature</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the Signature information (if any is attached). <a href="#z283_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="classXKMSMessageAbstractType.html#z283_2">getElement</a> (void) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z283_3">getId</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Id for the Message. <a href="#z283_3"></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="classXKMSMessageAbstractType.html#z283_4">getService</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Service identifier for this message. <a href="#z283_4"></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="classXKMSMessageAbstractType.html#z283_5">getNonce</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Nonce of the message. <a href="#z283_5"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter interface methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z284_0">setId</a> (const XMLCh *id)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Id URI for the Message. <a href="#z284_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="classXKMSMessageAbstractType.html#z284_1">setService</a> (const XMLCh *service)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Service for the Message. <a href="#z284_1"></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="classXKMSMessageAbstractType.html#z284_2">setNonce</a> (const XMLCh *uri)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Nonce value. <a href="#z284_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGSignature.html">DSIGSignature</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z284_3">addSignature</a> (<a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm=CANON_C14N_NOC, <a class="el" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> sm=SIGNATURE_DSA, <a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> hm=HASH_SHA1)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a signature to the message. <a href="#z284_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Opaque client data handling</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z285_0">getOpaqueClientDataSize</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the number of <OpaqueData> elements. <a href="#z285_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="classXKMSMessageAbstractType.html#z285_1">getOpaqueClientDataItemStr</a> (int item)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSMessageAbstractType.html#z285_2">appendOpaqueClientDataItem</a> (const XMLCh *item)=0</td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="z281_0" doxytag="XKMSMessageAbstractType::messageType"></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">enum <a class="el" href="classXKMSMessageAbstractType.html#z281_0">XKMSMessageAbstractType::messageType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="z281_0w0" doxytag="None"></a>None</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w1" doxytag="CompoundRequest"></a>CompoundRequest</em> </td><td>
A default value that indicates something hasn't been set </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w2" doxytag="CompoundResult"></a>CompoundResult</em> </td><td>
A CompoundRequest message - holding multiple requests </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w3" doxytag="LocateRequest"></a>LocateRequest</em> </td><td>
A CompoundResult message - holding multiple results </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w4" doxytag="LocateResult"></a>LocateResult</em> </td><td>
A LocateRequest message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w5" doxytag="ValidateRequest"></a>ValidateRequest</em> </td><td>
A LocateResult message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w6" doxytag="ValidateResult"></a>ValidateResult</em> </td><td>
A ValidateRequest message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w7" doxytag="PendingRequest"></a>PendingRequest</em> </td><td>
A ValidateResult message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w8" doxytag="StatusRequest"></a>StatusRequest</em> </td><td>
A PendingRequest message (Asynchronous protocol) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w9" doxytag="StatusResult"></a>StatusResult</em> </td><td>
A StatusRequest message (Asynchronous protocol) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w10" doxytag="Result"></a>Result</em> </td><td>
A StatusResult message (Asynchronous protocol) </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w11" doxytag="RegisterRequest"></a>RegisterRequest</em> </td><td>
A non-specific result message </td></tr>
<tr><td valign="top"><em><a class="anchor" name="z281_0w12" doxytag="RegisterResult"></a>RegisterResult</em> </td><td>
A RegisterResult message </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z281_2" doxytag="XKMSMessageAbstractType::XKMSMessageAbstractType"></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">XKMSMessageAbstractType::XKMSMessageAbstractType </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="z281_1" doxytag="XKMSMessageAbstractType::~XKMSMessageAbstractType"></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 XKMSMessageAbstractType::~XKMSMessageAbstractType </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="z284_3" doxytag="XKMSMessageAbstractType::addSignature"></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="classDSIGSignature.html">DSIGSignature</a>* XKMSMessageAbstractType::addSignature </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="mdname" nowrap> <em>cm</em> = <code>CANON_C14N_NOC</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> </td>
<td class="mdname" nowrap> <em>sm</em> = <code>SIGNATURE_DSA</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> </td>
<td class="mdname" nowrap> <em>hm</em> = <code>HASH_SHA1</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a signature to the message.
<p>
Allows an application to sign the message<p>
<dl compact><dt><b>Returns:</b></dt><dd>the new Signature structure </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z285_2" doxytag="XKMSMessageAbstractType::appendOpaqueClientDataItem"></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 XKMSMessageAbstractType::appendOpaqueClientDataItem </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>item</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>
</td>
</tr>
</table>
<a class="anchor" name="z283_2" doxytag="XKMSMessageAbstractType::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* XKMSMessageAbstractType::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>
<p>
Implemented in <a class="el" href="classXKMSCompoundRequest.html#z263_0">XKMSCompoundRequest</a>, <a class="el" href="classXKMSCompoundResult.html#z266_0">XKMSCompoundResult</a>, <a class="el" href="classXKMSLocateRequest.html#z276_0">XKMSLocateRequest</a>, <a class="el" href="classXKMSLocateResult.html#z279_0">XKMSLocateResult</a>, <a class="el" href="classXKMSPendingRequest.html#z296_0">XKMSPendingRequest</a>, <a class="el" href="classXKMSRegisterRequest.html#z303_0">XKMSRegisterRequest</a>, <a class="el" href="classXKMSRegisterResult.html#z306_0">XKMSRegisterResult</a>, <a class="el" href="classXKMSRequestAbstractType.html#z309_0">XKMSRequestAbstractType</a>, <a class="el" href="classXKMSResult.html#z320_0">XKMSResult</a>, <a class="el" href="classXKMSStatusRequest.html#z328_0">XKMSStatusRequest</a>, <a class="el" href="classXKMSStatusResult.html#z331_0">XKMSStatusResult</a>, <a class="el" href="classXKMSValidateRequest.html#z338_0">XKMSValidateRequest</a>, and <a class="el" href="classXKMSValidateResult.html#z341_0">XKMSValidateResult</a>. </td>
</tr>
</table>
<a class="anchor" name="z283_3" doxytag="XKMSMessageAbstractType::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">virtual const XMLCh* XKMSMessageAbstractType::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> 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 Id for the Message.
<p>
All messages are required to have an Id attribute that uniquely identifies the message. This method is used to retrieve a pointer to the Id string.<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the Id string (owned by the library) </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z282_0" doxytag="XKMSMessageAbstractType::getMessageType"></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="classXKMSMessageAbstractType.html#z281_0">messageType</a> XKMSMessageAbstractType::getMessageType </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>
</td>
</tr>
</table>
<a class="anchor" name="z283_5" doxytag="XKMSMessageAbstractType::getNonce"></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* XKMSMessageAbstractType::getNonce </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 Nonce of the message.
<p>
All messages MAY have a nonce, used to provide cryptographically random data that will help defend against a replay attack.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A string (owned by the library) providing the nonce data in base64 encoded form. If no Nonce is set, NULL is returned. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z285_1" doxytag="XKMSMessageAbstractType::getOpaqueClientDataItemStr"></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* XKMSMessageAbstractType::getOpaqueClientDataItemStr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>item</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>
</td>
</tr>
</table>
<a class="anchor" name="z285_0" doxytag="XKMSMessageAbstractType::getOpaqueClientDataSize"></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 int XKMSMessageAbstractType::getOpaqueClientDataSize </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>
Find the number of <OpaqueData> elements.
<p>
The <OpaqueClientData> element can have multiple <OpaqueData> children. This method allows an application to determine how many such children exist<p>
<dl compact><dt><b>Returns:</b></dt><dd>Number of <OpaqueData> elements </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z283_4" doxytag="XKMSMessageAbstractType::getService"></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* XKMSMessageAbstractType::getService </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 Service identifier for this message.
<p>
All Messages are associated with a particular XKMS service. This method can be used to retrieve the Service URI for a particular message.<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the Service URI string (owned by the library) </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z283_1" doxytag="XKMSMessageAbstractType::getSignature"></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="classDSIGSignature.html">DSIGSignature</a>* XKMSMessageAbstractType::getSignature </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>
Retrieve the Signature information (if any is attached).
<p>
All XKMS messages MAY have a <Signature> node that is used to attest to the validity of the message.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classDSIGSignature.html">DSIGSignature</a> object associated with this Message, or NULL if none is defined </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z283_0" doxytag="XKMSMessageAbstractType::isSigned"></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 bool XKMSMessageAbstractType::isSigned </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>
Find out whether this is a signed Message.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if the message is signed </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z284_0" doxytag="XKMSMessageAbstractType::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">virtual void XKMSMessageAbstractType::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><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the Id URI for the Message.
<p>
Allows a calling application to set a new Id for the message<p>
Note: Great care should be taken on resetting Id attributes, as they are used to track a particular transaction through its liefcycle.<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>The Id to set </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z284_2" doxytag="XKMSMessageAbstractType::setNonce"></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 XKMSMessageAbstractType::setNonce </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>uri</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>
Set the Nonce value.
<p>
Allows the application to set a new Nonce value (overwriting any that is currently set).<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>uri</em> </td><td>String (base64 encoded data) to set in the Nonce attribute. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>no checking of this string is done by the library - it is assumed that it is a valid base64 encoding. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z284_1" doxytag="XKMSMessageAbstractType::setService"></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 XKMSMessageAbstractType::setService </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>service</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>
Set the Service for the Message.
<p>
Used to set a new service URI for a particular message. In general, the service attribute would not be expected to change.<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>service</em> </td><td>String to set in the Service 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="XKMSMessageAbstractType_8hpp-source.html">XKMSMessageAbstractType.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:44:22 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>
|
