/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/wireadmin/WireAdmin.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 | <!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>WireAdmin</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="WireAdmin";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/wireadmin/WireAdminEvent.html" title="class in org.osgi.service.wireadmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/wireadmin/WireAdmin.html" target="_top">Frames</a></li>
<li><a href="WireAdmin.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.wireadmin</div>
<h2 title="Interface WireAdmin" class="title">Interface WireAdmin</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WireAdmin</span></pre>
<div class="block">Wire Administration service.
<p>
This service can be used to create <code>Wire</code> objects connecting a Producer
service and a Consumer service. <code>Wire</code> objects also have wire
properties that may be specified when a <code>Wire</code> object is created. The
Producer and Consumer services may use the <code>Wire</code> object's properties
to manage or control their interaction. The use of <code>Wire</code> object's
properties by a Producer or Consumer services is optional.
<p>
Security Considerations. A bundle must have
<code>ServicePermission[WireAdmin,GET]</code> to get the Wire Admin service to
create, modify, find, and delete <code>Wire</code> objects.</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><a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/wireadmin/WireAdmin.html#createWire-java.lang.String-java.lang.String-java.util.Dictionary-">createWire</a></span>(java.lang.String producerPID,
java.lang.String consumerPID,
java.util.Dictionary properties)</code>
<div class="block">Create a new <code>Wire</code> object that connects a Producer service to a
Consumer service.</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/wireadmin/WireAdmin.html#deleteWire-org.osgi.service.wireadmin.Wire-">deleteWire</a></span>(<a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a> wire)</code>
<div class="block">Delete a <code>Wire</code> object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/wireadmin/WireAdmin.html#getWires-java.lang.String-">getWires</a></span>(java.lang.String filter)</code>
<div class="block">Return the <code>Wire</code> objects that match the given <code>filter</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/wireadmin/WireAdmin.html#updateWire-org.osgi.service.wireadmin.Wire-java.util.Dictionary-">updateWire</a></span>(<a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a> wire,
java.util.Dictionary properties)</code>
<div class="block">Update the properties of a <code>Wire</code> object.</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="createWire-java.lang.String-java.lang.String-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWire</h4>
<pre><a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a> createWire(java.lang.String producerPID,
java.lang.String consumerPID,
java.util.Dictionary properties)</pre>
<div class="block">Create a new <code>Wire</code> object that connects a Producer service to a
Consumer service.
The Producer service and Consumer service do not have to be registered
when the <code>Wire</code> object is created.
<p>
The <code>Wire</code> configuration data must be persistently stored. All
<code>Wire</code> connections are reestablished when the <code>WireAdmin</code>
service is registered. A <code>Wire</code> can be permanently removed by using
the <a href="../../../../org/osgi/service/wireadmin/WireAdmin.html#deleteWire-org.osgi.service.wireadmin.Wire-"><code>deleteWire(Wire)</code></a> method.
<p>
The <code>Wire</code> object's properties must have case insensitive
<code>String</code> objects as keys (like the Framework). However, the case of
the key must be preserved.
<p>
The <code>WireAdmin</code> service must automatically add the following
<code>Wire</code> properties:
<ul>
<li><a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_PID"><code>WireConstants.WIREADMIN_PID</code></a> set to the value of the
<code>Wire</code> object's persistent identity (PID). This value is generated
by the Wire Admin service when a <code>Wire</code> object is created.</li>
<li><a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_PRODUCER_PID"><code>WireConstants.WIREADMIN_PRODUCER_PID</code></a> set to the value of
Producer service's PID.</li>
<li><a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_CONSUMER_PID"><code>WireConstants.WIREADMIN_CONSUMER_PID</code></a> set to the value of
Consumer service's PID.</li>
</ul>
If the <code>properties</code> argument already contains any of these keys,
then the supplied values are replaced with the values assigned by the
Wire Admin service.
<p>
The Wire Admin service must broadcast a <code>WireAdminEvent</code> of type
<a href="../../../../org/osgi/service/wireadmin/WireAdminEvent.html#WIRE_CREATED"><code>WireAdminEvent.WIRE_CREATED</code></a> after the new <code>Wire</code> object
becomes available from <a href="../../../../org/osgi/service/wireadmin/WireAdmin.html#getWires-java.lang.String-"><code>getWires(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>producerPID</code> - The <code>service.pid</code> of the Producer service to be
connected to the <code>Wire</code> object.</dd>
<dd><code>consumerPID</code> - The <code>service.pid</code> of the Consumer service to be
connected to the <code>Wire</code> object.</dd>
<dd><code>properties</code> - The <code>Wire</code> object's properties. This argument may
be <code>null</code> if the caller does not wish to define any
<code>Wire</code> object's properties.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>Wire</code> object for this connection.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If <code>properties</code> contains
invalid wire types or case variants of the same key name.</dd>
</dl>
</li>
</ul>
<a name="deleteWire-org.osgi.service.wireadmin.Wire-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteWire</h4>
<pre>void deleteWire(<a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a> wire)</pre>
<div class="block">Delete a <code>Wire</code> object.
<p>
The <code>Wire</code> object representing a connection between a Producer
service and a Consumer service must be removed. The persistently stored
configuration data for the <code>Wire</code> object must destroyed. The
<code>Wire</code> object's method <a href="../../../../org/osgi/service/wireadmin/Wire.html#isValid--"><code>Wire.isValid()</code></a> will return
<code>false</code> after it is deleted.
<p>
The Wire Admin service must broadcast a <code>WireAdminEvent</code> of type
<a href="../../../../org/osgi/service/wireadmin/WireAdminEvent.html#WIRE_DELETED"><code>WireAdminEvent.WIRE_DELETED</code></a> after the <code>Wire</code> object becomes
invalid.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wire</code> - The <code>Wire</code> object which is to be deleted.</dd>
</dl>
</li>
</ul>
<a name="updateWire-org.osgi.service.wireadmin.Wire-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateWire</h4>
<pre>void updateWire(<a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a> wire,
java.util.Dictionary properties)</pre>
<div class="block">Update the properties of a <code>Wire</code> object.
The persistently stored configuration data for the <code>Wire</code> object is
updated with the new properties and then the Consumer and Producer
services will be called at the respective
<a href="../../../../org/osgi/service/wireadmin/Consumer.html#producersConnected-org.osgi.service.wireadmin.Wire:A-"><code>Consumer.producersConnected(Wire[])</code></a> and
<a href="../../../../org/osgi/service/wireadmin/Producer.html#consumersConnected-org.osgi.service.wireadmin.Wire:A-"><code>Producer.consumersConnected(Wire[])</code></a> methods.
<p>
The Wire Admin service must broadcast a <code>WireAdminEvent</code> of type
<a href="../../../../org/osgi/service/wireadmin/WireAdminEvent.html#WIRE_UPDATED"><code>WireAdminEvent.WIRE_UPDATED</code></a> after the updated properties are
available from the <code>Wire</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wire</code> - The <code>Wire</code> object which is to be updated.</dd>
<dd><code>properties</code> - The new <code>Wire</code> object's properties or
<code>null</code> if no properties are required.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If <code>properties</code> contains
invalid wire types or case variants of the same key name.</dd>
</dl>
</li>
</ul>
<a name="getWires-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getWires</h4>
<pre><a href="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</a>[] getWires(java.lang.String filter)
throws org.osgi.framework.InvalidSyntaxException</pre>
<div class="block">Return the <code>Wire</code> objects that match the given <code>filter</code>.
<p>
The list of available <code>Wire</code> objects is matched against the
specified <code>filter</code>.<code>Wire</code> objects which match the
<code>filter</code> must be returned. These <code>Wire</code> objects are not
necessarily connected. The Wire Admin service should not return invalid
<code>Wire</code> objects, but it is possible that a <code>Wire</code> object is
deleted after it was placed in the list.
<p>
The filter matches against the <code>Wire</code> object's properties including
<a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_PRODUCER_PID"><code>WireConstants.WIREADMIN_PRODUCER_PID</code></a>,
<a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_CONSUMER_PID"><code>WireConstants.WIREADMIN_CONSUMER_PID</code></a> and
<a href="../../../../org/osgi/service/wireadmin/WireConstants.html#WIREADMIN_PID"><code>WireConstants.WIREADMIN_PID</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - Filter string to select <code>Wire</code> objects or
<code>null</code> to select all <code>Wire</code> objects.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of <code>Wire</code> objects which match the <code>filter</code>
or <code>null</code> if no <code>Wire</code> objects match the
<code>filter</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.osgi.framework.InvalidSyntaxException</code> - If the specified
<code>filter</code> has an invalid syntax.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Filter</code></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/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/wireadmin/WireAdminEvent.html" title="class in org.osgi.service.wireadmin"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/wireadmin/WireAdmin.html" target="_top">Frames</a></li>
<li><a href="WireAdmin.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>
|