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
|
<!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: XKMSMessageAbstractType.hpp Source File</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>
<div class="nav">
<a class="el" href="dir_000000.html">src</a> / <a class="el" href="dir_000007.html">xkms</a></div>
<h1>XKMSMessageAbstractType.hpp</h1><a href="XKMSMessageAbstractType_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright 2004-2005 The Apache Software Foundation.</span>
00003 <span class="comment"> *</span>
00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
00006 <span class="comment"> * You may obtain a copy of the License at</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
00009 <span class="comment"> *</span>
00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
00014 <span class="comment"> * limitations under the License.</span>
00015 <span class="comment"> */</span>
00016
00017 <span class="comment">/*</span>
00018 <span class="comment"> * XSEC</span>
00019 <span class="comment"> *</span>
00020 <span class="comment"> * XKMSMessageAbstractType := Interface for base schema of XKMS messages</span>
00021 <span class="comment"> *</span>
00022 <span class="comment"> * $Id: XKMSMessageAbstractType.hpp,v 1.11 2005/06/04 11:30:26 blautenb Exp $</span>
00023 <span class="comment"> *</span>
00024 <span class="comment"> */</span>
00025
00026 <span class="preprocessor">#ifndef XKMSMESSAGEABSTRACTTYPE_INCLUDE</span>
00027 <span class="preprocessor"></span><span class="preprocessor">#define XKMSMESSAGEABSTRACTTYPE_INCLUDE</span>
00028 <span class="preprocessor"></span>
00029 <span class="comment">// XSEC Includes</span>
00030
00031 <span class="preprocessor">#include <xsec/framework/XSECDefs.hpp></span>
00032 <span class="preprocessor">#include <xsec/dsig/DSIGConstants.hpp></span>
00033
00034 <span class="keyword">class </span><a class="code" href="classDSIGSignature.html">DSIGSignature</a>;
00035
00036 <a class="code" href="XSECDefs_8hpp.html#a5">XSEC_DECLARE_XERCES_CLASS</a>(DOMElement);
00037
<a name="l00084"></a><a class="code" href="classXKMSMessageAbstractType.html">00084</a> <span class="keyword">class </span><a class="code" href="classXKMSMessageAbstractType.html">XKMSMessageAbstractType</a> {
00085
00088
00089 <span class="keyword">protected</span>:
00090
<a name="l00091"></a><a class="code" href="classXKMSMessageAbstractType.html#z281_2">00091</a> <a class="code" href="classXKMSMessageAbstractType.html#z281_2">XKMSMessageAbstractType</a>() {};
00092
00093 <span class="keyword">public</span>:
00094
<a name="l00095"></a><a class="code" href="classXKMSMessageAbstractType.html#z281_0">00095</a> <span class="keyword">enum</span> <a class="code" href="classXKMSMessageAbstractType.html#z281_0">messageType</a> {
00096
00097 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w0">None</a>,
00099 <span class="comment">/* X-KISS messages */</span>
00100
00101 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w1">CompoundRequest</a>,
00102 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w2">CompoundResult</a>,
00103 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w3">LocateRequest</a>,
00104 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w4">LocateResult</a>,
00105 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w5">ValidateRequest</a>,
00106 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w6">ValidateResult</a>,
00107 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w7">PendingRequest</a>,
00108 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w8">StatusRequest</a>,
00109 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w9">StatusResult</a>,
00110 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w10">Result</a>,
00112 <span class="comment">/* X-KRSS messages */</span>
00113
00114 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w11">RegisterRequest</a>,
00115 <a class="code" href="classXKMSMessageAbstractType.html#z281_0w12">RegisterResult</a>
00117 };
00118
<a name="l00119"></a><a class="code" href="classXKMSMessageAbstractType.html#z281_1">00119</a> <span class="keyword">virtual</span> <a class="code" href="classXKMSMessageAbstractType.html#z281_1">~XKMSMessageAbstractType</a>() {};
00120
00123
00124 <span class="keyword">virtual</span> <a class="code" href="classXKMSMessageAbstractType.html#z281_0">messageType</a> <a class="code" href="classXKMSMessageAbstractType.html#z282_0">getMessageType</a>(<span class="keywordtype">void</span>) = 0;
00125
00128
00135 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classXKMSMessageAbstractType.html#z283_0">isSigned</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00136
00147 <span class="keyword">virtual</span> <a class="code" href="classDSIGSignature.html">DSIGSignature</a> * <a class="code" href="classXKMSMessageAbstractType.html#z283_1">getSignature</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00148
00149 <span class="comment">/*</span>
00150 <span class="comment"> * \brief Obtain the base Element for this structure</span>
00151 <span class="comment"> *</span>
00152 <span class="comment"> * @returns the Element node at the head of the DOM structure</span>
00153 <span class="comment"> */</span>
00154
00155 <span class="keyword">virtual</span> <a class="code" href="XSECDefs_8hpp.html#a0">XERCES_CPP_NAMESPACE_QUALIFIER</a> DOMElement * <a class="code" href="classXKMSMessageAbstractType.html#z283_2">getElement</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00156
00167 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh * <a class="code" href="classXKMSMessageAbstractType.html#z283_3">getId</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00168
00180 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh * <a class="code" href="classXKMSMessageAbstractType.html#z283_4">getService</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00181
00192 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh * <a class="code" href="classXKMSMessageAbstractType.html#z283_5">getNonce</a>(<span class="keywordtype">void</span>) <span class="keyword">const </span>= 0;
00193
00195
00198
00212 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classXKMSMessageAbstractType.html#z284_0">setId</a>(<span class="keyword">const</span> XMLCh * <span class="keywordtype">id</span>) = 0;
00213
00224 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classXKMSMessageAbstractType.html#z284_1">setService</a>(<span class="keyword">const</span> XMLCh * service) = 0;
00225
00237 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classXKMSMessageAbstractType.html#z284_2">setNonce</a>(<span class="keyword">const</span> XMLCh * uri) = 0;
00238
00247 <span class="keyword">virtual</span> <a class="code" href="classDSIGSignature.html">DSIGSignature</a> * <a class="code" href="classXKMSMessageAbstractType.html#z284_3">addSignature</a>(
00248 <a class="code" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm = <a class="code" href="DSIGConstants_8hpp.html#a102a60">CANON_C14N_NOC</a>,
00249 <a class="code" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> sm = <a class="code" href="DSIGConstants_8hpp.html#a103a65">SIGNATURE_DSA</a>,
00250 <a class="code" href="DSIGConstants_8hpp.html#a104">hashMethod</a> hm = <a class="code" href="DSIGConstants_8hpp.html#a104a69">HASH_SHA1</a>) = 0;
00251
00253
00256
00267 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classXKMSMessageAbstractType.html#z285_0">getOpaqueClientDataSize</a>(<span class="keywordtype">void</span>) = 0;
00268
00269 <span class="comment">/*</span>
00270 <span class="comment"> * \brief Get the nth item in the OpaqueClientData list</span>
00271 <span class="comment"> *</span>
00272 <span class="comment"> * @param item The item to return</span>
00273 <span class="comment"> * @returns the string of the nth item in the OpaqueClientData list.</span>
00274 <span class="comment"> *</span>
00275 <span class="comment"> */</span>
00276
00277 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh * <a class="code" href="classXKMSMessageAbstractType.html#z285_1">getOpaqueClientDataItemStr</a>(<span class="keywordtype">int</span> item) = 0;
00278
00279 <span class="comment">/*</span>
00280 <span class="comment"> * \brief Append an item to the OpaqueClientData list</span>
00281 <span class="comment"> *</span>
00282 <span class="comment"> * @param item Base64 string to append to the list. Will be</span>
00283 <span class="comment"> * wrapped in a OpaqueData element.</span>
00284 <span class="comment"> */</span>
00285
00286 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classXKMSMessageAbstractType.html#z285_2">appendOpaqueClientDataItem</a>(<span class="keyword">const</span> XMLCh * item) = 0;
00287
00289
00290 <span class="keyword">private</span>:
00291
00292 <span class="comment">// Unimplemented</span>
00293 <a class="code" href="classXKMSMessageAbstractType.html#z281_2">XKMSMessageAbstractType</a>(<span class="keyword">const</span> <a class="code" href="classXKMSMessageAbstractType.html">XKMSMessageAbstractType</a> &);
00294 <a class="code" href="classXKMSMessageAbstractType.html">XKMSMessageAbstractType</a> & operator = (<span class="keyword">const</span> <a class="code" href="classXKMSMessageAbstractType.html">XKMSMessageAbstractType</a> &);
00295
00296 };
00297
00298 <span class="preprocessor">#endif </span><span class="comment">/* XKMSMESSAGEABSTRACTTYPE_INCLUDE */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:37:27 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>
|