/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/coordinator/Participant.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 | <!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>Participant</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="Participant";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/coordinator/Participant.html" target="_top">Frames</a></li>
<li><a href="Participant.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.coordinator</div>
<h2 title="Interface Participant" class="title">Interface Participant</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Participant</span></pre>
<div class="block">A Participant participates in a Coordination.
<p>
A Participant can participate in a Coordination by
<a href="../../../../org/osgi/service/coordinator/Coordination.html#addParticipant-org.osgi.service.coordinator.Participant-"><code>registering</code></a> itself with the
Coordination. After successfully registering itself, the Participant is
notified when the Coordination is terminated.
<p>
If a Coordination terminates <a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>normally</code></a>, then all
registered Participants are notified on their <a href="../../../../org/osgi/service/coordinator/Participant.html#ended-org.osgi.service.coordinator.Coordination-"><code>ended(Coordination)</code></a>
method. If the Coordination terminates as a
<a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>failure</code></a>, then all registered
Participants are notified on their <a href="../../../../org/osgi/service/coordinator/Participant.html#failed-org.osgi.service.coordinator.Coordination-"><code>failed(Coordination)</code></a> method.
<p>
Participants are required to be thread safe as notification can be made on
any thread.
<p>
A Participant can only be registered with a single active Coordination at a
time. If a Participant is already registered with an active Coordination,
attempts to register the Participation with another active Coordination will
block until the Coordination the Participant is registered with terminates.
Notice that in edge cases the notification to the Participant that the
Coordination has terminated can happen before the registration method
returns.</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/coordinator/Participant.html#ended-org.osgi.service.coordinator.Coordination-">ended</a></span>(<a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> coordination)</code>
<div class="block">Notification that a Coordination has terminated
<a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>normally</code></a>.</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/coordinator/Participant.html#failed-org.osgi.service.coordinator.Coordination-">failed</a></span>(<a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> coordination)</code>
<div class="block">Notification that a Coordination has terminated as a
<a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>failure</code></a>.</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="ended-org.osgi.service.coordinator.Coordination-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ended</h4>
<pre>void ended(<a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> coordination)
throws java.lang.Exception</pre>
<div class="block">Notification that a Coordination has terminated
<a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>normally</code></a>.
<p>
This Participant should finalize any work associated with the specified
Coordination.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coordination</code> - The Coordination that has terminated normally.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - If this Participant throws an exception, the
<a href="../../../../org/osgi/service/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><code>Coordinator</code></a> service should log the exception. The
<a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>Coordination.end()</code></a> method which is notifying this
Participant must continue notification of other registered
Participants. When this is completed, the
<a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>Coordination.end()</code></a> method must throw a
CoordinationException of type
<a href="../../../../org/osgi/service/coordinator/CoordinationException.html#PARTIALLY_ENDED"><code>CoordinationException.PARTIALLY_ENDED</code></a>.</dd>
</dl>
</li>
</ul>
<a name="failed-org.osgi.service.coordinator.Coordination-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>failed</h4>
<pre>void failed(<a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> coordination)
throws java.lang.Exception</pre>
<div class="block">Notification that a Coordination has terminated as a
<a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>failure</code></a>.
<p>
This Participant should discard any work associated with the specified
Coordination.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coordination</code> - The Coordination that has terminated as a failure.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - If this Participant throws an exception, the
<a href="../../../../org/osgi/service/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><code>Coordinator</code></a> service should log the exception. The
<a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>Coordination.fail(Throwable)</code></a> method which is notifying
this Participant must continue notification of other registered
Participants.</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/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/coordinator/Participant.html" target="_top">Frames</a></li>
<li><a href="Participant.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>
|