/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/monitor/MonitoringJob.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 396 | <!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>MonitoringJob</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="MonitoringJob";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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><a href="../../../../org/osgi/service/monitor/MonitorAdmin.html" title="interface in org.osgi.service.monitor"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/monitor/MonitorListener.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/MonitoringJob.html" target="_top">Frames</a></li>
<li><a href="MonitoringJob.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 MonitoringJob" class="title">Interface MonitoringJob</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MonitoringJob</span></pre>
<div class="block">A Monitoring Job is a request for scheduled or event based notifications on
update of a set of <code>StatusVariable</code>s. The job is a data structure that
holds a non-empty list of <code>StatusVariable</code> names, an identification of
the initiator of the job, and the sampling parameters. There are two kinds of
monitoring jobs: time based and change based. Time based jobs take samples of
all <code>StatusVariable</code>s with a specified frequency. The number of samples
to be taken before the job finishes may be specified. Change based jobs are
only interested in the changes of the monitored <code>StatusVariable</code>s. In
this case, the number of changes that must take place between two
notifications can be specified.
<p>
The job can be started on the <code>MonitorAdmin</code> interface. Running the job
(querying the <code>StatusVariable</code>s, listening to changes, and sending out
notifications on updates) is the task of the <code>MonitorAdmin</code>
implementation.
<p>
Whether a monitoring job keeps track dynamically of the
<code>StatusVariable</code>s it monitors is not specified. This means that if we
monitor a <code>StatusVariable</code> of a <code>Monitorable</code> service which
disappears and later reappears then it is implementation specific whether we
still receive updates of the <code>StatusVariable</code> changes or not.</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/MonitoringJob.html#getInitiator--">getInitiator</a></span>()</code>
<div class="block">Returns the identifier of the principal who initiated the job.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/MonitoringJob.html#getReportCount--">getReportCount</a></span>()</code>
<div class="block">Returns the number of times <code>MonitorAdmin</code> will query the
<code>StatusVariable</code>s (for time based jobs), or the number of changes
of a <code>StatusVariable</code> between notifications (for change based
jobs).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/MonitoringJob.html#getSchedule--">getSchedule</a></span>()</code>
<div class="block">Returns the delay (in seconds) between two samples.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/MonitoringJob.html#getStatusVariableNames--">getStatusVariableNames</a></span>()</code>
<div class="block">Returns the list of <code>StatusVariable</code> names that are the targets of
this measurement job.</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/MonitoringJob.html#isLocal--">isLocal</a></span>()</code>
<div class="block">Returns whether the job was started locally or remotely.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/MonitoringJob.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Returns whether the job is running.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/monitor/MonitoringJob.html#stop--">stop</a></span>()</code>
<div class="block">Stops a Monitoring Job.</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="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void stop()</pre>
<div class="block">Stops a Monitoring Job. Note that a time based job can also stop
automatically if the specified number of samples have been taken.</div>
</li>
</ul>
<a name="getInitiator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitiator</h4>
<pre>java.lang.String getInitiator()</pre>
<div class="block">Returns the identifier of the principal who initiated the job. This is
set at the time when <a href="../../../../org/osgi/service/monitor/MonitorAdmin.html#startJob-java.lang.String-java.lang.String:A-int-"><code>MonitorAdmin.startJob</code></a> method is called. This string holds the ServerID
if the operation was initiated from a remote manager, or an arbitrary ID
of the initiator entity in the local case (used for addressing
notification events).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID of the initiator, cannot be <code>null</code></dd>
</dl>
</li>
</ul>
<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> names that are the targets of
this measurement job. For time based jobs, the <code>MonitorAdmin</code> will
iterate through this list and query all <code>StatusVariable</code>s when its
timer set by the job's frequency rate expires.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target list of the measurement job in
[Monitorable_ID]/[StatusVariable_ID] format, cannot be
<code>null</code></dd>
</dl>
</li>
</ul>
<a name="getSchedule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchedule</h4>
<pre>int getSchedule()</pre>
<div class="block">Returns the delay (in seconds) between two samples. If this call returns
N (greater than 0) then the <code>MonitorAdmin</code> queries each
<code>StatusVariable</code> that belongs to this job every N seconds. The
value 0 means that the job is not scheduled but event based: in this case
instant notification on changes is requested (at every n-th change of the
value, as specified by the report count parameter).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the delay (in seconds) between samples, or 0 for change based
jobs</dd>
</dl>
</li>
</ul>
<a name="getReportCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReportCount</h4>
<pre>int getReportCount()</pre>
<div class="block">Returns the number of times <code>MonitorAdmin</code> will query the
<code>StatusVariable</code>s (for time based jobs), or the number of changes
of a <code>StatusVariable</code> between notifications (for change based
jobs). Time based jobs with non-zero report count will take
<code>getReportCount()</code>*<code>getSchedule()</code> time to finish. Time based
jobs with 0 report count and change based jobs do not stop automatically,
but all jobs can be stopped with the <a href="../../../../org/osgi/service/monitor/MonitoringJob.html#stop--"><code>stop()</code></a> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of measurements to be taken, or the number of changes
between notifications</dd>
</dl>
</li>
</ul>
<a name="isLocal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLocal</h4>
<pre>boolean isLocal()</pre>
<div class="block">Returns whether the job was started locally or remotely. Jobs started by
the clients of this API are always local, remote jobs can only be started
using the Device Management Tree.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the job was started from the local device,
<code>false</code> if the job was initiated from a management server
through the device management tree</dd>
</dl>
</li>
</ul>
<a name="isRunning--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isRunning</h4>
<pre>boolean isRunning()</pre>
<div class="block">Returns whether the job is running. A job is running until it is
explicitly stopped, or, in case of time based jobs with a finite report
count, until the given number of measurements have been made.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the job is still running, <code>false</code> if it has
finished</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><a href="../../../../org/osgi/service/monitor/MonitorAdmin.html" title="interface in org.osgi.service.monitor"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/monitor/MonitorListener.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/MonitoringJob.html" target="_top">Frames</a></li>
<li><a href="MonitoringJob.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>
|