/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/cm/ManagedService.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 | <!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>ManagedService</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="ManagedService";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/cm/ConfigurationPlugin.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/ManagedServiceFactory.html" title="interface 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/ManagedService.html" target="_top">Frames</a></li>
<li><a href="ManagedService.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.cm</div>
<h2 title="Interface ManagedService" class="title">Interface ManagedService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ManagedService</span></pre>
<div class="block">A service that can receive configuration data from a Configuration Admin
service.
<p>
A Managed Service is a service that needs configuration data. Such an object
should be registered with the Framework registry with the <code>service.pid</code>
property set to some unique identifier called a PID.
<p>
If the Configuration Admin service has a <code>Configuration</code> object
corresponding to this PID, it will callback the <code>updated()</code> method of
the <code>ManagedService</code> object, passing the properties of that
<code>Configuration</code> object.
<p>
If it has no such <code>Configuration</code> object, then it calls back with a
<code>null</code> properties argument. Registering a Managed Service will always
result in a callback to the <code>updated()</code> method provided the
Configuration Admin service is, or becomes active. This callback must always
be done asynchronously.
<p>
Else, every time that either of the <code>updated()</code> methods is called on
that <code>Configuration</code> object, the <code>ManagedService.updated()</code>
method with the new properties is called. If the <code>delete()</code> method is
called on that <code>Configuration</code> object, <code>ManagedService.updated()</code>
is called with a <code>null</code> for the properties parameter. All these
callbacks must be done asynchronously.
<p>
The following example shows the code of a serial port that will create a port
depending on configuration information.
<pre>
class SerialPort implements ManagedService {
ServiceRegistration registration;
Hashtable configuration;
CommPortIdentifier id;
synchronized void open(CommPortIdentifier id,
BundleContext context) {
this.id = id;
registration = context.registerService(
ManagedService.class.getName(),
this,
getDefaults()
);
}
Hashtable getDefaults() {
Hashtable defaults = new Hashtable();
defaults.put( "port", id.getName() );
defaults.put( "product", "unknown" );
defaults.put( "baud", "9600" );
defaults.put( Constants.SERVICE_PID,
"com.acme.serialport." + id.getName() );
return defaults;
}
public synchronized void updated(
Dictionary configuration ) {
if ( configuration == null )
registration.setProperties( getDefaults() );
else {
setSpeed( configuration.get("baud") );
registration.setProperties( configuration );
}
}
...
}
</pre>
<p>
As a convention, it is recommended that when a Managed Service is updated, it
should copy all the properties it does not recognize into the service
registration properties. This will allow the Configuration Admin service to
set properties on services which can then be used by other applications.
<p>
Normally, a single Managed Service for a given PID is given the configuration
dictionary, this is the configuration that is bound to the location of the
registering bundle. However, when security is on, a Managed Service can have
Configuration Permission to also be updated for other locations.</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/cm/ManagedService.html#updated-java.util.Dictionary-">updated</a></span>(java.util.Dictionary<java.lang.String,?> properties)</code>
<div class="block">Update the configuration for a Managed 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="updated-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updated</h4>
<pre>void updated(java.util.Dictionary<java.lang.String,?> properties)
throws <a href="../../../../org/osgi/service/cm/ConfigurationException.html" title="class in org.osgi.service.cm">ConfigurationException</a></pre>
<div class="block">Update the configuration for a Managed Service.
<p>
When the implementation of <code>updated(Dictionary)</code> detects any kind
of error in the configuration properties, it should create a new
<code>ConfigurationException</code> which describes the problem. This can
allow a management system to provide useful information to a human
administrator.
<p>
If this method throws any other <code>Exception</code>, the Configuration
Admin service must catch it and should log it.
<p>
The Configuration Admin service must call this method asynchronously with
the method that initiated the callback. This implies that implementors of
Managed Service can be assured that the callback will not take place
during registration when they execute the registration in a synchronized
method.
<p>
If the the location allows multiple managed services to be called back
for a single configuration then the callbacks must occur in service
ranking order. Changes in the location must be reflected by deleting the
configuration if the configuration is no longer visible and updating when
it becomes visible.
<p>
If no configuration exists for the corresponding PID, or the bundle has
no access to the configuration, then the bundle must be called back with
a <code>null</code> to signal that CM is active but there is no data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - A copy of the Configuration properties, or <code>null</code>
. This argument must not contain the "service.bundleLocation"
property. The value of this property may be obtained from the
<code>Configuration.getBundleLocation</code> method.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/cm/ConfigurationException.html" title="class in org.osgi.service.cm">ConfigurationException</a></code> - when the update fails</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/ConfigurationPlugin.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/ManagedServiceFactory.html" title="interface 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/ManagedService.html" target="_top">Frames</a></li>
<li><a href="ManagedService.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>
|