/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/monitor/Monitorable.html is in libosgi-compendium-java-doc 5.0.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>Monitorable</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Monitorable";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/osgi/service/monitor/MonitorAdmin.html" title="interface in org.osgi.service.monitor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/monitor/Monitorable.html" target="_top">Frames</a></li>
<li><a href="Monitorable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.service.monitor</div>
<h2 title="Interface Monitorable" class="title">Interface Monitorable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Monitorable</span></pre>
<div class="block">A <code>Monitorable</code> can provide information about itself in the form of
<code>StatusVariables</code>. Instances of this interface should register
themselves at the OSGi Service Registry. The <code>MonitorAdmin</code> listens to
the registration of <code>Monitorable</code> services, and makes the information
they provide available also through the Device Management Tree (DMT) for
remote access.
<p>
The monitorable service is identified by its PID string which must be a non-
<code>null</code>, non-empty string that conforms to the "symbolic-name"
definition in the OSGi core specification. This means that only the
characters [-_.a-zA-Z0-9] may be used. The length of the PID must not exceed
32 characters.
<p>
A <code>Monitorable</code> may optionally support sending notifications when the
status of its <code>StatusVariables</code> change. Support for change
notifications can be defined per <code>StatusVariable</code>.
<p>
Publishing <code>StatusVariables</code> requires the presence of the
<code>MonitorPermission</code> with the <code>publish</code> action string. This
permission, however, is not checked during registration of the
<code>Monitorable</code> service. Instead, the <code>MonitorAdmin</code> implementation
must make sure that when a <code>StatusVariable</code> is queried, it is shown
only if the <code>Monitorable</code> is authorized to publish the given
<code>StatusVariable</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/Monitorable.html#getDescription-java.lang.String-">getDescription</a></span>(java.lang.String id)</code>
<div class="block">Returns a human readable description of a <code>StatusVariable</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/monitor/StatusVariable.html" title="class in org.osgi.service.monitor">StatusVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/Monitorable.html#getStatusVariable-java.lang.String-">getStatusVariable</a></span>(java.lang.String id)</code>
<div class="block">Returns the <code>StatusVariable</code> object addressed by its identifier.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/Monitorable.html#getStatusVariableNames--">getStatusVariableNames</a></span>()</code>
<div class="block">Returns the list of <code>StatusVariable</code> identifiers published by this
<code>Monitorable</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/Monitorable.html#notifiesOnChange-java.lang.String-">notifiesOnChange</a></span>(java.lang.String id)</code>
<div class="block">Tells whether the <code>StatusVariable</code> provider is able to send instant
notifications when the given <code>StatusVariable</code> changes.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/Monitorable.html#resetStatusVariable-java.lang.String-">resetStatusVariable</a></span>(java.lang.String id)</code>
<div class="block">Issues a request to reset a given <code>StatusVariable</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getStatusVariableNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusVariableNames</h4>
<pre>java.lang.String[] getStatusVariableNames()</pre>
<div class="block">Returns the list of <code>StatusVariable</code> identifiers published by this
<code>Monitorable</code>. A <code>StatusVariable</code> name is unique within the
scope of a <code>Monitorable</code>. The array contains the elements in no
particular order. The returned value must not be <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> identifiers published by this object,
or an empty array if none are published</dd>
</dl>
</li>
</ul>
<a name="getStatusVariable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatusVariable</h4>
<pre><a href="../../../../org/osgi/service/monitor/StatusVariable.html" title="class in org.osgi.service.monitor">StatusVariable</a> getStatusVariable(java.lang.String id)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Returns the <code>StatusVariable</code> object addressed by its identifier.
The <code>StatusVariable</code> will hold the value taken at the time of this
method call.
<p>
The given identifier does not contain the Monitorable PID, i.e. it
specifies the name and not the path of the Status Variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code>, cannot be
<code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>StatusVariable</code> object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>id</code> points to a
non-existing <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
<a name="notifiesOnChange-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifiesOnChange</h4>
<pre>boolean notifiesOnChange(java.lang.String id)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Tells whether the <code>StatusVariable</code> provider is able to send instant
notifications when the given <code>StatusVariable</code> changes. If the
<code>Monitorable</code> supports sending change updates it must notify the
<code>MonitorListener</code> when the value of the <code>StatusVariable</code>
changes. The <code>Monitorable</code> finds the <code>MonitorListener</code>
service through the Service Registry.
<p>
The given identifier does not contain the Monitorable PID, i.e. it
specifies the name and not the path of the Status Variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code>, cannot be
<code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the <code>Monitorable</code> can send notification
when the given <code>StatusVariable</code> changes, <code>false</code>
otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>id</code> points to a
non-existing <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
<a name="resetStatusVariable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetStatusVariable</h4>
<pre>boolean resetStatusVariable(java.lang.String id)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Issues a request to reset a given <code>StatusVariable</code>. Depending on
the semantics of the actual Status Variable this call may or may not
succeed: it makes sense to reset a counter to its starting value, but for
example a <code>StatusVariable</code> of type <code>String</code> might not have a
meaningful default value. Note that for numeric <code>StatusVariables</code>
the starting value may not necessarily be 0. Resetting a
<code>StatusVariable</code> must trigger a monitor event.
<p>
The given identifier does not contain the Monitorable PID, i.e. it
specifies the name and not the path of the Status Variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code>, cannot be
<code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the <code>Monitorable</code> could successfully reset
the given <code>StatusVariable</code>, <code>false</code> otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>id</code> points to a
non-existing <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
<a name="getDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDescription</h4>
<pre>java.lang.String getDescription(java.lang.String id)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Returns a human readable description of a <code>StatusVariable</code>. This
can be used by management systems on their GUI. The <code>null</code> return
value is allowed if there is no description for the specified Status
Variable.
<p>
The given identifier does not contain the Monitorable PID, i.e. it
specifies the name and not the path of the Status Variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the identifier of the <code>StatusVariable</code>, cannot be
<code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the human readable description of this <code>StatusVariable</code> or
<code>null</code> if it is not set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>id</code> points to a
non-existing <code>StatusVariable</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/osgi/service/monitor/MonitorAdmin.html" title="interface in org.osgi.service.monitor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/monitor/Monitorable.html" target="_top">Frames</a></li>
<li><a href="Monitorable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|