File: classDSIGTransformEnvelope.html

package info (click to toggle)
xml-security-c 1.2.1-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 24,464 kB
  • ctags: 6,673
  • sloc: cpp: 36,830; xml: 23,415; sh: 2,365; makefile: 340; perl: 221
file content (312 lines) | stat: -rw-r--r-- 15,011 bytes parent folder | download | duplicates (2)
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
<!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: DSIGTransformEnvelope 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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>DSIGTransformEnvelope Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include &lt;<a class="el" href="DSIGTransformEnvelope_8hpp-source.html">DSIGTransformEnvelope.hpp</a>&gt;</code>
<p>
Inheritance diagram for DSIGTransformEnvelope:<p><center><img src="classDSIGTransformEnvelope__inherit__graph.png" border="0" usemap="#DSIGTransformEnvelope__inherit__map" alt="Inheritance graph"></center>
<map name="DSIGTransformEnvelope__inherit__map">
<area href="classDSIGTransform.html" shape="rect" coords="36,9,150,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DSIGTransformEnvelope:<p><center><img src="classDSIGTransformEnvelope__coll__graph.png" border="0" usemap="#DSIGTransformEnvelope__coll__map" alt="Collaboration graph"></center>
<map name="DSIGTransformEnvelope__coll__map">
<area href="classDSIGTransform.html" shape="rect" coords="168,372,282,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="classDSIGTransformEnvelope-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Transform holder for Base 64. 
<p>
The DSIGTransformEnvelope class is used to hold base64 &lt;Transform&gt; elements within a document.<p>
This is a very simple transform with no real options.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTXFMBase.html">TXFMBase</a> <p>
<a class="el" href="classDSIGTransform.html">DSIGTransform</a> </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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z62_0">DSIGTransformEnvelope</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contructor used for existing XML signatures.  <a href="#z62_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z62_1">DSIGTransformEnvelope</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contructor used for new signatures.  <a href="#z62_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z62_2">~DSIGTransformEnvelope</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#z62_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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z63_0">getTransformType</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the transform type.  <a href="#z63_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z63_1">appendTransformer</a> (<a class="el" href="classTXFMChain.html">TXFMChain</a> *input)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create the Enevelope transformer element.  <a href="#z63_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z63_2">createBlankTransform</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *parentDoc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct blank Envelope Transform element.  <a href="#z63_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGTransformEnvelope.html#z63_3">load</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load a DOM structure.  <a href="#z63_3"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z62_0" doxytag="DSIGTransformEnvelope::DSIGTransformEnvelope"></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">DSIGTransformEnvelope::DSIGTransformEnvelope           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> *&nbsp;</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 *&nbsp;</td>
          <td class="mdname" nowrap> <em>node</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Contructor used for existing XML signatures. 
<p>
The Node structure already exists, so read the nodes 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>env</em>&nbsp;</td><td>The operating environment </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</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="classDSIGTransformEnvelope.html#z63_3">load</a> </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z62_1" doxytag="DSIGTransformEnvelope::DSIGTransformEnvelope"></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">DSIGTransformEnvelope::DSIGTransformEnvelope           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>env</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Contructor used for new signatures. 
<p>
The Node structure will have to be created.<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>&nbsp;</td><td>The operating environment </td></tr>
  </table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classDSIGTransformEnvelope.html#z63_2">createBlankTransform</a> </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z62_2" doxytag="DSIGTransformEnvelope::~DSIGTransformEnvelope"></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 DSIGTransformEnvelope::~DSIGTransformEnvelope           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </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="z63_1" doxytag="DSIGTransformEnvelope::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 DSIGTransformEnvelope::appendTransformer           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classTXFMChain.html">TXFMChain</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create the Enevelope transformer element. 
<p>
Implemented by each Transform class and used by the <a class="el" href="classDSIGSignature.html">DSIGSignature</a> to construct a complete Transform list. 
<p>
Implements <a class="el" href="classDSIGTransform.html#z55_1">DSIGTransform</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z63_2" doxytag="DSIGTransformEnvelope::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* DSIGTransformEnvelope::createBlankTransform           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>parentDoc</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct blank Envelope Transform element. 
<p>
Instruct the implementation to create the required transform and return the newly constructed DOMNode structure 
<p>
Implements <a class="el" href="classDSIGTransform.html#z55_2">DSIGTransform</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z63_0" doxytag="DSIGTransformEnvelope::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> DSIGTransformEnvelope::getTransformType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine the transform type. 
<p>
Used to determine what the type of the transform is. 
<p>
Implements <a class="el" href="classDSIGTransform.html#z55_0">DSIGTransform</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z63_3" doxytag="DSIGTransformEnvelope::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 DSIGTransformEnvelope::load           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Load a DOM structure. 
<p>
For a Envelope transform this does almost nothing. 
<p>
Implements <a class="el" href="classDSIGTransform.html#z55_3">DSIGTransform</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGTransformEnvelope_8hpp-source.html">DSIGTransformEnvelope.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:37 2005 for XML-Security-C by&nbsp;
<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>