/usr/share/doc/libosgi-core-java/api/org/osgi/framework/ServiceObjects.html is in libosgi-core-java-doc 6.0.0-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ServiceObjects</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="ServiceObjects";
}
//-->
</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/framework/ServiceListener.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/ServicePermission.html" title="class in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceObjects.html" target="_top">Frames</a></li>
<li><a href="ServiceObjects.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.framework</div>
<h2 title="Interface ServiceObjects" class="title">Interface ServiceObjects<S></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - Type of Service</dd></dl>
<hr>
<br>
<pre>@ProviderType
public interface <span class="strong">ServiceObjects<S></span></pre>
<div class="block">Allows multiple service objects for a service to be obtained.
<p>
For services with <a href="../../../org/osgi/framework/Constants.html#SCOPE_PROTOTYPE"><code>prototype</code></a> scope, multiple
service objects for the service can be obtained. For services with
<a href="../../../org/osgi/framework/Constants.html#SCOPE_SINGLETON"><code>singleton</code></a> or <a href="../../../org/osgi/framework/Constants.html#SCOPE_BUNDLE"><code>bundle</code></a> scope, only one, use-counted service object is available to a
requesting bundle.
<p>
Any unreleased service objects obtained from this <code>ServiceObjects</code>
object are automatically released by the framework when the bundle associated
with the BundleContext used to create this <code>ServiceObjects</code> object is
stopped.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.8</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/BundleContext.html#getServiceObjects(org.osgi.framework.ServiceReference)"><code>BundleContext.getServiceObjects(ServiceReference)</code></a>,
<a href="../../../org/osgi/framework/PrototypeServiceFactory.html" title="interface in org.osgi.framework"><code>PrototypeServiceFactory</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="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><a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceObjects.html#getService()">getService</a></strong>()</code>
<div class="block">Returns a service object for the <a href="../../../org/osgi/framework/ServiceObjects.html#getServiceReference()"><code>associated</code></a> service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><<a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceObjects.html#getServiceReference()">getServiceReference</a></strong>()</code>
<div class="block">Returns the <a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework"><code>ServiceReference</code></a> for the service associated with this
<code>ServiceObjects</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceObjects.html#ungetService(S)">ungetService</a></strong>(<a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a> service)</code>
<div class="block">Releases a service object for the <a href="../../../org/osgi/framework/ServiceObjects.html#getServiceReference()"><code>associated</code></a> service.</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="getService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getService</h4>
<pre><a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a> getService()</pre>
<div class="block">Returns a service object for the <a href="../../../org/osgi/framework/ServiceObjects.html#getServiceReference()"><code>associated</code></a> service.
<p>
This <code>ServiceObjects</code> object can be used to obtain multiple service
objects for the associated service if the service has
<a href="../../../org/osgi/framework/Constants.html#SCOPE_PROTOTYPE"><code>prototype</code></a> scope.
<p>
If the associated service has <a href="../../../org/osgi/framework/Constants.html#SCOPE_SINGLETON"><code>singleton</code></a>
or <a href="../../../org/osgi/framework/Constants.html#SCOPE_BUNDLE"><code>bundle</code></a> scope, this method behaves the
same as calling the <a href="../../../org/osgi/framework/BundleContext.html#getService(org.osgi.framework.ServiceReference)"><code>BundleContext.getService(ServiceReference)</code></a>
method for the associated service. That is, only one, use-counted service
object is available from this <a href="../../../org/osgi/framework/ServiceObjects.html" title="interface in org.osgi.framework"><code>ServiceObjects</code></a> object.
<p>
This method will always return <code>null</code> when the associated service
has been unregistered.
<p>
For a prototype scope service, the following steps are required to obtain
a service object:
<ol>
<li>If the associated service has been unregistered, <code>null</code> is
returned.</li>
<li>The
<a href="../../../org/osgi/framework/PrototypeServiceFactory.html#getService(org.osgi.framework.Bundle,%20org.osgi.framework.ServiceRegistration)"><code>PrototypeServiceFactory.getService(Bundle, ServiceRegistration)</code></a>
method is called to supply a customized service object for the caller.</li>
<li>If the service object returned by the <code>PrototypeServiceFactory</code>
object is <code>null</code>, not an <code>instanceof</code> all the classes named
when the service was registered or the <code>PrototypeServiceFactory</code>
object throws an exception, <code>null</code> is returned and a Framework
event of type <a href="../../../org/osgi/framework/FrameworkEvent.html#ERROR"><code>FrameworkEvent.ERROR</code></a> containing a
<a href="../../../org/osgi/framework/ServiceException.html" title="class in org.osgi.framework"><code>ServiceException</code></a> describing the error is fired.</li>
<li>The customized service object is returned.</li>
</ol></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A service object for the associated service or <code>null</code> if
the service is not registered, the customized service object
returned by a <code>ServiceFactory</code> does not implement the
classes under which it was registered or the
<code>ServiceFactory</code> threw an exception.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If the BundleContext used to create this
<code>ServiceObjects</code> object is no longer valid.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/ServiceObjects.html#ungetService(S)"><code>ungetService(Object)</code></a></dd></dl>
</li>
</ul>
<a name="ungetService(java.lang.Object)">
<!-- -->
</a><a name="ungetService(S)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ungetService</h4>
<pre>void ungetService(<a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a> service)</pre>
<div class="block">Releases a service object for the <a href="../../../org/osgi/framework/ServiceObjects.html#getServiceReference()"><code>associated</code></a> service.
<p>
This <code>ServiceObjects</code> object can be used to obtain multiple service
objects for the associated service if the service has
<a href="../../../org/osgi/framework/Constants.html#SCOPE_PROTOTYPE"><code>prototype</code></a> scope. If the associated
service has <a href="../../../org/osgi/framework/Constants.html#SCOPE_SINGLETON"><code>singleton</code></a> or
<a href="../../../org/osgi/framework/Constants.html#SCOPE_BUNDLE"><code>bundle</code></a> scope, this method behaves the same
as calling the <a href="../../../org/osgi/framework/BundleContext.html#ungetService(org.osgi.framework.ServiceReference)"><code>BundleContext.ungetService(ServiceReference)</code></a>
method for the associated service. That is, only one, use-counted service
object is available from this <a href="../../../org/osgi/framework/ServiceObjects.html" title="interface in org.osgi.framework"><code>ServiceObjects</code></a> object.
<p>
For a prototype scope service, the following steps are required to
release a service object:
<ol>
<li>If the associated service has been unregistered, this method returns
without doing anything.</li>
<li>The
<a href="../../../org/osgi/framework/PrototypeServiceFactory.html#ungetService(org.osgi.framework.Bundle,%20org.osgi.framework.ServiceRegistration,%20S)"><code>PrototypeServiceFactory.ungetService(Bundle, ServiceRegistration, Object)</code></a>
method is called to release the specified service object.</li>
</ol>
<p>
The specified service object must no longer be used and all references to
it should be destroyed after calling this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>service</code> - A service object previously provided by this
<code>ServiceObjects</code> object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If the BundleContext used to create this
<code>ServiceObjects</code> object is no longer valid.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified service object was not
provided by this <code>ServiceObjects</code> object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/ServiceObjects.html#getService()"><code>getService()</code></a></dd></dl>
</li>
</ul>
<a name="getServiceReference()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServiceReference</h4>
<pre><a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><<a href="../../../org/osgi/framework/ServiceObjects.html" title="type parameter in ServiceObjects">S</a>> getServiceReference()</pre>
<div class="block">Returns the <a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework"><code>ServiceReference</code></a> for the service associated with this
<code>ServiceObjects</code> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework"><code>ServiceReference</code></a> for the service associated with this
<code>ServiceObjects</code> object.</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/framework/ServiceListener.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/ServicePermission.html" title="class in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceObjects.html" target="_top">Frames</a></li>
<li><a href="ServiceObjects.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>
|