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
|
<!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: DSIGKeyInfoName 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>DSIGKeyInfoName Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGKeyInfoName_8hpp-source.html">DSIGKeyInfoName.hpp</a>></code>
<p>
Inheritance diagram for DSIGKeyInfoName:<p><center><img src="classDSIGKeyInfoName__inherit__graph.png" border="0" usemap="#DSIGKeyInfoName__inherit__map" alt="Inheritance graph"></center>
<map name="DSIGKeyInfoName__inherit__map">
<area href="classDSIGKeyInfo.html" shape="rect" coords="26,9,125,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DSIGKeyInfoName:<p><center><img src="classDSIGKeyInfoName__coll__graph.png" border="0" usemap="#DSIGKeyInfoName__coll__map" alt="Collaboration graph"></center>
<map name="DSIGKeyInfoName__coll__map">
<area href="classDSIGKeyInfo.html" shape="rect" coords="176,372,274,396" alt="">
<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,100,293,124" 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="classDSIGKeyInfoName-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The class for <KeyName> nodes in a KeyInfo list.
<p>
Class for holding information on a KeyName node as well as setting such a node in a signature.
<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="classDSIGKeyInfoName.html#z11_0">DSIGKeyInfoName</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *nameNode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor used when XML exists. <a href="#z11_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoName.html#z11_1">DSIGKeyInfoName</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor used when XML needs to be created. <a href="#z11_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="classDSIGKeyInfoName.html#z11_2">~DSIGKeyInfoName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z11_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Load and Get functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoName.html#z12_0">load</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load an existing XML structure into this object. <a href="#z12_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="classDSIGKeyInfoName.html#z12_1">getKeyName</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name held in the structure. <a href="#z12_1"></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="classDSIGKeyInfoName.html#z12_2">getDecodedKeyName</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the decoded key name (for distinguished names). <a href="#z12_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Create and set functions</div></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="classDSIGKeyInfoName.html#z13_0">createBlankKeyName</a> (const XMLCh *name, bool isDName=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new KeyName element in the current document. <a href="#z13_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="classDSIGKeyInfoName.html#z13_1">setKeyName</a> (const XMLCh *name, bool isDName=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the KeyName to a new string. <a href="#z13_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Information Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfo.html#w9">keyInfoType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfoName.html#z14_0">getKeyInfoType</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return type of this KeyInfo element. <a href="#z14_0"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z11_0" doxytag="DSIGKeyInfoName::DSIGKeyInfoName"></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">DSIGKeyInfoName::DSIGKeyInfoName </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>nameNode</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 when XML exists.
<p>
This constructor is used by interface classes an existing DOM structure into the Name 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>env</em> </td><td>Environment the KeyInfo is operating within </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nameNode</em> </td><td>DOMNode to load information from </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_1" doxytag="DSIGKeyInfoName::DSIGKeyInfoName"></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">DSIGKeyInfoName::DSIGKeyInfoName </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>
Constructor used when XML needs to be created.
<p>
This constructor is used by interface objects to create a DSIGKeyInfoName object that can then be used to create the required XML.<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>Operating environment </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z11_2" doxytag="DSIGKeyInfoName::~DSIGKeyInfoName"></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 DSIGKeyInfoName::~DSIGKeyInfoName </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> [virtual]</code></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="z13_0" doxytag="DSIGKeyInfoName::createBlankKeyName"></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* DSIGKeyInfoName::createBlankKeyName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>isDName</em> = <code>false</code></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 a new KeyName element in the current document.
<p>
Creates a new KeyName element and sets the name with the string passed in.<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>name</em> </td><td>Value to set the KeyName as </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isDName</em> </td><td>If set to true, the name will be encoded as a DName prior to be being placed in the DOM document </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created DOMElement with the structure underneath. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z12_2" doxytag="DSIGKeyInfoName::getDecodedKeyName"></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* DSIGKeyInfoName::getDecodedKeyName </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the decoded key name (for distinguished names).
<p>
Returns a pointer to the buffer containing the decoded Distinguished Name.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the char buffer containing the key name </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z14_0" doxytag="DSIGKeyInfoName::getKeyInfoType"></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="classDSIGKeyInfo.html#w9">keyInfoType</a> DSIGKeyInfoName::getKeyInfoType </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, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return type of this KeyInfo element.
<p>
<p>
Implements <a class="el" href="classDSIGKeyInfo.html#z1_0">DSIGKeyInfo</a>. </td>
</tr>
</table>
<a class="anchor" name="z12_1" doxytag="DSIGKeyInfoName::getKeyName"></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* DSIGKeyInfoName::getKeyName </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, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the name held in the structure.
<p>
Returns a pointer to the buffer containing the name of the key.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the char buffer containing the key name </dd></dl>
<p>
Implements <a class="el" href="classDSIGKeyInfo.html#z1_2">DSIGKeyInfo</a>. </td>
</tr>
</table>
<a class="anchor" name="z12_0" doxytag="DSIGKeyInfoName::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 DSIGKeyInfoName::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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load an existing XML structure into this object.
<p>
<p>
Implements <a class="el" href="classDSIGKeyInfo.html#z2_0">DSIGKeyInfo</a>. </td>
</tr>
</table>
<a class="anchor" name="z13_1" doxytag="DSIGKeyInfoName::setKeyName"></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 DSIGKeyInfoName::setKeyName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>isDName</em> = <code>false</code></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>
Set the value of the KeyName to a new string.
<p>
Uses the passed in string to set a new value in the DOM structure.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Value to set in KeyName </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isDName</em> </td><td>If set to true, the name will be encoded as a DName prior to be being placed in the DOM document </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="DSIGKeyInfoName_8hpp-source.html">DSIGKeyInfoName.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:40:56 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>
|
