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
|
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>qpid/management/Manageable.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#FFFFFF">
<table border="0" width="90%" align="center">
<tr>
<td align="left">
<a title="Apache Qpid Project Page" href="http://qpid.apache.org">Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET</a>
</td>
<td align="right">
<a title="Apache Qpid Documentation" href="http://qpid.apache.org/documentation.html">Apache Qpid Documentation</a>
</td>
</tr>
</table>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">qpid/management/Manageable.h</div> </div>
</div>
<div class="contents">
<a href="a00536.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _Manageable_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _Manageable_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span>
<a name="l00006"></a>00006 <span class="comment">// or more contributor license agreements. See the NOTICE file</span>
<a name="l00007"></a>00007 <span class="comment">// distributed with this work for additional information</span>
<a name="l00008"></a>00008 <span class="comment">// regarding copyright ownership. The ASF licenses this file</span>
<a name="l00009"></a>00009 <span class="comment">// to you under the Apache License, Version 2.0 (the</span>
<a name="l00010"></a>00010 <span class="comment">// "License"); you may not use this file except in compliance</span>
<a name="l00011"></a>00011 <span class="comment">// with the License. You may obtain a copy of the License at</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// Unless required by applicable law or agreed to in writing,</span>
<a name="l00016"></a>00016 <span class="comment">// software distributed under the License is distributed on an</span>
<a name="l00017"></a>00017 <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<a name="l00018"></a>00018 <span class="comment">// KIND, either express or implied. See the License for the</span>
<a name="l00019"></a>00019 <span class="comment">// specific language governing permissions and limitations</span>
<a name="l00020"></a>00020 <span class="comment">// under the License.</span>
<a name="l00021"></a>00021 <span class="comment">//</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="a00538.html">qpid/management/ManagementObject.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="a00535.html">qpid/management/Args.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <string></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="a00482.html">qpid/CommonImportExport.h</a>"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>qpid {
<a name="l00029"></a>00029 <span class="keyword">namespace </span>management {
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="a00482.html#a0b7cbe1dd21be86348943cd971d33a20">QPID_COMMON_EXTERN</a> Manageable
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">virtual</span> ~Manageable(<span class="keywordtype">void</span>) = 0;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// status_t is a type used to pass completion status from the method handler.</span>
<a name="l00038"></a>00038 <span class="comment">//</span>
<a name="l00039"></a><a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">00039</a> <span class="keyword">typedef</span> <a class="code" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a>;
<a name="l00040"></a>00040 <span class="keyword">static</span> std::string StatusText(<a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> status, <a class="code" href="a00345.html" title="STL class.">std::string</a> text = <a class="code" href="a00345.html" title="STL class.">std::string</a>());
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="a00197.html#a592771416f0e9da5a1a79188f7c96e89">00042</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_OK = 0;
<a name="l00043"></a><a class="code" href="a00197.html#ad975d7b0c1fcbaf701f7c07c340f0b45">00043</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_UNKNOWN_OBJECT = 1;
<a name="l00044"></a><a class="code" href="a00197.html#a3a0cf42ae10a82a6994d67a183cf478a">00044</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_UNKNOWN_METHOD = 2;
<a name="l00045"></a><a class="code" href="a00197.html#aa27c0aec05bb43dbf99c8044eb44f3f0">00045</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_NOT_IMPLEMENTED = 3;
<a name="l00046"></a><a class="code" href="a00197.html#aa6ed0dcc7f57c7773646c089bcf7dc64">00046</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_PARAMETER_INVALID = 4;
<a name="l00047"></a><a class="code" href="a00197.html#a53742b057ad9ec43cb607c357753f2b4">00047</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_FEATURE_NOT_IMPLEMENTED = 5;
<a name="l00048"></a><a class="code" href="a00197.html#a3fe193bfeb4b104bb97ea66edc6f88b0">00048</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_FORBIDDEN = 6;
<a name="l00049"></a><a class="code" href="a00197.html#a30657cd42fe597036a7975414763d61b">00049</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_EXCEPTION = 7;
<a name="l00050"></a><a class="code" href="a00197.html#af5cba715c0e9af9abb93d30dd4617188">00050</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> STATUS_USER = 0x00010000;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">// Every "Manageable" object must hold a reference to exactly one</span>
<a name="l00053"></a>00053 <span class="comment">// management object. This object is always of a class derived from</span>
<a name="l00054"></a>00054 <span class="comment">// the pure-virtual "ManagementObject".</span>
<a name="l00055"></a>00055 <span class="comment">//</span>
<a name="l00056"></a>00056 <span class="comment">// This accessor function returns a pointer to the management object.</span>
<a name="l00057"></a>00057 <span class="comment">//</span>
<a name="l00058"></a>00058 <span class="keyword">virtual</span> <a class="code" href="a00201.html">ManagementObject</a>* GetManagementObject(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">// Every "Manageable" object must implement ManagementMethod. This</span>
<a name="l00061"></a>00061 <span class="comment">// function is called when a remote management client invokes a method</span>
<a name="l00062"></a>00062 <span class="comment">// on this object. The input and output arguments are specific to the</span>
<a name="l00063"></a>00063 <span class="comment">// method being called and must be down-cast to the appropriate sub class</span>
<a name="l00064"></a>00064 <span class="comment">// before use.</span>
<a name="l00065"></a>00065 <span class="keyword">virtual</span> <a class="code" href="a00197.html#a4b95c16feeab45798590003dd61280d4">status_t</a> ManagementMethod(<a class="code" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> methodId, <a class="code" href="a00014.html">Args</a>& args, <a class="code" href="a00345.html" title="STL class.">std::string</a>& text);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// This optional method can be overridden to allow the agent application to</span>
<a name="l00068"></a>00068 <span class="comment">// authorize method invocations. Return true iff the authenticated user identified</span>
<a name="l00069"></a>00069 <span class="comment">// in userId us authorized to execute the method.</span>
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> AuthorizeMethod(<a class="code" href="a00556.html#a435d1572bf3f880d55459d9805097f62">uint32_t</a> methodId, <a class="code" href="a00014.html">Args</a>& args, <span class="keyword">const</span> <a class="code" href="a00345.html" title="STL class.">std::string</a>& userId);
<a name="l00071"></a>00071 };
<a name="l00072"></a>00072
<a name="l00073"></a><a class="code" href="a00197.html#a135cbb042f49b26b393453425a6d6fc2">00073</a> <span class="keyword">inline</span> <a class="code" href="a00197.html#a135cbb042f49b26b393453425a6d6fc2">Manageable::~Manageable</a>(<span class="keywordtype">void</span>) {}
<a name="l00074"></a>00074
<a name="l00075"></a>00075 }}
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="preprocessor">#endif </span>
</pre></div></div>
</div>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<hr size="1">
<address style="text-align: left;"><small>
Qpid C++ API Reference</small></address>
<address style="text-align: right;">
<small>
Generated on Thu May 10 2012 for Qpid C++ Client API by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5</small>
</address>
</body>
</html>
|
