File: classXKMSLocateRequest.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 (221 lines) | stat: -rw-r--r-- 10,829 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
 
<!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: XKMSLocateRequest 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>XKMSLocateRequest Class Reference<br>
<small>
[<a class="el" href="group__xkms.html">XML Key Management System Implementation</a>]</small>
</h1><code>#include &lt;<a class="el" href="XKMSLocateRequest_8hpp-source.html">XKMSLocateRequest.hpp</a>&gt;</code>
<p>
Inheritance diagram for XKMSLocateRequest:<p><center><img src="classXKMSLocateRequest__inherit__graph.png" border="0" usemap="#XKMSLocateRequest__inherit__map" alt="Inheritance graph"></center>
<map name="XKMSLocateRequest__inherit__map">
<area href="classXKMSRequestAbstractType.html" shape="rect" coords="10,84,200,108" alt="">
<area href="classXKMSMessageAbstractType.html" shape="rect" coords="8,9,202,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XKMSLocateRequest:<p><center><img src="classXKMSLocateRequest__coll__graph.png" border="0" usemap="#XKMSLocateRequest__coll__map" alt="Collaboration graph"></center>
<map name="XKMSLocateRequest__coll__map">
<area href="classXKMSRequestAbstractType.html" shape="rect" coords="10,84,200,108" alt="">
<area href="classXKMSMessageAbstractType.html" shape="rect" coords="8,9,202,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXKMSLocateRequest-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the LocateRequest elements. 
<p>
The &lt;LocateRequest&gt; is one of the fundamental message types of the XKISS service. It is used by the Locate service to find a key and return a set of key bindings for that key.<p>
The schema definition for LocateRequest is as follows :<p>
<div class="fragment"><pre class="fragment">   &lt;!-- LocateRequest --&gt;
   &lt;element name="LocateRequest" type="xkms:LocateRequestType"/&gt;
   &lt;complexType name="LocateRequestType"&gt;
      &lt;complexContent&gt;
         &lt;extension base="xkms:RequestAbstractType"&gt;
            &lt;sequence&gt;
               &lt;element ref="xkms:QueryKeyBinding"/&gt;
            &lt;/sequence&gt;
         &lt;/extension&gt;
      &lt;/complexContent&gt;
   &lt;/complexType&gt;
   &lt;!-- /LocateRequest --&gt;
</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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSLocateRequest.html#z275_0">~XKMSLocateRequest</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSLocateRequest.html#z275_1">XKMSLocateRequest</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></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 XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSLocateRequest.html#z276_0">getElement</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the element at the base of the message.  <a href="#z276_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSQueryKeyBinding.html">XKMSQueryKeyBinding</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSLocateRequest.html#z276_1">getQueryKeyBinding</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the QueryKeyBinding element.  <a href="#z276_1"></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 <a class="el" href="classXKMSQueryKeyBinding.html">XKMSQueryKeyBinding</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSLocateRequest.html#z277_0">addQueryKeyBinding</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a QueryKeyBinding element.  <a href="#z277_0"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z275_1" doxytag="XKMSLocateRequest::XKMSLocateRequest"></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">XKMSLocateRequest::XKMSLocateRequest           </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> [inline, protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a class="anchor" name="z275_0" doxytag="XKMSLocateRequest::~XKMSLocateRequest"></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 XKMSLocateRequest::~XKMSLocateRequest           </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> [inline, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z277_0" doxytag="XKMSLocateRequest::addQueryKeyBinding"></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="classXKMSQueryKeyBinding.html">XKMSQueryKeyBinding</a>* XKMSLocateRequest::addQueryKeyBinding           </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> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Add a QueryKeyBinding element. 
<p>
Set a QueryKeyBinding element in the LocateRequest message. The returned object can be manipulated to add KeyInfo elements to the LocateRequest.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the newly created QueryKeyBinding object, or the pointer to extant object if one already existed. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z276_0" doxytag="XKMSLocateRequest::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* XKMSLocateRequest::getElement           </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> const<code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the element at the base of the message. 
<p>

<p>
Implements <a class="el" href="classXKMSRequestAbstractType.html#z309_0">XKMSRequestAbstractType</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z276_1" doxytag="XKMSLocateRequest::getQueryKeyBinding"></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="classXKMSQueryKeyBinding.html">XKMSQueryKeyBinding</a>* XKMSLocateRequest::getQueryKeyBinding           </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> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Obtain the QueryKeyBinding element. 
<p>
The QueryKeyBinding element is the core of the LocateRequest message, and defines the public key information that will be sent to the server.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classXKMSQueryKeyBinding.html">XKMSQueryKeyBinding</a> element </dd></dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XKMSLocateRequest_8hpp-source.html">XKMSLocateRequest.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:44:16 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>