/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/wireadmin/WireAdmin.html is in libosgi-compendium-java-doc 4.3.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 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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Nov 21 22:05:27 UTC 2011 -->
<TITLE>
WireAdmin
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WireAdmin";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/wireadmin/WireAdminEvent.html" title="class in org.osgi.service.wireadmin"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/wireadmin/WireAdmin.html" target="_top"><B>FRAMES</B></A>
<A HREF="WireAdmin.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.osgi.service.wireadmin</FONT>
<BR>
Interface WireAdmin</H2>
<HR>
<DL>
<DT><PRE>public interface <B>WireAdmin</B></DL>
</PRE>
<P>
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.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/wireadmin/WireAdmin.html#createWire(java.lang.String, java.lang.String, java.util.Dictionary)">createWire</A></B>(java.lang.String producerPID,
java.lang.String consumerPID,
java.util.Dictionary properties)</CODE>
<BR>
Create a new <code>Wire</code> object that connects a Producer service to a
Consumer service.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/wireadmin/WireAdmin.html#deleteWire(org.osgi.service.wireadmin.Wire)">deleteWire</A></B>(<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A> wire)</CODE>
<BR>
Delete a <code>Wire</code> object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/wireadmin/WireAdmin.html#getWires(java.lang.String)">getWires</A></B>(java.lang.String filter)</CODE>
<BR>
Return the <code>Wire</code> objects that match the given <code>filter</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/wireadmin/WireAdmin.html#updateWire(org.osgi.service.wireadmin.Wire, java.util.Dictionary)">updateWire</A></B>(<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A> wire,
java.util.Dictionary properties)</CODE>
<BR>
Update the properties of a <code>Wire</code> object.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createWire(java.lang.String, java.lang.String, java.util.Dictionary)"><!-- --></A><H3>
createWire</H3>
<PRE>
<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A> <B>createWire</B>(java.lang.String producerPID,
java.lang.String consumerPID,
java.util.Dictionary properties)</PRE>
<DL>
<DD>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>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>producerPID</CODE> - The <code>service.pid</code> of the Producer service to be
connected to the <code>Wire</code> object.<DD><CODE>consumerPID</CODE> - The <code>service.pid</code> of the Consumer service to be
connected to the <code>Wire</code> object.<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.
<DT><B>Returns:</B><DD>The <code>Wire</code> object for this connection.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If <code>properties</code> contains
invalid wire types or case variants of the same key name.</DL>
</DD>
</DL>
<HR>
<A NAME="deleteWire(org.osgi.service.wireadmin.Wire)"><!-- --></A><H3>
deleteWire</H3>
<PRE>
void <B>deleteWire</B>(<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A> wire)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wire</CODE> - The <code>Wire</code> object which is to be deleted.</DL>
</DD>
</DL>
<HR>
<A NAME="updateWire(org.osgi.service.wireadmin.Wire, java.util.Dictionary)"><!-- --></A><H3>
updateWire</H3>
<PRE>
void <B>updateWire</B>(<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A> wire,
java.util.Dictionary properties)</PRE>
<DL>
<DD>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[])"><CODE>Consumer.producersConnected(Wire[])</CODE></A> and
<A HREF="../../../../org/osgi/service/wireadmin/Producer.html#consumersConnected(org.osgi.service.wireadmin.Wire[])"><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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wire</CODE> - The <code>Wire</code> object which is to be updated.<DD><CODE>properties</CODE> - The new <code>Wire</code> object's properties or
<code>null</code> if no properties are required.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If <code>properties</code> contains
invalid wire types or case variants of the same key name.</DL>
</DD>
</DL>
<HR>
<A NAME="getWires(java.lang.String)"><!-- --></A><H3>
getWires</H3>
<PRE>
<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin">Wire</A>[] <B>getWires</B>(java.lang.String filter)
throws org.osgi.framework.InvalidSyntaxException</PRE>
<DL>
<DD>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>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filter</CODE> - Filter string to select <code>Wire</code> objects or
<code>null</code> to select all <code>Wire</code> objects.
<DT><B>Returns:</B><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>.
<DT><B>Throws:</B>
<DD><CODE>org.osgi.framework.InvalidSyntaxException</CODE> - If the specified
<code>filter</code> has an invalid syntax.<DT><B>See Also:</B><DD><CODE>Filter</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/wireadmin/Wire.html" title="interface in org.osgi.service.wireadmin"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/wireadmin/WireAdminEvent.html" title="class in org.osgi.service.wireadmin"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/wireadmin/WireAdmin.html" target="_top"><B>FRAMES</B></A>
<A HREF="WireAdmin.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|