/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/cm/ManagedServiceFactory.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 | <!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>ManagedServiceFactory</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="ManagedServiceFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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/ManagedService.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/SynchronousConfigurationListener.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/ManagedServiceFactory.html" target="_top">Frames</a></li>
<li><a href="ManagedServiceFactory.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 ManagedServiceFactory" class="title">Interface ManagedServiceFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ManagedServiceFactory</span></pre>
<div class="block">Manage multiple service instances.
Bundles registering this interface are giving the Configuration Admin service
the ability to create and configure a number of instances of a service that
the implementing bundle can provide. For example, a bundle implementing a
DHCP server could be instantiated multiple times for different interfaces
using a factory.
<p>
Each of these <i>service instances </i> is represented, in the persistent
storage of the Configuration Admin service, by a factory
<code>Configuration</code> object that has a PID. When such a
<code>Configuration</code> is updated, the Configuration Admin service calls the
<code>ManagedServiceFactory</code> updated method with the new properties. When
<code>updated</code> is called with a new PID, the Managed Service Factory should
create a new factory instance based on these configuration properties. When
called with a PID that it has seen before, it should update that existing
service instance with the new configuration information.
<p>
In general it is expected that the implementation of this interface will
maintain a data structure that maps PIDs to the factory instances that it has
created. The semantics of a factory instance are defined by the Managed
Service Factory. However, if the factory instance is registered as a service
object with the service registry, its PID should match the PID of the
corresponding <code>Configuration</code> object (but it should <b>not </b> be
registered as a Managed Service!).
<p>
An example that demonstrates the use of a factory. It will create serial
ports under command of the Configuration Admin service.
<pre>
class SerialPortFactory
implements ManagedServiceFactory {
ServiceRegistration registration;
Hashtable ports;
void start(BundleContext context) {
Hashtable properties = new Hashtable();
properties.put( Constants.SERVICE_PID,
"com.acme.serialportfactory" );
registration = context.registerService(
ManagedServiceFactory.class.getName(),
this,
properties
);
}
public void updated( String pid,
Dictionary properties ) {
String portName = (String) properties.get("port");
SerialPortService port =
(SerialPort) ports.get( pid );
if ( port == null ) {
port = new SerialPortService();
ports.put( pid, port );
port.open();
}
if ( port.getPortName().equals(portName) )
return;
port.setPortName( portName );
}
public void deleted( String pid ) {
SerialPortService port =
(SerialPort) ports.get( pid );
port.close();
ports.remove( pid );
}
...
}
</pre></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/ManagedServiceFactory.html#deleted-java.lang.String-">deleted</a></span>(java.lang.String pid)</code>
<div class="block">Remove a factory instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ManagedServiceFactory.html#getName--">getName</a></span>()</code>
<div class="block">Return a descriptive name of this factory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/cm/ManagedServiceFactory.html#updated-java.lang.String-java.util.Dictionary-">updated</a></span>(java.lang.String pid,
java.util.Dictionary<java.lang.String,?> properties)</code>
<div class="block">Create a new instance, or update the configuration of an existing
instance.</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">Return a descriptive name of this factory.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name for the factory, which might be localized</dd>
</dl>
</li>
</ul>
<a name="updated-java.lang.String-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updated</h4>
<pre>void updated(java.lang.String pid,
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">Create a new instance, or update the configuration of an existing
instance.
If the PID of the <code>Configuration</code> object is new for the Managed
Service Factory, then create a new factory instance, using the
configuration <code>properties</code> provided. Else, update the service
instance with the provided <code>properties</code>.
<p>
If the factory instance is registered with the Framework, then the
configuration <code>properties</code> should be copied to its registry
properties. This is not mandatory and security sensitive properties
should obviously not be copied.
<p>
If this method throws any <code>Exception</code>, the Configuration Admin
service must catch it and should log it.
<p>
When the implementation of updated detects any kind of error in the
configuration properties, it should create a new
<a href="../../../../org/osgi/service/cm/ConfigurationException.html" title="class in org.osgi.service.cm"><code>ConfigurationException</code></a> which describes the problem.
<p>
The Configuration Admin service must call this method asynchronously.
This implies that implementors of the <code>ManagedServiceFactory</code> class
can be assured that the callback will not take place during registration
when they execute the registration in a synchronized method.
<p>
If the security allows multiple managed service factories to be called
back for a single configuration then the callbacks must occur in service
ranking order.
<p>
It is valid to create multiple factory instances that are bound to
different locations. Managed Service Factory services must only be
updated with configurations that are bound to their location or that
start with the <code>?</code> prefix and for which they have permission.
Changes in the location must be reflected by deleting the corresponding
configuration if the configuration is no longer visible or updating when
it becomes visible.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - The PID for this configuration.</dd>
<dd><code>properties</code> - A copy of the configuration properties. 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 configuration properties are
invalid.</dd>
</dl>
</li>
</ul>
<a name="deleted-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deleted</h4>
<pre>void deleted(java.lang.String pid)</pre>
<div class="block">Remove a factory instance.
Remove the factory instance associated with the PID. If the instance was
registered with the service registry, it should be unregistered. The
Configuration Admin must call deleted for each instance it received in
<a href="../../../../org/osgi/service/cm/ManagedServiceFactory.html#updated-java.lang.String-java.util.Dictionary-"><code>updated(String, Dictionary)</code></a>.
<p>
If this method throws any <code>Exception</code>, the Configuration Admin
service must catch it and should log it.
<p>
The Configuration Admin service must call this method asynchronously.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - the PID of the service to be removed</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/ManagedService.html" title="interface in org.osgi.service.cm"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/cm/SynchronousConfigurationListener.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/ManagedServiceFactory.html" target="_top">Frames</a></li>
<li><a href="ManagedServiceFactory.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>
|