/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/application/ApplicationHandle.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 | <!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>ApplicationHandle</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="ApplicationHandle";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/application/ApplicationException.html" title="class in org.osgi.service.application"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/application/ScheduledApplication.html" title="interface in org.osgi.service.application"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/application/ApplicationHandle.html" target="_top">Frames</a></li>
<li><a href="ApplicationHandle.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.application</div>
<h2 title="Class ApplicationHandle" class="title">Class ApplicationHandle</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.osgi.service.application.ApplicationHandle</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ApplicationHandle</span>
extends java.lang.Object</pre>
<div class="block">ApplicationHandle is an OSGi service interface which represents an instance
of an application. It provides the functionality to query and manipulate the
lifecycle state of the represented application instance. It defines constants
for the lifecycle states.</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.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_DESCRIPTOR">APPLICATION_DESCRIPTOR</a></span></code>
<div class="block">The property key for the pid of the corresponding application descriptor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_PID">APPLICATION_PID</a></span></code>
<div class="block">The property key for the unique identifier (PID) of the application
instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_STATE">APPLICATION_STATE</a></span></code>
<div class="block">The property key for the state of this application instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_SUPPORTS_EXITVALUE">APPLICATION_SUPPORTS_EXITVALUE</a></span></code>
<div class="block">The property key for the supports exit value property of this application
instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#RUNNING">RUNNING</a></span></code>
<div class="block">The application instance is running.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#STOPPING">STOPPING</a></span></code>
<div class="block">The application instance is being stopped.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#ApplicationHandle-java.lang.String-org.osgi.service.application.ApplicationDescriptor-">ApplicationHandle</a></span>(java.lang.String instanceId,
<a href="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</a> descriptor)</code>
<div class="block">Application instance identifier is specified by the container when the
instance is created.</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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/application/ApplicationHandle.html#destroy--">destroy</a></span>()</code>
<div class="block">The application instance's lifecycle state can be influenced by this
method.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#destroySpecific--">destroySpecific</a></span>()</code>
<div class="block">Called by the destroy() method to perform application model specific
steps to stop and destroy an application instance safely.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#getApplicationDescriptor--">getApplicationDescriptor</a></span>()</code>
<div class="block">Retrieves the <code>ApplicationDescriptor</code> to which this
<code>ApplicationHandle</code> belongs.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#getExitValue-long-">getExitValue</a></span>(long timeout)</code>
<div class="block">Returns the exit value for the application instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#getInstanceId--">getInstanceId</a></span>()</code>
<div class="block">Returns the unique identifier of this instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/application/ApplicationHandle.html#getState--">getState</a></span>()</code>
<div class="block">Get the state of the application instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="APPLICATION_PID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APPLICATION_PID</h4>
<pre>public static final java.lang.String APPLICATION_PID</pre>
<div class="block">The property key for the unique identifier (PID) of the application
instance.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_PID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="APPLICATION_DESCRIPTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APPLICATION_DESCRIPTOR</h4>
<pre>public static final java.lang.String APPLICATION_DESCRIPTOR</pre>
<div class="block">The property key for the pid of the corresponding application descriptor.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_DESCRIPTOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="APPLICATION_STATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APPLICATION_STATE</h4>
<pre>public static final java.lang.String APPLICATION_STATE</pre>
<div class="block">The property key for the state of this application instance.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_STATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="APPLICATION_SUPPORTS_EXITVALUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APPLICATION_SUPPORTS_EXITVALUE</h4>
<pre>public static final java.lang.String APPLICATION_SUPPORTS_EXITVALUE</pre>
<div class="block">The property key for the supports exit value property of this application
instance.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_SUPPORTS_EXITVALUE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RUNNING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RUNNING</h4>
<pre>public static final java.lang.String RUNNING</pre>
<div class="block">The application instance is running. This is the initial state of a newly
created application instance.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.RUNNING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STOPPING">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>STOPPING</h4>
<pre>public static final java.lang.String STOPPING</pre>
<div class="block">The application instance is being stopped. This is the state of the
application instance during the execution of the <code>destroy()</code>
method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.STOPPING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ApplicationHandle-java.lang.String-org.osgi.service.application.ApplicationDescriptor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ApplicationHandle</h4>
<pre>protected ApplicationHandle(java.lang.String instanceId,
<a href="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</a> descriptor)</pre>
<div class="block">Application instance identifier is specified by the container when the
instance is created. The instance identifier must remain static for the
lifetime of the instance, it must remain the same even across framework
restarts for the same application instance. This value must be the same
as the <code>service.pid</code> service property of this application handle.
<p>
The instance identifier should follow the following scheme:
<<i>application descriptor PID</i>>.<<i>index</i>> where
<<i>application descriptor PID</i>> is the PID of the corresponding
<code>ApplicationDescriptor</code> and <<i>index</i>> is a unique
integer index assigned by the application container. Even after
destroying the application index the same index value should not be
reused in a reasonably long timeframe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>instanceId</code> - the instance identifier of the represented application
instance. It must not be null.</dd>
<dd><code>descriptor</code> - the <code>ApplicationDescriptor</code> of the represented
application instance. It must not be null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if any of the arguments is null.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getApplicationDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationDescriptor</h4>
<pre>public final <a href="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</a> getApplicationDescriptor()</pre>
<div class="block">Retrieves the <code>ApplicationDescriptor</code> to which this
<code>ApplicationHandle</code> belongs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The corresponding <code>ApplicationDescriptor</code></dd>
</dl>
</li>
</ul>
<a name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre>public abstract java.lang.String getState()</pre>
<div class="block">Get the state of the application instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state of the application.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the application handle is unregistered</dd>
</dl>
</li>
</ul>
<a name="getExitValue-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExitValue</h4>
<pre>public java.lang.Object getExitValue(long timeout)
throws <a href="../../../../org/osgi/service/application/ApplicationException.html" title="class in org.osgi.service.application">ApplicationException</a>,
java.lang.InterruptedException</pre>
<div class="block">Returns the exit value for the application instance. The timeout
specifies how the method behaves when the application has not yet
terminated. A negative, zero or positive value may be used.
<ul>
<li>negative - The method does not wait for termination. If the
application has not terminated then an <code>ApplicationException</code> is
thrown.</li>
<li>zero - The method waits until the application terminates.</li>
<li>positive - The method waits until the application terminates or the
timeout expires. If the timeout expires and the application has not
terminated then an <code>ApplicationException</code> is thrown.</li>
</ul>
<p>
The default implementation throws an
<code>UnsupportedOperationException</code>. The application model should
override this method if exit values are supported.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The maximum time in milliseconds to wait for the
application to timeout.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The exit value for the application instance. The value is
application specific.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - If the application model does not
support exit values.</dd>
<dd><code>java.lang.InterruptedException</code> - If the thread is interrupted while waiting
for the timeout.</dd>
<dd><code><a href="../../../../org/osgi/service/application/ApplicationException.html" title="class in org.osgi.service.application">ApplicationException</a></code> - If the application has not terminated. The
error code will be
<a href="../../../../org/osgi/service/application/ApplicationException.html#APPLICATION_EXITVALUE_NOT_AVAILABLE"><code>ApplicationException.APPLICATION_EXITVALUE_NOT_AVAILABLE</code></a>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getInstanceId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceId</h4>
<pre>public final java.lang.String getInstanceId()</pre>
<div class="block">Returns the unique identifier of this instance. This value is also
available as a service property of this application handle's service.pid.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique identifier of the instance</dd>
</dl>
</li>
</ul>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public final void destroy()</pre>
<div class="block">The application instance's lifecycle state can be influenced by this
method. It lets the application instance perform operations to stop the
application safely, e.g. saving its state to a permanent storage.
<p>
The method must check if the lifecycle transition is valid; a STOPPING
application cannot be stopped. If it is invalid then the method must
exit. Otherwise the lifecycle state of the application instance must be
set to STOPPING. Then the destroySpecific() method must be called to
perform any application model specific steps for safe stopping of the
represented application instance.
<p>
At the end the <code>ApplicationHandle</code> must be unregistered. This
method should free all the resources related to this
<code>ApplicationHandle</code>.
<p>
When this method is completed the application instance has already made
its operations for safe stopping, the ApplicationHandle has been
unregistered and its related resources has been freed. Further calls on
this application should not be made because they may have unexpected
results.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - if the caller doesn't have "lifecycle"
<code>ApplicationAdminPermission</code> for the corresponding
application.</dd>
<dd><code>java.lang.IllegalStateException</code> - if the application handle is unregistered</dd>
</dl>
</li>
</ul>
<a name="destroySpecific--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroySpecific</h4>
<pre>protected abstract void destroySpecific()</pre>
<div class="block">Called by the destroy() method to perform application model specific
steps to stop and destroy an application instance safely.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the application handle is unregistered</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/application/ApplicationException.html" title="class in org.osgi.service.application"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/application/ScheduledApplication.html" title="interface in org.osgi.service.application"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/application/ApplicationHandle.html" target="_top">Frames</a></li>
<li><a href="ApplicationHandle.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|