/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/component/ComponentContext.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 | <!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>ComponentContext</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="ComponentContext";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/component/ComponentConstants.html" title="interface in org.osgi.service.component"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/component/ComponentException.html" title="class in org.osgi.service.component"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/component/ComponentContext.html" target="_top">Frames</a></li>
<li><a href="ComponentContext.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.component</div>
<h2 title="Interface ComponentContext" class="title">Interface ComponentContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ComponentContext</span></pre>
<div class="block">A Component Context object is used by a component instance to interact with
its execution context including locating services by reference name. Each
component instance has a unique Component Context.
<p>
A component instance may have an activate method. If a component instance has
a suitable and accessible activate method, this method will be called when a
component configuration is activated. If the activate method takes a
<code>ComponentContext</code> argument, it will be passed the component instance's
Component Context object. If the activate method takes a
<code>BundleContext</code> argument, it will be passed the component instance's
Bundle Context object. If the activate method takes a <code>Map</code> argument,
it will be passed an unmodifiable Map containing the component properties.
<p>
A component instance may have a deactivate method. If a component instance
has a suitable and accessible deactivate method, this method will be called
when the component configuration is deactivated. If the deactivate method
takes a <code>ComponentContext</code> argument, it will be passed the component
instance's Component Context object. If the deactivate method takes a
<code>BundleContext</code> argument, it will be passed the component instance's
Bundle Context object. If the deactivate method takes a <code>Map</code> argument,
it will be passed an unmodifiable Map containing the component properties. If
the deactivate method takes an <code>int</code> or <code>Integer</code> argument, it
will be passed the reason code for the component instance's deactivation.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#disableComponent-java.lang.String-">disableComponent</a></span>(java.lang.String name)</code>
<div class="block">Disables the specified component name.</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/service/component/ComponentContext.html#enableComponent-java.lang.String-">enableComponent</a></span>(java.lang.String name)</code>
<div class="block">Enables the specified component name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.osgi.framework.BundleContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#getBundleContext--">getBundleContext</a></span>()</code>
<div class="block">Returns the <code>BundleContext</code> of the bundle which contains this
component.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/component/ComponentInstance.html" title="interface in org.osgi.service.component">ComponentInstance</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#getComponentInstance--">getComponentInstance</a></span>()</code>
<div class="block">Returns the Component Instance object for the component instance
associated with this Component Context.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Dictionary<java.lang.String,java.lang.Object></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Returns the component properties for this Component Context.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.osgi.framework.ServiceReference</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#getServiceReference--">getServiceReference</a></span>()</code>
<div class="block">If the component instance is registered as a service using the
<code>service</code> element, then this method returns the service reference
of the service provided by this component instance.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>org.osgi.framework.Bundle</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#getUsingBundle--">getUsingBundle</a></span>()</code>
<div class="block">If the component instance is registered as a service using the
<code>servicefactory="true"</code> attribute, then this method returns the
bundle using the service provided by the component instance.</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/service/component/ComponentContext.html#locateService-java.lang.String-">locateService</a></span>(java.lang.String name)</code>
<div class="block">Returns the service object for the specified reference name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#locateService-java.lang.String-org.osgi.framework.ServiceReference-">locateService</a></span>(java.lang.String name,
org.osgi.framework.ServiceReference reference)</code>
<div class="block">Returns the service object for the specified reference name and
<code>ServiceReference</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.Object[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/component/ComponentContext.html#locateServices-java.lang.String-">locateServices</a></span>(java.lang.String name)</code>
<div class="block">Returns the service objects for the specified reference name.</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="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>java.util.Dictionary<java.lang.String,java.lang.Object> getProperties()</pre>
<div class="block">Returns the component properties for this Component Context.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The properties for this Component Context. The Dictionary is read
only and cannot be modified.</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 name)</pre>
<div class="block">Returns the service object for the specified reference name.
<p>
If the cardinality of the reference is <code>0..n</code> or <code>1..n</code> 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>name</code> - The name of a reference as specified in a <code>reference</code>
element in this component's description.</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 <code>0..1</code> or <code>0..n</code> and no
bound service is available.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/component/ComponentException.html" title="class in org.osgi.service.component">ComponentException</a></code> - If the Service Component Runtime catches an
exception while activating the bound service.</dd>
</dl>
</li>
</ul>
<a name="locateService-java.lang.String-org.osgi.framework.ServiceReference-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locateService</h4>
<pre>java.lang.Object locateService(java.lang.String name,
org.osgi.framework.ServiceReference reference)</pre>
<div class="block">Returns the service object for the specified reference name and
<code>ServiceReference</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of a reference as specified in a <code>reference</code>
element in this component's description.</dd>
<dd><code>reference</code> - The <code>ServiceReference</code> to a bound service. This
must be a <code>ServiceReference</code> provided to the component via
the bind or unbind method for the specified reference name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A service object for the referenced service or <code>null</code> if
the specified <code>ServiceReference</code> is not a bound service for
the specified reference name.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/component/ComponentException.html" title="class in org.osgi.service.component">ComponentException</a></code> - If the Service Component Runtime catches an
exception while activating the bound service.</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 name)</pre>
<div class="block">Returns the service objects for the specified reference name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of a reference as specified in a <code>reference</code>
element in this component's description.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of service objects for the referenced service or
<code>null</code> if the reference cardinality is <code>0..1</code> or
<code>0..n</code> and no bound service is available. If the reference
cardinality is <code>0..1</code> or <code>1..1</code> and a bound service
is available, the array will have exactly one element.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/component/ComponentException.html" title="class in org.osgi.service.component">ComponentException</a></code> - If the Service Component Runtime catches an
exception while activating a bound service.</dd>
</dl>
</li>
</ul>
<a name="getBundleContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundleContext</h4>
<pre>org.osgi.framework.BundleContext getBundleContext()</pre>
<div class="block">Returns the <code>BundleContext</code> of the bundle which contains this
component.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>BundleContext</code> of the bundle containing this
component.</dd>
</dl>
</li>
</ul>
<a name="getUsingBundle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsingBundle</h4>
<pre>org.osgi.framework.Bundle getUsingBundle()</pre>
<div class="block">If the component instance is registered as a service using the
<code>servicefactory="true"</code> attribute, then this method returns the
bundle using the service provided by the component instance.
<p>
This method will return <code>null</code> if:
<ul>
<li>The component instance is not a service, then no bundle can be using
it as a service.</li>
<li>The component instance is a service but did not specify the
<code>servicefactory="true"</code> attribute, then all bundles using the
service provided by the component instance will share the same component
instance.</li>
<li>The service provided by the component instance is not currently being
used by any bundle.</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bundle using the component instance as a service or
<code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getComponentInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentInstance</h4>
<pre><a href="../../../../org/osgi/service/component/ComponentInstance.html" title="interface in org.osgi.service.component">ComponentInstance</a> getComponentInstance()</pre>
<div class="block">Returns the Component Instance object for the component instance
associated with this Component Context.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Component Instance object for the component instance.</dd>
</dl>
</li>
</ul>
<a name="enableComponent-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableComponent</h4>
<pre>void enableComponent(java.lang.String name)</pre>
<div class="block">Enables the specified component name. The specified component name must
be in the same bundle as this component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of a component or <code>null</code> to indicate all
components in the bundle.</dd>
</dl>
</li>
</ul>
<a name="disableComponent-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableComponent</h4>
<pre>void disableComponent(java.lang.String name)</pre>
<div class="block">Disables the specified component name. The specified component name must
be in the same bundle as this component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of a component.</dd>
</dl>
</li>
</ul>
<a name="getServiceReference--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServiceReference</h4>
<pre>org.osgi.framework.ServiceReference getServiceReference()</pre>
<div class="block">If the component instance is registered as a service using the
<code>service</code> element, then this method returns the service reference
of the service provided by this component instance.
<p>
This method will return <code>null</code> if the component instance is not
registered as a service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>ServiceReference</code> object for the component instance or
<code>null</code> if the component instance is not registered as a
service.</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/component/ComponentConstants.html" title="interface in org.osgi.service.component"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/component/ComponentException.html" title="class in org.osgi.service.component"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/component/ComponentContext.html" target="_top">Frames</a></li>
<li><a href="ComponentContext.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>
|