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
|
<!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: XSECSOAPRequestorSimple 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>XSECSOAPRequestorSimple 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="XSECSOAPRequestorSimple_8hpp-source.html">XSECSOAPRequestorSimple.hpp</a>></code>
<p>
Inheritance diagram for XSECSOAPRequestorSimple:<p><center><img src="classXSECSOAPRequestorSimple__inherit__graph.png" border="0" usemap="#XSECSOAPRequestorSimple__inherit__map" alt="Inheritance graph"></center>
<map name="XSECSOAPRequestorSimple__inherit__map">
<area href="classXSECSOAPRequestor.html" shape="rect" coords="29,9,186,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XSECSOAPRequestorSimple:<p><center><img src="classXSECSOAPRequestorSimple__coll__graph.png" border="0" usemap="#XSECSOAPRequestorSimple__coll__map" alt="Collaboration graph"></center>
<map name="XSECSOAPRequestorSimple__coll__map">
<area href="classXSECSOAPRequestor.html" shape="rect" coords="29,9,186,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECSOAPRequestorSimple-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Basic HTTP implementation for SOAP Requests.
<p>
The XKMS client code needs to be able to call on a SOAP requestor implementation that will handle wrapping the request in a SOAP msg and transporting it to the SOAP server. This class provides a very naieve implementation that wraps the message and does a basic HTTP POST to get the message to the end server.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Configuration methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestorSimple.html#z226_0">setEnvelopeType</a> (<a class="el" href="classXSECSOAPRequestorSimple.html#w3">envelopeType</a> et)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the envelope type. <a href="#z226_0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestorSimple.html#w3">envelopeType</a> { <br>
<a class="el" href="classXSECSOAPRequestorSimple.html#w3w0">ENVELOPE_NONE</a>,
<br>
<a class="el" href="classXSECSOAPRequestorSimple.html#w3w1">ENVELOPE_SOAP11</a>,
<br>
<a class="el" href="classXSECSOAPRequestorSimple.html#w3w2">ENVELOPE_SOAP12</a>
<br>
}</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="classXSECSOAPRequestorSimple.html#z224_0">XSECSOAPRequestorSimple</a> (const XMLCh *uri)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#z224_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestorSimple.html#z224_1">~XSECSOAPRequestorSimple</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Interface methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestorSimple.html#z225_0">doRequest</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *request)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do a SOAP request. <a href="#z225_0"></a><br></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w3" doxytag="XSECSOAPRequestorSimple::envelopeType"></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="classXSECSOAPRequestorSimple.html#w3">XSECSOAPRequestorSimple::envelopeType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Envelope Enumeration <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="w3w0" doxytag="ENVELOPE_NONE"></a>ENVELOPE_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w1" doxytag="ENVELOPE_SOAP11"></a>ENVELOPE_SOAP11</em> </td><td>
No envelope - straight HTTP request </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w2" doxytag="ENVELOPE_SOAP12"></a>ENVELOPE_SOAP12</em> </td><td>
SOAP 1.2 envelope </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z224_0" doxytag="XSECSOAPRequestorSimple::XSECSOAPRequestorSimple"></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">XSECSOAPRequestorSimple::XSECSOAPRequestorSimple </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
Create a SOAP requestor that can be used to access a specific server<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>The URI of the server that will be accessed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>The URI must be <a href="http://...">http://...</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z224_1" doxytag="XSECSOAPRequestorSimple::~XSECSOAPRequestorSimple"></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 XSECSOAPRequestorSimple::~XSECSOAPRequestorSimple </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>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z225_0" doxytag="XSECSOAPRequestorSimple::doRequest"></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 DOMDocument* XSECSOAPRequestorSimple::doRequest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * </td>
<td class="mdname1" valign="top" nowrap> <em>request</em> </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>
Do a SOAP request.
<p>
Performs a request based on the passed in DOM document and the indicated URI. The function is returns a pointer to the parsed result message (with the SOAP envelope removed)<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>request</em> </td><td>The DOM document containing the message to be wrapped and sent. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The DOM document representing the result, with all SOAP headers removed </dd></dl>
<p>
Implements <a class="el" href="classXSECSOAPRequestor.html#a0">XSECSOAPRequestor</a>. </td>
</tr>
</table>
<a class="anchor" name="z226_0" doxytag="XSECSOAPRequestorSimple::setEnvelopeType"></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 XSECSOAPRequestorSimple::setEnvelopeType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classXSECSOAPRequestorSimple.html#w3">envelopeType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>et</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 envelope type.
<p>
The requestor can do a SOAP 1.1, SOAP 1.2 or no envelope around the message. This call allows the apllication to set the type.<p>
By default, the requestor uses a SOAP 1.1 envelope<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>et</em> </td><td>- the type of envelope to use </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="XSECSOAPRequestorSimple_8hpp-source.html">XSECSOAPRequestorSimple.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:57 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>
|
