/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/cm/ConfigurationEvent.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 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 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 | <!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>ConfigurationEvent</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="ConfigurationEvent";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationException.html" title="class in org.osgi.service.cm"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/cm/ConfigurationEvent.html" target="_top">Frames</a></li>
<li><a href="ConfigurationEvent.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.cm</div>
<h2 title="Class ConfigurationEvent" class="title">Class ConfigurationEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.cm.ConfigurationEvent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ConfigurationEvent</span>
extends java.lang.Object</pre>
<div class="block">A Configuration Event.
<p>
<code>ConfigurationEvent</code> objects are delivered to all registered
<code>ConfigurationListener</code> service objects. ConfigurationEvents must be
asynchronously delivered in chronological order with respect to each
listener.
<p>
A type code is used to identify the type of event. The following event types
are defined:
<ul>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_UPDATED"><code>CM_UPDATED</code></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_DELETED"><code>CM_DELETED</code></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_LOCATION_CHANGED"><code>CM_LOCATION_CHANGED</code></a></li>
</ul>
Additional event types may be defined in the future.
<p>
Security Considerations. <code>ConfigurationEvent</code> objects do not provide
<code>Configuration</code> objects, so no sensitive configuration information is
available from the event. If the listener wants to locate the
<code>Configuration</code> object for the specified pid, it must use
<code>ConfigurationAdmin</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/cm/ConfigurationListener.html" title="interface in org.osgi.service.cm"><code>ConfigurationListener</code></a></dd>
</dl>
</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_DELETED">CM_DELETED</a></span></code>
<div class="block">A <code>Configuration</code> has been deleted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_LOCATION_CHANGED">CM_LOCATION_CHANGED</a></span></code>
<div class="block">The location of a <code>Configuration</code> has been changed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_UPDATED">CM_UPDATED</a></span></code>
<div class="block">A <code>Configuration</code> has been updated.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#ConfigurationEvent-org.osgi.framework.ServiceReference-int-java.lang.String-java.lang.String-">ConfigurationEvent</a></span>(org.osgi.framework.ServiceReference<<a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm">ConfigurationAdmin</a>> reference,
int type,
java.lang.String factoryPid,
java.lang.String pid)</code>
<div class="block">Constructs a <code>ConfigurationEvent</code> object from the given
<code>ServiceReference</code> object, event type, and pids.</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="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/cm/ConfigurationEvent.html#getFactoryPid--">getFactoryPid</a></span>()</code>
<div class="block">Returns the factory pid of the associated configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#getPid--">getPid</a></span>()</code>
<div class="block">Returns the pid of the associated configuration.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.osgi.framework.ServiceReference<<a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm">ConfigurationAdmin</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#getReference--">getReference</a></span>()</code>
<div class="block">Return the <code>ServiceReference</code> object of the Configuration Admin
service that created this event.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#getType--">getType</a></span>()</code>
<div class="block">Return the type of this event.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="CM_UPDATED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CM_UPDATED</h4>
<pre>public static final int CM_UPDATED</pre>
<div class="block">A <code>Configuration</code> has been updated.
<p>
This <code>ConfigurationEvent</code> type that indicates that a
<code>Configuration</code> object has been updated with new properties.
An event is fired when a call to <a href="../../../../org/osgi/service/cm/Configuration.html#update-java.util.Dictionary-"><code>Configuration.update(Dictionary)</code></a>
successfully changes a configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.cm.ConfigurationEvent.CM_UPDATED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_DELETED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CM_DELETED</h4>
<pre>public static final int CM_DELETED</pre>
<div class="block">A <code>Configuration</code> has been deleted.
<p>
This <code>ConfigurationEvent</code> type that indicates that a
<code>Configuration</code> object has been deleted.
An event is fired when a call to <a href="../../../../org/osgi/service/cm/Configuration.html#delete--"><code>Configuration.delete()</code></a>
successfully deletes a configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.cm.ConfigurationEvent.CM_DELETED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CM_LOCATION_CHANGED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CM_LOCATION_CHANGED</h4>
<pre>public static final int CM_LOCATION_CHANGED</pre>
<div class="block">The location of a <code>Configuration</code> has been changed.
<p>
This <code>ConfigurationEvent</code> type that indicates that the location of
a <code>Configuration</code> object has been changed.
An event is fired when a call to
<a href="../../../../org/osgi/service/cm/Configuration.html#setBundleLocation-java.lang.String-"><code>Configuration.setBundleLocation(String)</code></a> successfully changes the
location.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.cm.ConfigurationEvent.CM_LOCATION_CHANGED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConfigurationEvent-org.osgi.framework.ServiceReference-int-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigurationEvent</h4>
<pre>public ConfigurationEvent(org.osgi.framework.ServiceReference<<a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm">ConfigurationAdmin</a>> reference,
int type,
java.lang.String factoryPid,
java.lang.String pid)</pre>
<div class="block">Constructs a <code>ConfigurationEvent</code> object from the given
<code>ServiceReference</code> object, event type, and pids.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reference</code> - The <code>ServiceReference</code> object of the Configuration
Admin service that created this event.</dd>
<dd><code>type</code> - The event type. See <a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#getType--"><code>getType()</code></a>.</dd>
<dd><code>factoryPid</code> - The factory pid of the associated configuration if the
target of the configuration is a ManagedServiceFactory. Otherwise
<code>null</code> if the target of the configuration is a
ManagedService.</dd>
<dd><code>pid</code> - The pid of the associated configuration.</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="getFactoryPid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactoryPid</h4>
<pre>public java.lang.String getFactoryPid()</pre>
<div class="block">Returns the factory pid of the associated configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the factory pid of the associated configuration if the
target of the configuration is a ManagedServiceFactory. Otherwise
<code>null</code> if the target of the configuration is a
ManagedService.</dd>
</dl>
</li>
</ul>
<a name="getPid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPid</h4>
<pre>public java.lang.String getPid()</pre>
<div class="block">Returns the pid of the associated configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the pid of the associated configuration.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public int getType()</pre>
<div class="block">Return the type of this event.
<p>
The type values are:
<ul>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_UPDATED"><code>CM_UPDATED</code></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_DELETED"><code>CM_DELETED</code></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html#CM_LOCATION_CHANGED"><code>CM_LOCATION_CHANGED</code></a></li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type of this event.</dd>
</dl>
</li>
</ul>
<a name="getReference--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getReference</h4>
<pre>public org.osgi.framework.ServiceReference<<a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm">ConfigurationAdmin</a>> getReference()</pre>
<div class="block">Return the <code>ServiceReference</code> object of the Configuration Admin
service that created this event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>ServiceReference</code> object for the Configuration Admin
service that created this event.</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/cm/ConfigurationAdmin.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/ConfigurationException.html" title="class in org.osgi.service.cm"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/cm/ConfigurationEvent.html" target="_top">Frames</a></li>
<li><a href="ConfigurationEvent.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|