/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/application/ApplicationHandle.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 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 | <!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:28 UTC 2011 -->
<TITLE>
ApplicationHandle
</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="ApplicationHandle";
}
}
</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/application/ApplicationException.html" title="class in org.osgi.service.application"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/application/ScheduledApplication.html" title="interface in org.osgi.service.application"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/application/ApplicationHandle.html" target="_top"><B>FRAMES</B></A>
<A HREF="ApplicationHandle.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.application</FONT>
<BR>
Class ApplicationHandle</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.osgi.service.application.ApplicationHandle</B>
</PRE>
<HR>
<DL>
<DT><PRE>public abstract class <B>ApplicationHandle</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
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.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_DESCRIPTOR">APPLICATION_DESCRIPTOR</A></B></CODE>
<BR>
The property key for the pid of the corresponding application descriptor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_PID">APPLICATION_PID</A></B></CODE>
<BR>
The property key for the unique identifier (PID) of the application
instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_STATE">APPLICATION_STATE</A></B></CODE>
<BR>
The property key for the state of this application instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#APPLICATION_SUPPORTS_EXITVALUE">APPLICATION_SUPPORTS_EXITVALUE</A></B></CODE>
<BR>
The property key for the supports exit value property of this application
instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#RUNNING">RUNNING</A></B></CODE>
<BR>
The application instance is running.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#STOPPING">STOPPING</A></B></CODE>
<BR>
The application instance is being stopped.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#ApplicationHandle(java.lang.String, org.osgi.service.application.ApplicationDescriptor)">ApplicationHandle</A></B>(java.lang.String instanceId,
<A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A> descriptor)</CODE>
<BR>
Application instance identifier is specified by the container when the
instance is created.</TD>
</TR>
</TABLE>
<!-- ========== 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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#destroy()">destroy</A></B>()</CODE>
<BR>
The application instance's lifecycle state can be influenced by this
method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#destroySpecific()">destroySpecific</A></B>()</CODE>
<BR>
Called by the destroy() method to perform application model specific
steps to stop and destroy an application instance safely.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#getApplicationDescriptor()">getApplicationDescriptor</A></B>()</CODE>
<BR>
Retrieves the <code>ApplicationDescriptor</code> to which this
<code>ApplicationHandle</code> belongs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#getExitValue(long)">getExitValue</A></B>(long timeout)</CODE>
<BR>
Returns the exit value for the application instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#getInstanceId()">getInstanceId</A></B>()</CODE>
<BR>
Returns the unique identifier of this instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ApplicationHandle.html#getState()">getState</A></B>()</CODE>
<BR>
Get the state of the application instance.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="APPLICATION_PID"><!-- --></A><H3>
APPLICATION_PID</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_PID</B></PRE>
<DL>
<DD>The property key for the unique identifier (PID) of the application
instance.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_PID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_DESCRIPTOR"><!-- --></A><H3>
APPLICATION_DESCRIPTOR</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_DESCRIPTOR</B></PRE>
<DL>
<DD>The property key for the pid of the corresponding application descriptor.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_DESCRIPTOR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_STATE"><!-- --></A><H3>
APPLICATION_STATE</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_STATE</B></PRE>
<DL>
<DD>The property key for the state of this application instance.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_STATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_SUPPORTS_EXITVALUE"><!-- --></A><H3>
APPLICATION_SUPPORTS_EXITVALUE</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_SUPPORTS_EXITVALUE</B></PRE>
<DL>
<DD>The property key for the supports exit value property of this application
instance.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.APPLICATION_SUPPORTS_EXITVALUE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="RUNNING"><!-- --></A><H3>
RUNNING</H3>
<PRE>
public static final java.lang.String <B>RUNNING</B></PRE>
<DL>
<DD>The application instance is running. This is the initial state of a newly
created application instance.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.RUNNING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STOPPING"><!-- --></A><H3>
STOPPING</H3>
<PRE>
public static final java.lang.String <B>STOPPING</B></PRE>
<DL>
<DD>The application instance is being stopped. This is the state of the
application instance during the execution of the <code>destroy()</code>
method.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ApplicationHandle.STOPPING">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ApplicationHandle(java.lang.String, org.osgi.service.application.ApplicationDescriptor)"><!-- --></A><H3>
ApplicationHandle</H3>
<PRE>
protected <B>ApplicationHandle</B>(java.lang.String instanceId,
<A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A> descriptor)</PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>instanceId</CODE> - the instance identifier of the represented application
instance. It must not be null.<DD><CODE>descriptor</CODE> - the <code>ApplicationDescriptor</code> of the represented
application instance. It must not be null.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if any of the arguments is null.</DL>
</DL>
<!-- ============ 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="getApplicationDescriptor()"><!-- --></A><H3>
getApplicationDescriptor</H3>
<PRE>
public final <A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A> <B>getApplicationDescriptor</B>()</PRE>
<DL>
<DD>Retrieves the <code>ApplicationDescriptor</code> to which this
<code>ApplicationHandle</code> belongs.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The corresponding <code>ApplicationDescriptor</code></DL>
</DD>
</DL>
<HR>
<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
public abstract java.lang.String <B>getState</B>()</PRE>
<DL>
<DD>Get the state of the application instance.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the state of the application.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the application handle is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="getExitValue(long)"><!-- --></A><H3>
getExitValue</H3>
<PRE>
public java.lang.Object <B>getExitValue</B>(long timeout)
throws <A HREF="../../../../org/osgi/service/application/ApplicationException.html" title="class in org.osgi.service.application">ApplicationException</A>,
java.lang.InterruptedException</PRE>
<DL>
<DD>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>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - The maximum time in milliseconds to wait for the
application to timeout.
<DT><B>Returns:</B><DD>The exit value for the application instance. The value is
application specific.
<DT><B>Throws:</B>
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - If the application model does not
support exit values.
<DD><CODE>java.lang.InterruptedException</CODE> - If the thread is interrupted while waiting
for the timeout.
<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>.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getInstanceId()"><!-- --></A><H3>
getInstanceId</H3>
<PRE>
public final java.lang.String <B>getInstanceId</B>()</PRE>
<DL>
<DD>Returns the unique identifier of this instance. This value is also
available as a service property of this application handle's service.pid.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the unique identifier of the instance</DL>
</DD>
</DL>
<HR>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public final void <B>destroy</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have "lifecycle"
<code>ApplicationAdminPermission</code> for the corresponding application.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the application handle is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="destroySpecific()"><!-- --></A><H3>
destroySpecific</H3>
<PRE>
protected abstract void <B>destroySpecific</B>()</PRE>
<DL>
<DD>Called by the destroy() method to perform application model specific
steps to stop and destroy an application instance safely.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the application handle is unregistered</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/application/ApplicationException.html" title="class in org.osgi.service.application"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/application/ScheduledApplication.html" title="interface in org.osgi.service.application"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/application/ApplicationHandle.html" target="_top"><B>FRAMES</B></A>
<A HREF="ApplicationHandle.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|