/usr/share/doc/libosgi-compendium-java/api/org/osgi/application/ApplicationContext.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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 | <!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>ApplicationContext</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="ApplicationContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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/application/ApplicationServiceEvent.html" title="class in org.osgi.application"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/application/ApplicationContext.html" target="_top">Frames</a></li>
<li><a href="ApplicationContext.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.application</div>
<h2 title="Interface ApplicationContext" class="title">Interface ApplicationContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ApplicationContext</span></pre>
<div class="block"><code>ApplicationContext</code> is the access point for an OSGi-aware application
to the features of the OSGi Service Platform. Each application instance will
have its own <code>ApplicationContext</code> instance, which will not be reused
after destroying the corresponding application instance.
<p>
Application instances can obtain their <code>ApplicationContext</code> using the
<a href="../../../org/osgi/application/Framework.html#getApplicationContext-java.lang.Object-"><code>Framework.getApplicationContext(Object)</code></a> method.
<p>
The lifecycle of an <code>ApplicationContext</code> instance is bound to the
lifecycle of the corresponding application instance. The
<code>ApplicationContext</code> becomes available when the application is started
and it is invalidated when the application instance is stopped (i.e. the
"stop" method of the application activator object returned). All method calls
(except <a href="../../../org/osgi/application/ApplicationContext.html#getApplicationId--"><code>getApplicationId()</code></a> and <a href="../../../org/osgi/application/ApplicationContext.html#getInstanceId--"><code>getInstanceId()</code></a>) to an
invalidated context object result an <code>IllegalStateException</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/osgi/application/Framework.html" title="class in org.osgi.application"><code>Framework</code></a></dd>
</dl>
</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#addServiceListener-org.osgi.application.ApplicationServiceListener-java.lang.String-">addServiceListener</a></span>(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener,
java.lang.String referenceName)</code>
<div class="block">Adds the specified <a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object to this
context application instance's list of listeners.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#addServiceListener-org.osgi.application.ApplicationServiceListener-java.lang.String:A-">addServiceListener</a></span>(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener,
java.lang.String[] referenceNames)</code>
<div class="block">Adds the specified <a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object to this
context application instance's list of listeners.</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/application/ApplicationContext.html#getApplicationId--">getApplicationId</a></span>()</code>
<div class="block">This method return the identifier of the corresponding application type.</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/application/ApplicationContext.html#getInstanceId--">getInstanceId</a></span>()</code>
<div class="block">This method returns the identifier of the corresponding application
instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#getServiceProperties-java.lang.Object-">getServiceProperties</a></span>(java.lang.Object serviceObject)</code>
<div class="block">Application can query the service properties of a service object it is
bound to.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#getStartupParameters--">getStartupParameters</a></span>()</code>
<div class="block">Returns the startup parameters specified when calling the
<code>org.osgi.service.application.ApplicationDescriptor#launch(Map)</code>
method.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#locateService-java.lang.String-">locateService</a></span>(java.lang.String referenceName)</code>
<div class="block">This method returns the service object for the specified
<code>referenceName</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Object[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#locateServices-java.lang.String-">locateServices</a></span>(java.lang.String referenceName)</code>
<div class="block">This method returns the service objects for the specified
<code>referenceName</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.osgi.framework.ServiceRegistration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#registerService-java.lang.String:A-java.lang.Object-java.util.Dictionary-">registerService</a></span>(java.lang.String[] clazzes,
java.lang.Object service,
java.util.Dictionary properties)</code>
<div class="block">Registers the specified service object with the specified properties
under the specified class names into the Framework.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.osgi.framework.ServiceRegistration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#registerService-java.lang.String-java.lang.Object-java.util.Dictionary-">registerService</a></span>(java.lang.String clazz,
java.lang.Object service,
java.util.Dictionary properties)</code>
<div class="block">Registers the specified service object with the specified properties
under the specified class name with the Framework.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/osgi/application/ApplicationContext.html#removeServiceListener-org.osgi.application.ApplicationServiceListener-">removeServiceListener</a></span>(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener)</code>
<div class="block">Removes the specified
<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object from this
context application instances's list of listeners.</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="addServiceListener-org.osgi.application.ApplicationServiceListener-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addServiceListener</h4>
<pre>void addServiceListener(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener,
java.lang.String referenceName)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Adds the specified <a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object to this
context application instance's list of listeners. The specified
<code>referenceName</code> is a reference name specified in the descriptor of
the corresponding application. The registered <code>listener</code> will only
receive the <a href="../../../org/osgi/application/ApplicationServiceEvent.html" title="class in org.osgi.application"><code>ApplicationServiceEvent</code></a>s related to the referred
service.
<p>
If the <code>listener</code> was already added, calling this method will
overwrite the previous registration.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The
<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> to be
added. It must not be <code>null</code></dd>
<dd><code>referenceName</code> - the reference name of a service from the descriptor
of the corresponding application. It must not be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
<dd><code>java.lang.NullPointerException</code> - If <code>listener</code> or
<code>referenceName</code> is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - If there is no service in the
application descriptor with the specified <code>referenceName</code>.</dd>
</dl>
</li>
</ul>
<a name="addServiceListener-org.osgi.application.ApplicationServiceListener-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addServiceListener</h4>
<pre>void addServiceListener(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener,
java.lang.String[] referenceNames)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Adds the specified <a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object to this
context application instance's list of listeners. The
<code>referenceNames</code> parameter is an array of reference name specified
in the descriptor of the corresponding application. The registered
<code>listener</code> will only receive the <a href="../../../org/osgi/application/ApplicationServiceEvent.html" title="class in org.osgi.application"><code>ApplicationServiceEvent</code></a>s
related to the referred services.
<p>
If the <code>listener</code> was already added, calling this method will
overwrite the previous registration.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The
<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> to be
added. It must not be <code>null</code></dd>
<dd><code>referenceNames</code> - and array of service reference names from the
descriptor of the corresponding application. It must not be
<code>null</code> and it must not be empty.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
<dd><code>java.lang.NullPointerException</code> - If <code>listener</code> or
<code>referenceNames</code> is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - If <code>referenceNames</code>
array is empty or it contains unknown references</dd>
</dl>
</li>
</ul>
<a name="removeServiceListener-org.osgi.application.ApplicationServiceListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeServiceListener</h4>
<pre>void removeServiceListener(<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application">ApplicationServiceListener</a> listener)</pre>
<div class="block">Removes the specified
<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object from this
context application instances's list of listeners.
<p>
If <code>listener</code> is not contained in this context application
instance's list of listeners, this method does nothing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The
<a href="../../../org/osgi/application/ApplicationServiceListener.html" title="interface in org.osgi.application"><code>ApplicationServiceListener</code></a> object to
be removed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
</dl>
</li>
</ul>
<a name="getInstanceId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceId</h4>
<pre>java.lang.String getInstanceId()</pre>
<div class="block">This method returns the identifier of the corresponding application
instance. This identifier is guaranteed to be unique within the scope of
the device.
Note: this method can safely be called on an invalid
<code>ApplicationContext</code> as well.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique identifier of the corresponding application instance</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/osgi/service/application/ApplicationHandle.html#getInstanceId--"><code>ApplicationHandle.getInstanceId()</code></a></dd>
</dl>
</li>
</ul>
<a name="getApplicationId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationId</h4>
<pre>java.lang.String getApplicationId()</pre>
<div class="block">This method return the identifier of the corresponding application type.
This identifier is the same for the different instances of the same
application but it is different for different application type.
<p>
Note: this method can safely be called on an invalid
<code>ApplicationContext</code> as well.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identifier of the application type.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/osgi/service/application/ApplicationDescriptor.html#getApplicationId--"><code>ApplicationDescriptor.getApplicationId()</code></a></dd>
</dl>
</li>
</ul>
<a name="locateService-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locateService</h4>
<pre>java.lang.Object locateService(java.lang.String referenceName)</pre>
<div class="block">This method returns the service object for the specified
<code>referenceName</code>. If the cardinality of the reference is 0..n or
1..n and multiple services are bound to the reference, the service with
the highest ranking (as specified in its
<code>Constants.SERVICE_RANKING</code> property) is
returned. If there is a tie in ranking, the service with the lowest
service ID (as specified in its
<code>Constants.SERVICE_ID</code> property); that is, the
service that was registered first is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>referenceName</code> - The name of a reference as specified in a reference
element in this context applications's description. It must not be
<code>null</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A service object for the referenced service or <code>null</code> if
the reference cardinality is 0..1 or 0..n and no bound service is
available.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - If <code>referenceName</code> is
<code>null</code>.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If there is no service in the
application descriptor with the specified <code>referenceName</code>.</dd>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
</dl>
</li>
</ul>
<a name="locateServices-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locateServices</h4>
<pre>java.lang.Object[] locateServices(java.lang.String referenceName)</pre>
<div class="block">This method returns the service objects for the specified
<code>referenceName</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>referenceName</code> - The name of a reference as specified in a reference
element in this context applications's description. It must not be
<code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of service object for the referenced service or
<code>null</code> if the reference cardinality is 0..1 or 0..n and no
bound service is available.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - If <code>referenceName</code> is
<code>null</code>.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If there is no service in the
application descriptor with the specified <code>referenceName</code>.</dd>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
</dl>
</li>
</ul>
<a name="getStartupParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartupParameters</h4>
<pre>java.util.Map getStartupParameters()</pre>
<div class="block">Returns the startup parameters specified when calling the
<code>org.osgi.service.application.ApplicationDescriptor#launch(Map)</code>
method.
<p>
Startup arguments can be specified as name, value pairs. The name must be
of type <code>String</code>, which must not be <code>null</code> or empty
<code>String</code> (<code>""</code>), the value can be any object
including <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Map</code> containing the startup arguments. It can
be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
</dl>
</li>
</ul>
<a name="getServiceProperties-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceProperties</h4>
<pre>java.util.Map getServiceProperties(java.lang.Object serviceObject)</pre>
<div class="block">Application can query the service properties of a service object it is
bound to. Application gets bound to a service object when it first
obtains a reference to the service by calling <code>locateService</code> or
<code>locateServices</code> methods.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceObject</code> - A service object the application is bound to. It
must not be null.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The service properties associated with the specified service
object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the specified <code>serviceObject</code> is
<code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the application is not bound to the
specified service object or it is not a service object at all.</dd>
<dd><code>java.lang.IllegalStateException</code> - If this context application
instance has stopped.</dd>
</dl>
</li>
</ul>
<a name="registerService-java.lang.String:A-java.lang.Object-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerService</h4>
<pre>org.osgi.framework.ServiceRegistration registerService(java.lang.String[] clazzes,
java.lang.Object service,
java.util.Dictionary properties)</pre>
<div class="block">Registers the specified service object with the specified properties
under the specified class names into the Framework. A
<code>ServiceRegistration</code> object is returned. The
<code>ServiceRegistration</code> object is for the private
use of the application registering the service and should not be shared
with other applications. The registering application is defined to be the
context application. Bundles can locate the service by using either the
<code>BundleContext.getServiceReferences(String, String)</code>
or <code>BundleContext.getServiceReference(String)</code>
method. Other applications can locate this service by using
<a href="../../../org/osgi/application/ApplicationContext.html#locateService-java.lang.String-"><code>locateService(String)</code></a> or <a href="../../../org/osgi/application/ApplicationContext.html#locateServices-java.lang.String-"><code>locateServices(String)</code></a> method,
if they declared their dependence on the registered service.
<p>
An application can register a service object that implements the
<code>ServiceFactory</code> interface to have more
flexibility in providing service objects to other applications or
bundles.
<p>
The following steps are required to register a service:
<ol>
<li>If <code>service</code> is not a <code>ServiceFactory</code>, an
<code>IllegalArgumentException</code> is thrown if <code>service</code> is not an
<code>instanceof</code> all the classes named.</li>
<li>The Framework adds these service properties to the specified
<code>Dictionary</code> (which may be <code>null</code>): a property named
<code>Constants.SERVICE_ID</code> identifying the
registration number of the service and a property named
<code>Constants.OBJECTCLASS</code> containing all the
specified classes. If any of these properties have already been specified
by the registering bundle, their values will be overwritten by the
Framework.</li>
<li>The service is added to the Framework service registry and may now be
used by others.</li>
<li>A service event of type
<code>ServiceEvent.REGISTERED</code> is fired. This event
triggers the corresponding <a href="../../../org/osgi/application/ApplicationServiceEvent.html" title="class in org.osgi.application"><code>ApplicationServiceEvent</code></a> to be
delivered to the applications that registered the appropriate listener.</li>
<li>A <code>ServiceRegistration</code> object for this registration is
returned.</li>
</ol></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazzes</code> - The class names under which the service can be located.
The class names in this array will be stored in the service's
properties under the key
<code>Constants.OBJECTCLASS</code>. This parameter
must not be <code>null</code>.</dd>
<dd><code>service</code> - The service object or a <code>ServiceFactory</code> object.</dd>
<dd><code>properties</code> - The properties for this service. The keys in the
properties object must all be <code>String</code> objects. See
<code>Constants</code> for a list of standard
service property keys. Changes should not be made to this object
after calling this method. To update the service's properties the
<code>ServiceRegistration.setProperties(Dictionary)</code>
method must be called. The set of properties may be <code>null</code>
if the service has no properties.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>ServiceRegistration</code> object for use
by the application registering the service to update the
service's properties or to unregister the service.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If one of the following is
true:
<ul>
<li><code>service</code> is <code>null</code>.</li><li><code>service</code> is
not a <code>ServiceFactory</code> object and is not an instance of all
the named classes in <code>clazzes</code>.</li><li><code>properties</code>
contains case variants of the same key name.</li>
</ul></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>clazzes</code> is <code>null</code></dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the
<code>ServicePermission</code> to register the service for all the
named classes and the Java Runtime Environment supports
permissions.</dd>
<dd><code>java.lang.IllegalStateException</code> - If this ApplicationContext is no
longer valid.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>BundleContext.registerService(java.lang.String[],
java.lang.Object, java.util.Dictionary)</code>,
<code>ServiceRegistration</code>,
<code>ServiceFactory</code></dd>
</dl>
</li>
</ul>
<a name="registerService-java.lang.String-java.lang.Object-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>registerService</h4>
<pre>org.osgi.framework.ServiceRegistration registerService(java.lang.String clazz,
java.lang.Object service,
java.util.Dictionary properties)</pre>
<div class="block">Registers the specified service object with the specified properties
under the specified class name with the Framework.
<p>
This method is otherwise identical to
<a href="../../../org/osgi/application/ApplicationContext.html#registerService-java.lang.String:A-java.lang.Object-java.util.Dictionary-"><code>registerService(java.lang.String[], java.lang.Object, java.util.Dictionary)</code></a>
and is provided as a convenience when <code>service</code> will only be
registered under a single class name. Note that even in this case the
value of the service's <code>Constants.OBJECTCLASS</code> property will be an
array of strings, rather than just a single string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - The class name under which the service can be located. It
must not be <code>null</code></dd>
<dd><code>service</code> - The service object or a <code>ServiceFactory</code> object.</dd>
<dd><code>properties</code> - The properties for this service.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>ServiceRegistration</code> object for use by the application
registering the service to update the service's properties or to
unregister the service.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If one of the following is
true:
<ul>
<li><code>service</code> is <code>null</code>.</li><li><code>service</code> is
not a <code>ServiceFactory</code> object and is not an instance of the
named class in <code>clazz</code>.</li><li><code>properties</code> contains
case variants of the same key name.</li>
</ul></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>clazz</code> is <code>null</code></dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the
<code>ServicePermission</code> to register the service the named class
and the Java Runtime Environment supports permissions.</dd>
<dd><code>java.lang.IllegalStateException</code> - If this ApplicationContext is no
longer valid.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/osgi/application/ApplicationContext.html#registerService-java.lang.String:A-java.lang.Object-java.util.Dictionary-"><code>registerService(java.lang.String[], java.lang.Object,
java.util.Dictionary)</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>
<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/application/ApplicationServiceEvent.html" title="class in org.osgi.application"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/application/ApplicationContext.html" target="_top">Frames</a></li>
<li><a href="ApplicationContext.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>
|