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
|
<!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: XSECSOAPRequestor 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>XSECSOAPRequestor Class Reference<br>
<small>
[<a class="el" href="group__interfaces.html">Classes that interface applications to XML Security C.</a>]</small>
</h1><code>#include <<a class="el" href="XSECSOAPRequestor_8hpp-source.html">XSECSOAPRequestor.hpp</a>></code>
<p>
Inheritance diagram for XSECSOAPRequestor:<p><center><img src="classXSECSOAPRequestor__inherit__graph.png" border="0" usemap="#XSECSOAPRequestor__inherit__map" alt="Inheritance graph"></center>
<map name="XSECSOAPRequestor__inherit__map">
<area href="classXSECSOAPRequestorSimple.html" shape="rect" coords="8,83,208,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECSOAPRequestor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface 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 defines the interface used by the client code to make this happen.<p>
Implementors need to wrap the passed in DOM document in a SOAP 1.1 or SOAP 1.2 msg. E.g. (SOAP 1.2) <div class="fragment"><pre class="fragment"> <?xml version='1.0' encoding="utf-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2002/06/soap-envelope">
<env:Header>
<env:Body>
XKMS Request Message element
</env:Body>
</env:Header>
</env:Envelope>
</pre></div><p>
SOAP implentors may want/need to add other headers.
<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 class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestor.html#a0">doRequest</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *request)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do a SOAP request. <a href="#a0"></a><br></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="classXSECSOAPRequestor.html#z223_0">XSECSOAPRequestor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECSOAPRequestor.html#z223_1">~XSECSOAPRequestor</a> ()</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z223_0" doxytag="XSECSOAPRequestor::XSECSOAPRequestor"></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">XSECSOAPRequestor::XSECSOAPRequestor </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]</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="z223_1" doxytag="XSECSOAPRequestor::~XSECSOAPRequestor"></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 XSECSOAPRequestor::~XSECSOAPRequestor </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="a0" doxytag="XSECSOAPRequestor::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* XSECSOAPRequestor::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> [pure 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 expected to return a pointer to the parsed result message (with the SOAP envelope removed)<p>
The implementing object is expected to know how to get the wrapped message to the server that will process the request<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>
Implemented in <a class="el" href="classXSECSOAPRequestorSimple.html#z225_0">XSECSOAPRequestorSimple</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECSOAPRequestor_8hpp-source.html">XSECSOAPRequestor.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:54 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>
|
