/usr/share/doc/libosgi-core-java/api/org/osgi/framework/ServiceRegistration.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ServiceRegistration</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="ServiceRegistration";
}
//-->
</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/ServiceReference.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/SynchronousBundleListener.html" title="interface in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceRegistration.html" target="_top">Frames</a></li>
<li><a href="ServiceRegistration.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 ServiceRegistration" class="title">Interface ServiceRegistration<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">ServiceRegistration<S></span></pre>
<div class="block">A registered service.
<p>
The Framework returns a <code>ServiceRegistration</code> object when a
<code>BundleContext.registerService</code> method invocation is successful. The
<code>ServiceRegistration</code> object is for the private use of the registering
bundle and should not be shared with other bundles.
<p>
The <code>ServiceRegistration</code> object may be used to update the properties
of the service or to unregister the service.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/BundleContext.html#registerService(java.lang.String[],%20java.lang.Object,%20java.util.Dictionary)"><code>BundleContext.registerService(String[],Object,Dictionary)</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/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><<a href="../../../org/osgi/framework/ServiceRegistration.html" title="type parameter in ServiceRegistration">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceRegistration.html#getReference()">getReference</a></strong>()</code>
<div class="block">Returns a <code>ServiceReference</code> object for a service being registered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceRegistration.html#setProperties(java.util.Dictionary)">setProperties</a></strong>(java.util.Dictionary<java.lang.String,?> properties)</code>
<div class="block">Updates the properties associated with a service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/osgi/framework/ServiceRegistration.html#unregister()">unregister</a></strong>()</code>
<div class="block">Unregisters 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="getReference()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReference</h4>
<pre><a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework">ServiceReference</a><<a href="../../../org/osgi/framework/ServiceRegistration.html" title="type parameter in ServiceRegistration">S</a>> getReference()</pre>
<div class="block">Returns a <code>ServiceReference</code> object for a service being registered.
<p>
The <code>ServiceReference</code> object may be shared with other bundles.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>ServiceReference</code> object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this <code>ServiceRegistration</code> object
has already been unregistered.</dd></dl>
</li>
</ul>
<a name="setProperties(java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>void setProperties(java.util.Dictionary<java.lang.String,?> properties)</pre>
<div class="block">Updates the properties associated with a service.
<p>
The <a href="../../../org/osgi/framework/Constants.html#OBJECTCLASS"><code>Constants.OBJECTCLASS</code></a>, <a href="../../../org/osgi/framework/Constants.html#SERVICE_BUNDLEID"><code>Constants.SERVICE_BUNDLEID</code></a>,
<a href="../../../org/osgi/framework/Constants.html#SERVICE_ID"><code>Constants.SERVICE_ID</code></a> and <a href="../../../org/osgi/framework/Constants.html#SERVICE_SCOPE"><code>Constants.SERVICE_SCOPE</code></a> keys
cannot be modified by this method. These values are set by the Framework
when the service is registered in the OSGi environment.
<p>
The following steps are required to modify service properties:
<ol>
<li>The service's properties are replaced with the provided properties.</li>
<li>A service event of type <a href="../../../org/osgi/framework/ServiceEvent.html#MODIFIED"><code>ServiceEvent.MODIFIED</code></a> is fired.</li>
</ol></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - The properties for this service. See <a href="../../../org/osgi/framework/Constants.html" title="interface in org.osgi.framework"><code>Constants</code></a>
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 this method should be called again.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this <code>ServiceRegistration</code> object
has already been unregistered.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If <code>properties</code> contains case
variants of the same key name.</dd></dl>
</li>
</ul>
<a name="unregister()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unregister</h4>
<pre>void unregister()</pre>
<div class="block">Unregisters a service. Remove a <code>ServiceRegistration</code> object from
the Framework service registry. All <code>ServiceReference</code> objects
associated with this <code>ServiceRegistration</code> object can no longer be
used to interact with the service once unregistration is complete.
<p>
The following steps are required to unregister a service:
<ol>
<li>The service is removed from the Framework service registry so that it
can no longer be obtained.</li>
<li>A service event of type <a href="../../../org/osgi/framework/ServiceEvent.html#UNREGISTERING"><code>ServiceEvent.UNREGISTERING</code></a> is fired
so that bundles using this service can release their use of the service.
Once delivery of the service event is complete, the
<code>ServiceReference</code> objects for the service may no longer be used to
get a service object for the service.</li>
<li>For each bundle whose use count for this service is greater than
zero:
<ul>
<li>The bundle's use count for this service is set to zero.</li>
<li>If the service was registered with a <a href="../../../org/osgi/framework/ServiceFactory.html" title="interface in org.osgi.framework"><code>ServiceFactory</code></a> object,
the <code>ServiceFactory.ungetService</code> method is called to release the
service object for the bundle.</li>
</ul>
</li>
</ol></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If this <code>ServiceRegistration</code> object
has already been unregistered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/osgi/framework/BundleContext.html#ungetService(org.osgi.framework.ServiceReference)"><code>BundleContext.ungetService(ServiceReference)</code></a>,
<a href="../../../org/osgi/framework/ServiceFactory.html#ungetService(org.osgi.framework.Bundle,%20org.osgi.framework.ServiceRegistration,%20S)"><code>ServiceFactory.ungetService(Bundle, ServiceRegistration, Object)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/osgi/framework/ServiceReference.html" title="interface in org.osgi.framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/osgi/framework/SynchronousBundleListener.html" title="interface in org.osgi.framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/osgi/framework/ServiceRegistration.html" target="_top">Frames</a></li>
<li><a href="ServiceRegistration.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>
|