/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/dmt/DmtEvent.html is in libosgi-compendium-java-doc 5.0.0-3.
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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>DmtEvent</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DmtEvent";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/dmt/DmtData.html" title="class in org.osgi.service.dmt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/dmt/DmtEventListener.html" title="interface in org.osgi.service.dmt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/DmtEvent.html" target="_top">Frames</a></li>
<li><a href="DmtEvent.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><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </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.dmt</div>
<h2 title="Interface DmtEvent" class="title">Interface DmtEvent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">DmtEvent</span></pre>
<div class="block">Event class storing the details of a change in the tree. <code>DmtEvent</code> is
used by <code>DmtAdmin</code> to notify registered <a href="../../../../org/osgi/service/dmt/DmtEventListener.html" title="interface in org.osgi.service.dmt"><code>EventListeners</code></a> services about important changes. Events are generated after
every successful DMT change, and also when sessions are opened or closed. If
a <a href="../../../../org/osgi/service/dmt/DmtSession.html" title="interface in org.osgi.service.dmt"><code>DmtSession</code></a> is opened in atomic mode, DMT events are only sent when
the session is committed, when the changes are actually performed.
<p>
The <code>type</code> of the event describes the change that triggered the event
delivery. Each event carries the unique identifier of the session in which
the described change happened or -1 when the change originated outside a
session. The events describing changes in the DMT carry the list of affected
nodes. In case of <a href="../../../../org/osgi/service/dmt/DmtEvent.html#COPIED"><code>COPIED</code></a> or <a href="../../../../org/osgi/service/dmt/DmtEvent.html#RENAMED"><code>RENAMED</code></a> events, the event
carries the list of new nodes as well.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#ADDED">ADDED</a></strong></code>
<div class="block">Event type indicating nodes that were added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#COPIED">COPIED</a></strong></code>
<div class="block">Event type indicating nodes that were copied.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#DELETED">DELETED</a></strong></code>
<div class="block">Event type indicating nodes that were deleted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#RENAMED">RENAMED</a></strong></code>
<div class="block">Event type indicating nodes that were renamed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#REPLACED">REPLACED</a></strong></code>
<div class="block">Event type indicating nodes that were replaced.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#SESSION_CLOSED">SESSION_CLOSED</a></strong></code>
<div class="block">Event type indicating that a session was closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#SESSION_OPENED">SESSION_OPENED</a></strong></code>
<div class="block">Event type indicating that a new session was opened.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getNewNodes()">getNewNodes</a></strong>()</code>
<div class="block">This method can be used to query the new nodes, when the type of the
event is <a href="../../../../org/osgi/service/dmt/DmtEvent.html#COPIED"><code>COPIED</code></a> or <a href="../../../../org/osgi/service/dmt/DmtEvent.html#RENAMED"><code>RENAMED</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getNodes()">getNodes</a></strong>()</code>
<div class="block">This method can be used to query the subject nodes of this event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getProperty(java.lang.String)">getProperty</a></strong>(java.lang.String key)</code>
<div class="block">This method can be used to get the value of a single event property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getPropertyNames()">getPropertyNames</a></strong>()</code>
<div class="block">This method can be used to query the names of all properties of this
event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getSessionId()">getSessionId</a></strong>()</code>
<div class="block">This method returns the identifier of the session in which this event
took place.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getType()">getType</a></strong>()</code>
<div class="block">This method returns the type of this event.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ADDED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ADDED</h4>
<pre>static final int ADDED</pre>
<div class="block">Event type indicating nodes that were added.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.ADDED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COPIED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COPIED</h4>
<pre>static final int COPIED</pre>
<div class="block">Event type indicating nodes that were copied.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.COPIED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DELETED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELETED</h4>
<pre>static final int DELETED</pre>
<div class="block">Event type indicating nodes that were deleted.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.DELETED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="RENAMED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RENAMED</h4>
<pre>static final int RENAMED</pre>
<div class="block">Event type indicating nodes that were renamed.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.RENAMED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REPLACED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REPLACED</h4>
<pre>static final int REPLACED</pre>
<div class="block">Event type indicating nodes that were replaced.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.REPLACED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SESSION_OPENED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SESSION_OPENED</h4>
<pre>static final int SESSION_OPENED</pre>
<div class="block">Event type indicating that a new session was opened.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.SESSION_OPENED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SESSION_CLOSED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SESSION_CLOSED</h4>
<pre>static final int SESSION_CLOSED</pre>
<div class="block">Event type indicating that a session was closed. This type of event is
sent when the session is closed by the client or becomes inactive for any
other reason (session timeout, fatal errors in business methods, etc.).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.dmt.DmtEvent.SESSION_CLOSED">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>int getType()</pre>
<div class="block">This method returns the type of this event.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of this event.</dd></dl>
</li>
</ul>
<a name="getSessionId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionId</h4>
<pre>int getSessionId()</pre>
<div class="block">This method returns the identifier of the session in which this event
took place. The ID is guaranteed to be unique on a machine.
<p>
For events that do not result from a session, the session id is -1.
<p>
The availability of a session.id can also be check by using
<code>getProperty()</code> with "session.id" as key.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the unique identifier of the session that triggered the event or
-1 if there is no session associated</dd></dl>
</li>
</ul>
<a name="getNodes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodes</h4>
<pre>java.lang.String[] getNodes()</pre>
<div class="block">This method can be used to query the subject nodes of this event. The
method returns <code>null</code> for <a href="../../../../org/osgi/service/dmt/DmtEvent.html#SESSION_OPENED"><code>SESSION_OPENED</code></a> and
<a href="../../../../org/osgi/service/dmt/DmtEvent.html#SESSION_CLOSED"><code>SESSION_CLOSED</code></a>.
<p>
The method returns only those affected nodes that the caller has the GET
permission for (or in case of <a href="../../../../org/osgi/service/dmt/DmtEvent.html#COPIED"><code>COPIED</code></a> or <a href="../../../../org/osgi/service/dmt/DmtEvent.html#RENAMED"><code>RENAMED</code></a> events,
where the caller has GET permissions for either the source or the
destination nodes). Therefore, it is possible that the method returns an
empty array. All returned URIs are absolute.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the array of affected nodes</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getNewNodes()"><code>getNewNodes()</code></a></dd></dl>
</li>
</ul>
<a name="getNewNodes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewNodes</h4>
<pre>java.lang.String[] getNewNodes()</pre>
<div class="block">This method can be used to query the new nodes, when the type of the
event is <a href="../../../../org/osgi/service/dmt/DmtEvent.html#COPIED"><code>COPIED</code></a> or <a href="../../../../org/osgi/service/dmt/DmtEvent.html#RENAMED"><code>RENAMED</code></a>. For all other event types
this method returns <code>null</code>.
<p>
The array returned by this method runs parallel to the array returned by
<a href="../../../../org/osgi/service/dmt/DmtEvent.html#getNodes()"><code>getNodes()</code></a>, the elements in the two arrays contain the source
and destination URIs for the renamed or copied nodes in the same order.
All returned URIs are absolute.
<p>
This method returns only those nodes where the caller has the GET
permission for the source or destination node of the operation.
Therefore, it is possible that the method returns an empty array.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the array of newly created nodes</dd></dl>
</li>
</ul>
<a name="getPropertyNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyNames</h4>
<pre>java.lang.String[] getPropertyNames()</pre>
<div class="block">This method can be used to query the names of all properties of this
event.
<p>
The returned names can be used as key value in subsequent calls to
<a href="../../../../org/osgi/service/dmt/DmtEvent.html#getProperty(java.lang.String)"><code>getProperty(String)</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the array of property names</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getProperty(java.lang.String)"><code>getProperty(String)</code></a></dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperty</h4>
<pre>java.lang.Object getProperty(java.lang.String key)</pre>
<div class="block">This method can be used to get the value of a single event property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the name of the requested property</dd>
<dt><span class="strong">Returns:</span></dt><dd>the requested property value or null, if the key is not contained
in the properties</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/service/dmt/DmtEvent.html#getPropertyNames()"><code>getPropertyNames()</code></a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/dmt/DmtData.html" title="class in org.osgi.service.dmt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/dmt/DmtEventListener.html" title="interface in org.osgi.service.dmt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/dmt/DmtEvent.html" target="_top">Frames</a></li>
<li><a href="DmtEvent.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><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </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>
|