/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/coordinator/Coordination.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 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 | <!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>Coordination</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="Coordination";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":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>Prev Class</li>
<li><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/coordinator/Coordination.html" target="_top">Frames</a></li>
<li><a href="Coordination.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><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </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 Coordination" class="title">Interface Coordination</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Coordination</span></pre>
<div class="block">A Coordination object is used to coordinate a number of independent
Participants.
<p>
Once a Coordination is <a href="../../../../org/osgi/service/coordinator/Coordinator.html#create-java.lang.String-long-"><code>created</code></a>, it
can be used to add <a href="../../../../org/osgi/service/coordinator/Participant.html" title="interface in org.osgi.service.coordinator"><code>Participant</code></a> objects. When the Coordination is
ended, the participants are <a href="../../../../org/osgi/service/coordinator/Participant.html#ended-org.osgi.service.coordinator.Coordination-"><code>notified</code></a>.
A Coordination can also fail for various reasons. When this occurs, the
participants are <a href="../../../../org/osgi/service/coordinator/Participant.html#failed-org.osgi.service.coordinator.Coordination-"><code>notified</code></a> of the
failure.
<p>
A Coordination must be in one of two states, either ACTIVE or TERMINATED. The
transition between ACTIVE and TERMINATED must be atomic, ensuring that a
Participant can be guaranteed of either receiving an exception when adding
itself to a Coordination or of receiving notification the Coordination has
terminated.
<p>
A Coordination object is thread safe and can be passed as a parameter to
other parties regardless of the threads these parties use.
<p>
The following example code shows how a Coordination should be used.
<pre>
void foo() {
Coordination c = coordinator.create("work", 0);
try {
doWork(c);
}
catch (Exception e) {
c.fail(e);
}
finally {
c.end();
}
}
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Exception</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#ORPHANED">ORPHANED</a></span></code>
<div class="block">A singleton exception that will be the failure cause when a Coordination
has been orphaned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Exception</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#RELEASED">RELEASED</a></span></code>
<div class="block">A singleton exception that will be the failure cause when the
Coordinations created by a bundle are terminated because the bundle
released the Coordinator service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Exception</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#TIMEOUT">TIMEOUT</a></span></code>
<div class="block">A singleton exception that will be the failure cause when a Coordination
times out.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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/Coordination.html#addParticipant-org.osgi.service.coordinator.Participant-">addParticipant</a></span>(<a href="../../../../org/osgi/service/coordinator/Participant.html" title="interface in org.osgi.service.coordinator">Participant</a> participant)</code>
<div class="block">Register a Participant with this Coordination.</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/Coordination.html#end--">end</a></span>()</code>
<div class="block">Terminate this Coordination normally.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#extendTimeout-long-">extendTimeout</a></span>(long timeMillis)</code>
<div class="block">Extend the time out of this Coordination.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-">fail</a></span>(java.lang.Throwable cause)</code>
<div class="block">Terminate this Coordination as a failure with the specified failure
cause.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.osgi.framework.Bundle</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getBundle--">getBundle</a></span>()</code>
<div class="block">Returns the bundle that created this Coordination.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getEnclosingCoordination--">getEnclosingCoordination</a></span>()</code>
<div class="block">Returns the Coordination enclosing this Coordination if this Coordination
is on the thread local Coordination stack.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Throwable</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getFailure--">getFailure</a></span>()</code>
<div class="block">Returns the failure cause of this Coordination.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getId--">getId</a></span>()</code>
<div class="block">Returns the id assigned to this Coordination.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of this Coordination.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/osgi/service/coordinator/Participant.html" title="interface in org.osgi.service.coordinator">Participant</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getParticipants--">getParticipants</a></span>()</code>
<div class="block">Returns a snapshot of the Participants registered with this Coordination.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.Thread</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getThread--">getThread</a></span>()</code>
<div class="block">Returns the thread in whose thread local Coordination stack this
Coordination has been <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.Map<java.lang.Class<?>,java.lang.Object></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#getVariables--">getVariables</a></span>()</code>
<div class="block">Returns the variable map associated with this Coordination.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#isTerminated--">isTerminated</a></span>()</code>
<div class="block">Returns whether this Coordination is terminated.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#join-long-">join</a></span>(long timeMillis)</code>
<div class="block">Wait until this Coordination is terminated and all registered
Participants have been notified.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/coordinator/Coordination.html#push--">push</a></span>()</code>
<div class="block">Push this Coordination object onto the thread local Coordination stack to
make it the <a href="../../../../org/osgi/service/coordinator/Coordinator.html#peek--"><code>current Coordination</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TIMEOUT</h4>
<pre>static final java.lang.Exception TIMEOUT</pre>
<div class="block">A singleton exception that will be the failure cause when a Coordination
times out.</div>
</li>
</ul>
<a name="RELEASED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RELEASED</h4>
<pre>static final java.lang.Exception RELEASED</pre>
<div class="block">A singleton exception that will be the failure cause when the
Coordinations created by a bundle are terminated because the bundle
released the Coordinator service.</div>
</li>
</ul>
<a name="ORPHANED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ORPHANED</h4>
<pre>static final java.lang.Exception ORPHANED</pre>
<div class="block">A singleton exception that will be the failure cause when a Coordination
has been orphaned.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>long getId()</pre>
<div class="block">Returns the id assigned to this Coordination.
The id is assigned by the <a href="../../../../org/osgi/service/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><code>Coordinator</code></a> service which created this
Coordination and is unique among all the Coordinations created by the
Coordinator service and must not be reused as long as the Coordinator
service remains registered. The id must be positive and monotonically
increases for each Coordination created by the Coordinator service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The id assigned to this Coordination.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">Returns the name of this Coordination.
The name is specified when this Coordination was created.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of this Coordination.</dd>
</dl>
</li>
</ul>
<a name="end--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre>void end()</pre>
<div class="block">Terminate this Coordination normally.
<p>
If this Coordination has been <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a> on the thread local
Coordination stack of another thread, this method does nothing except
throw a CoordinationException of type
<a href="../../../../org/osgi/service/coordinator/CoordinationException.html#WRONG_THREAD"><code>CoordinationException.WRONG_THREAD</code></a>.
<p>
If this Coordination has been <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a> on the thread local
Coordination stack of this thread but is not the
<a href="../../../../org/osgi/service/coordinator/Coordinator.html#peek--"><code>current Coordination</code></a>, then the Coordinations
on the thread local Coordination stack above this Coordination must be
terminated and removed from the thread local Coordination stack before
this Coordination is terminated. Each of these Coordinations, starting
with the current Coordination, will be <a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>terminated normally</code></a>
. If the termination throws a <a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator"><code>CoordinationException</code></a>, then the
next Coordination on the thread local Coordination stack will be
<a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>terminated as a failure</code></a> with a failure cause of
the thrown CoordinationException. At the end of this process, this
Coordination will be the current Coordination and will have been
terminated as a failure if any of the terminated Coordinations threw a
CoordinationException
<p>
If this Coordination is the <a href="../../../../org/osgi/service/coordinator/Coordinator.html#peek--"><code>current
Coordination</code></a>, then it will be <a href="../../../../org/osgi/service/coordinator/Coordinator.html#pop--"><code>removed</code></a> from the
thread local Coordination stack.
<p>
If this Coordination is already terminated, a CoordinationException is
thrown. If this Coordination was terminated as a failure, the
<a href="../../../../org/osgi/service/coordinator/Coordination.html#getFailure--"><code>failure cause</code></a> will be the cause of the thrown
CoordinationException.
<p>
Otherwise, this Coordination is terminated normally and then all
registered <a href="../../../../org/osgi/service/coordinator/Coordination.html#getParticipants--"><code>Participants</code></a> are
<a href="../../../../org/osgi/service/coordinator/Participant.html#ended-org.osgi.service.coordinator.Coordination-"><code>notified</code></a>. Participants should
finalize any work associated with this Coordination. The successful
return of this method indicates that the Coordination has terminated
normally and all registered Participants have been notified of the normal
termination.
<p>
It is possible that one of the Participants throws an exception during
notification. If this happens, this Coordination is considered to have
partially failed and this method must throw a CoordinationException of
type <a href="../../../../org/osgi/service/coordinator/CoordinationException.html#PARTIALLY_ENDED"><code>CoordinationException.PARTIALLY_ENDED</code></a> after all the
registered Participants have been notified.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator">CoordinationException</a></code> - If this Coordination has failed, including
timed out, or partially failed or this Coordination is on the
thread local Coordination stack of another thread.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[INITIATE]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="fail-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fail</h4>
<pre>boolean fail(java.lang.Throwable cause)</pre>
<div class="block">Terminate this Coordination as a failure with the specified failure
cause.
<p>
If this Coordination is already <a href="../../../../org/osgi/service/coordinator/Coordination.html#isTerminated--"><code>terminated</code></a>, this
method does nothing and returns <code>false</code>.
<p>
Otherwise, this Coordination is terminated as a failure with the
specified failure cause and then all registered
<a href="../../../../org/osgi/service/coordinator/Coordination.html#getParticipants--"><code>Participants</code></a> are
<a href="../../../../org/osgi/service/coordinator/Participant.html#failed-org.osgi.service.coordinator.Coordination-"><code>notified</code></a>. Participants should
discard any work associated with this Coordination. This method will
return <code>true</code>.
<p>
If this Coordination has been <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a> onto a thread local
Coordination stack, this Coordination is not removed from the stack. The
creator of this Coordination must still call <a href="../../../../org/osgi/service/coordinator/Coordination.html#end--"><code>end()</code></a> on this
Coordination to cause it to be removed from the thread local Coordination
stack.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cause</code> - The failure cause. The failure cause must not be
<code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this Coordination was active and was terminated
by this method, otherwise <code>false</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[PARTICIPATE]</code> for this
Coordination.</dd>
</dl>
</li>
</ul>
<a name="getFailure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailure</h4>
<pre>java.lang.Throwable getFailure()</pre>
<div class="block">Returns the failure cause of this Coordination.
<p>
If this Coordination has <a href="../../../../org/osgi/service/coordinator/Coordination.html#fail-java.lang.Throwable-"><code>failed</code></a>, then this
method will return the failure cause.
<p>
If this Coordination timed out, this method will return <a href="../../../../org/osgi/service/coordinator/Coordination.html#TIMEOUT"><code>TIMEOUT</code></a>
as the failure cause. If this Coordination was active when the bundle
that created it released the <a href="../../../../org/osgi/service/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><code>Coordinator</code></a> service, this method
will return <a href="../../../../org/osgi/service/coordinator/Coordination.html#RELEASED"><code>RELEASED</code></a> as the failure cause. If the Coordination
was orphaned, this method will return <a href="../../../../org/osgi/service/coordinator/Coordination.html#ORPHANED"><code>ORPHANED</code></a> as the failure
cause.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The failure cause of this Coordination or <code>null</code> if this
Coordination has not terminated as a failure.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[INITIATE]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="isTerminated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTerminated</h4>
<pre>boolean isTerminated()</pre>
<div class="block">Returns whether this Coordination is terminated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this Coordination is terminated, otherwise
<code>false</code> if this Coordination is active.</dd>
</dl>
</li>
</ul>
<a name="addParticipant-org.osgi.service.coordinator.Participant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParticipant</h4>
<pre>void addParticipant(<a href="../../../../org/osgi/service/coordinator/Participant.html" title="interface in org.osgi.service.coordinator">Participant</a> participant)</pre>
<div class="block">Register a Participant with this Coordination.
<p>
Once a Participant is registered with this Coordination, it is guaranteed
to receive a notification for either
<a href="../../../../org/osgi/service/coordinator/Participant.html#ended-org.osgi.service.coordinator.Coordination-"><code>normal</code></a> or
<a href="../../../../org/osgi/service/coordinator/Participant.html#failed-org.osgi.service.coordinator.Coordination-"><code>failure</code></a> termination when this
Coordination is terminated.
<p>
Participants are registered using their object identity. Once a
Participant is registered with this Coordination, subsequent attempts to
register the Participant again with this Coordination are ignored and the
Participant is only notified once when this Coordination is terminated.
<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 this Coordination has terminated can happen before
this method returns.
<p>
Attempting to register a Participant with a <a href="../../../../org/osgi/service/coordinator/Coordination.html#isTerminated--"><code>terminated</code></a> Coordination will result in a CoordinationException being
thrown.
<p>
The ordering of notifying Participants must follow the reverse order in
which the Participants were registered.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>participant</code> - The Participant to register with this Coordination.
The participant must not be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator">CoordinationException</a></code> - If the Participant could not be registered
with this Coordination. This exception should normally not be
caught by the caller but allowed to be caught by the initiator of
this Coordination.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[PARTICIPATE]</code> for this
Coordination.</dd>
</dl>
</li>
</ul>
<a name="getParticipants--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParticipants</h4>
<pre>java.util.List<<a href="../../../../org/osgi/service/coordinator/Participant.html" title="interface in org.osgi.service.coordinator">Participant</a>> getParticipants()</pre>
<div class="block">Returns a snapshot of the Participants registered with this Coordination.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A snapshot of the Participants registered with this Coordination.
If no Participants are registered with this Coordination, the
returned list will be empty. The list is ordered in the order the
Participants were registered. The returned list is the property
of the caller and can be modified by the caller.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[INITIATE]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="getVariables--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariables</h4>
<pre>java.util.Map<java.lang.Class<?>,java.lang.Object> getVariables()</pre>
<div class="block">Returns the variable map associated with this Coordination.
Each Coordination has a map that can be used for communicating between
different Participants. The key of the map is a class, allowing for
private data to be stored in the map by using implementation classes or
shared data by using shared interfaces.
The returned map is not synchronized. Users of the map must synchronize
on the Map object while making changes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The variable map associated with this Coordination.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[PARTICIPANT]</code> for this
Coordination.</dd>
</dl>
</li>
</ul>
<a name="extendTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extendTimeout</h4>
<pre>long extendTimeout(long timeMillis)</pre>
<div class="block">Extend the time out of this Coordination.
<p>
Participants can call this method to extend the timeout of this
Coordination with at least the specified time. This can be done by
Participants when they know a task will take more than normal time.
<p>
This method will return the new deadline if an extension took place or
the current deadline if, for whatever reason, no extension takes place.
Note that if a maximum timeout is in effect, the deadline may not be
extended by as much as was requested, if at all. If there is no deadline,
zero is returned. Specifying a timeout extension of 0 will return the
existing deadline.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeMillis</code> - The time in milliseconds to extend the current timeout.
If the initial timeout was specified as 0, no extension must take
place. A zero must have no effect.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new deadline in milliseconds. If the specified time is 0, the
existing deadline is returned. If this Coordination was created
with an initial timeout of 0, no timeout is set and 0 is
returned.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator">CoordinationException</a></code> - If this Coordination
<a href="../../../../org/osgi/service/coordinator/Coordination.html#isTerminated--"><code>is terminated</code></a>.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified time is negative.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[PARTICIPATE]</code> for this
Coordination.</dd>
</dl>
</li>
</ul>
<a name="join-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>join</h4>
<pre>void join(long timeMillis)
throws java.lang.InterruptedException</pre>
<div class="block">Wait until this Coordination is terminated and all registered
Participants have been notified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeMillis</code> - Maximum time in milliseconds to wait. Specifying a time
of 0 will wait until this Coordination is terminated.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - If the wait is interrupted.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If the specified time is negative.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[PARTICIPATE]</code> for this
Coordination.</dd>
</dl>
</li>
</ul>
<a name="push--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>push</h4>
<pre><a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> push()</pre>
<div class="block">Push this Coordination object onto the thread local Coordination stack to
make it the <a href="../../../../org/osgi/service/coordinator/Coordinator.html#peek--"><code>current Coordination</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This Coordination.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator">CoordinationException</a></code> - If this Coordination is already on the any
thread's thread local Coordination stack or this Coordination
<a href="../../../../org/osgi/service/coordinator/Coordination.html#isTerminated--"><code>is terminated</code></a>.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[INITIATE]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="getThread--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThread</h4>
<pre>java.lang.Thread getThread()</pre>
<div class="block">Returns the thread in whose thread local Coordination stack this
Coordination has been <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The thread in whose thread local Coordination stack this
Coordination has been pushed or <code>null</code> if this Coordination
is not in any thread local Coordination stack.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[ADMIN]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="getBundle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundle</h4>
<pre>org.osgi.framework.Bundle getBundle()</pre>
<div class="block">Returns the bundle that created this Coordination. This is the bundle
that obtained the <a href="../../../../org/osgi/service/coordinator/Coordinator.html" title="interface in org.osgi.service.coordinator"><code>Coordinator</code></a> service that was used to create
this Coordination.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The bundle that created this Coordination.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[ADMIN]</code> for this Coordination.</dd>
</dl>
</li>
</ul>
<a name="getEnclosingCoordination--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEnclosingCoordination</h4>
<pre><a href="../../../../org/osgi/service/coordinator/Coordination.html" title="interface in org.osgi.service.coordinator">Coordination</a> getEnclosingCoordination()</pre>
<div class="block">Returns the Coordination enclosing this Coordination if this Coordination
is on the thread local Coordination stack.
<p>
When a Coordination is <a href="../../../../org/osgi/service/coordinator/Coordination.html#push--"><code>pushed</code></a> onto the thread local
Coordination stack, the former <a href="../../../../org/osgi/service/coordinator/Coordinator.html#peek--"><code>current
Coordination</code></a>, if any, is the enclosing Coordination of this
Coordination. When this Coordination is <a href="../../../../org/osgi/service/coordinator/Coordinator.html#pop--"><code>removed</code></a>
from the thread local Coordination stack, this Coordination no longer has
an enclosing Coordination.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Coordination enclosing this Coordination if this Coordination
is on the thread local Coordination stack or <code>null</code> if this
Coordination is not on the thread local Coordination stack or has
no enclosing Coordination.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have
<code>CoordinationPermission[ADMIN]</code> for this Coordination.</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>Prev Class</li>
<li><a href="../../../../org/osgi/service/coordinator/CoordinationException.html" title="class in org.osgi.service.coordinator"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/coordinator/Coordination.html" target="_top">Frames</a></li>
<li><a href="Coordination.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><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </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>
|