/usr/share/doc/libosgi-core-java/api/org/osgi/framework/launch/Framework.html is in libosgi-core-java-doc 4.3.0-4.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Sun Aug 11 05:54:53 UTC 2013 -->
<title>Framework</title>
<meta name="date" content="2013-08-11">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Framework";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/framework/launch/FrameworkFactory.html" title="interface in org.osgi.framework.launch"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/framework/launch/Framework.html" target="_top">Frames</a></li>
<li><a href="Framework.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.framework.launch</div>
<h2 title="Interface Framework" class="title">Interface Framework</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a>, java.lang.Comparable<<a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a>></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Framework</span>
extends <a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></pre>
<div class="block">A Framework instance. A Framework is also known as a System Bundle.
<p>
Framework instances are created using a <a href="../../../../org/osgi/framework/launch/FrameworkFactory.html" title="interface in org.osgi.framework.launch"><code>FrameworkFactory</code></a>. The methods
of this interface can be used to manage and control the created framework
instance.</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.osgi.framework.Bundle">
<!-- -->
</a>
<h3>Fields inherited from interface org.osgi.framework.<a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></h3>
<code><a href="../../../../org/osgi/framework/Bundle.html#ACTIVE">ACTIVE</a>, <a href="../../../../org/osgi/framework/Bundle.html#INSTALLED">INSTALLED</a>, <a href="../../../../org/osgi/framework/Bundle.html#RESOLVED">RESOLVED</a>, <a href="../../../../org/osgi/framework/Bundle.html#SIGNERS_ALL">SIGNERS_ALL</a>, <a href="../../../../org/osgi/framework/Bundle.html#SIGNERS_TRUSTED">SIGNERS_TRUSTED</a>, <a href="../../../../org/osgi/framework/Bundle.html#START_ACTIVATION_POLICY">START_ACTIVATION_POLICY</a>, <a href="../../../../org/osgi/framework/Bundle.html#START_TRANSIENT">START_TRANSIENT</a>, <a href="../../../../org/osgi/framework/Bundle.html#STARTING">STARTING</a>, <a href="../../../../org/osgi/framework/Bundle.html#STOP_TRANSIENT">STOP_TRANSIENT</a>, <a href="../../../../org/osgi/framework/Bundle.html#STOPPING">STOPPING</a>, <a href="../../../../org/osgi/framework/Bundle.html#UNINSTALLED">UNINSTALLED</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><A> A</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#adapt(java.lang.Class)">adapt</a></strong>(java.lang.Class<A> type)</code>
<div class="block">Adapt this Framework to the specified type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Enumeration<java.net.URL></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#findEntries(java.lang.String, java.lang.String, boolean)">findEntries</a></strong>(java.lang.String path,
java.lang.String filePattern,
boolean recurse)</code>
<div class="block">Returns <code>null</code> as a framework implementation does not have a proper
bundle from which to return entries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#getBundleId()">getBundleId</a></strong>()</code>
<div class="block">Returns the Framework unique identifier.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.net.URL</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#getEntry(java.lang.String)">getEntry</a></strong>(java.lang.String path)</code>
<div class="block">Returns <code>null</code> as a framework implementation does not have a
proper bundle from which to return an entry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Enumeration<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#getEntryPaths(java.lang.String)">getEntryPaths</a></strong>(java.lang.String path)</code>
<div class="block">Returns <code>null</code> as a framework implementation does not have a
proper bundle from which to return entry paths.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#getLocation()">getLocation</a></strong>()</code>
<div class="block">Returns the Framework location identifier.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#getSymbolicName()">getSymbolicName</a></strong>()</code>
<div class="block">Returns the symbolic name of this Framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#init()">init</a></strong>()</code>
<div class="block">Initialize this Framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#start()">start</a></strong>()</code>
<div class="block">Start this Framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#start(int)">start</a></strong>(int options)</code>
<div class="block">Start this Framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#stop()">stop</a></strong>()</code>
<div class="block">Stop this Framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#stop(int)">stop</a></strong>(int options)</code>
<div class="block">Stop this Framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#uninstall()">uninstall</a></strong>()</code>
<div class="block">The Framework cannot be uninstalled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#update()">update</a></strong>()</code>
<div class="block">Stop and restart this Framework.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#update(java.io.InputStream)">update</a></strong>(java.io.InputStream in)</code>
<div class="block">Stop and restart this Framework.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/framework/FrameworkEvent.html" title="class in org.osgi.framework">FrameworkEvent</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/osgi/framework/launch/Framework.html#waitForStop(long)">waitForStop</a></strong>(long timeout)</code>
<div class="block">Wait until this Framework has completely stopped.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.osgi.framework.Bundle">
<!-- -->
</a>
<h3>Methods inherited from interface org.osgi.framework.<a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></h3>
<code><a href="../../../../org/osgi/framework/Bundle.html#getBundleContext()">getBundleContext</a>, <a href="../../../../org/osgi/framework/Bundle.html#getDataFile(java.lang.String)">getDataFile</a>, <a href="../../../../org/osgi/framework/Bundle.html#getHeaders()">getHeaders</a>, <a href="../../../../org/osgi/framework/Bundle.html#getHeaders(java.lang.String)">getHeaders</a>, <a href="../../../../org/osgi/framework/Bundle.html#getLastModified()">getLastModified</a>, <a href="../../../../org/osgi/framework/Bundle.html#getRegisteredServices()">getRegisteredServices</a>, <a href="../../../../org/osgi/framework/Bundle.html#getResource(java.lang.String)">getResource</a>, <a href="../../../../org/osgi/framework/Bundle.html#getResources(java.lang.String)">getResources</a>, <a href="../../../../org/osgi/framework/Bundle.html#getServicesInUse()">getServicesInUse</a>, <a href="../../../../org/osgi/framework/Bundle.html#getSignerCertificates(int)">getSignerCertificates</a>, <a href="../../../../org/osgi/framework/Bundle.html#getState()">getState</a>, <a href="../../../../org/osgi/framework/Bundle.html#getVersion()">getVersion</a>, <a href="../../../../org/osgi/framework/Bundle.html#hasPermission(java.lang.Object)">hasPermission</a>, <a href="../../../../org/osgi/framework/Bundle.html#loadClass(java.lang.String)">loadClass</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Comparable</h3>
<code>compareTo</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void init()
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Initialize this Framework. After calling this method, this Framework
must:
<ul>
<li>Have generated a new <a href="../../../../org/osgi/framework/Constants.html#FRAMEWORK_UUID"><code>framework UUID</code></a>.
</li>
<li>Be in the <a href="../../../../org/osgi/framework/Bundle.html#STARTING"><code>Bundle.STARTING</code></a> state.</li>
<li>Have a valid Bundle Context.</li>
<li>Be at start level 0.</li>
<li>Have event handling enabled.</li>
<li>Have reified Bundle objects for all installed bundles.</li>
<li>Have registered any framework services. For example,
<code>ConditionalPermissionAdmin</code>.</li>
<li>Be <a href="../../../../org/osgi/framework/launch/Framework.html#adapt(java.lang.Class)"><code>adaptable</code></a> to the OSGi defined types to which
a system bundle can be adapted.</li>
</ul>
<p>
This Framework will not actually be started until <a href="../../../../org/osgi/framework/launch/Framework.html#start()"><code>start</code></a>
is called.
<p>
This method does nothing if called when this Framework is in the
<a href="../../../../org/osgi/framework/Bundle.html#STARTING"><code>Bundle.STARTING</code></a>, <a href="../../../../org/osgi/framework/Bundle.html#ACTIVE"><code>Bundle.ACTIVE</code></a> or <a href="../../../../org/osgi/framework/Bundle.html#STOPPING"><code>Bundle.STOPPING</code></a> states.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If this Framework could not be initialized.</dd>
<dd><code>java.lang.SecurityException</code> - If the Java Runtime Environment supports
permissions and the caller does not have the appropriate
<code>AdminPermission[this,EXECUTE]</code> or if there is a security
manager already installed and the
<a href="../../../../org/osgi/framework/Constants.html#FRAMEWORK_SECURITY"><code>Constants.FRAMEWORK_SECURITY</code></a> configuration property is
set.</dd></dl>
</li>
</ul>
<a name="waitForStop(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitForStop</h4>
<pre><a href="../../../../org/osgi/framework/FrameworkEvent.html" title="class in org.osgi.framework">FrameworkEvent</a> waitForStop(long timeout)
throws java.lang.InterruptedException</pre>
<div class="block">Wait until this Framework has completely stopped. The <code>stop</code>
and <code>update</code> methods on a Framework performs an asynchronous
stop of the Framework. This method can be used to wait until the
asynchronous stop of this Framework has completed. This method will only
wait if called when this Framework is in the <a href="../../../../org/osgi/framework/Bundle.html#STARTING"><code>Bundle.STARTING</code></a>,
<a href="../../../../org/osgi/framework/Bundle.html#ACTIVE"><code>Bundle.ACTIVE</code></a>, or <a href="../../../../org/osgi/framework/Bundle.html#STOPPING"><code>Bundle.STOPPING</code></a> states. Otherwise it will return
immediately.
<p>
A Framework Event is returned to indicate why this Framework has stopped.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Maximum number of milliseconds to wait until this
Framework has completely stopped. A value of zero will wait
indefinitely.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A Framework Event indicating the reason this method returned. The
following <code>FrameworkEvent</code> types may be returned by
this method.
<ul>
<li><a href="../../../../org/osgi/framework/FrameworkEvent.html#STOPPED"><code>STOPPED</code></a> - This Framework has
been stopped. </li>
<li><a href="../../../../org/osgi/framework/FrameworkEvent.html#STOPPED_UPDATE"><code>STOPPED_UPDATE</code></a> - This
Framework has been updated which has shutdown and will now
restart.</li>
<li> <a href="../../../../org/osgi/framework/FrameworkEvent.html#STOPPED_BOOTCLASSPATH_MODIFIED"><code>STOPPED_BOOTCLASSPATH_MODIFIED</code></a> - This Framework has been stopped
and a bootclasspath extension bundle has been installed or
updated. The VM must be restarted in order for the changed boot
class path to take effect. </li>
<li><a href="../../../../org/osgi/framework/FrameworkEvent.html#ERROR"><code>ERROR</code></a> - The Framework
encountered an error while shutting down or an error has occurred
which forced the framework to shutdown. </li>
<li> <a href="../../../../org/osgi/framework/FrameworkEvent.html#WAIT_TIMEDOUT"><code>WAIT_TIMEDOUT</code></a> - This
method has timed out and returned before this Framework has
stopped.</li>
</ul></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - If another thread interrupted the current
thread before or while the current thread was waiting for this
Framework to completely stop. The <i>interrupted status</i> of
the current thread is cleared when this exception is thrown.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - If the value of timeout is negative.</dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void start()
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Start this Framework.
<p>
The following steps are taken to start this Framework:
<ol>
<li>If this Framework is not in the <a href="../../../../org/osgi/framework/Bundle.html#STARTING"><code>Bundle.STARTING</code></a> state,
<a href="../../../../org/osgi/framework/launch/Framework.html#init()"><code>initialize</code></a> this Framework.</li>
<li>All installed bundles must be started in accordance with each
bundle's persistent <i>autostart setting</i>. This means some bundles
will not be started, some will be started with <i>eager activation</i>
and some will be started with their <i>declared activation</i> policy.
The start level of this Framework is moved to the start level specified
by the <a href="../../../../org/osgi/framework/Constants.html#FRAMEWORK_BEGINNING_STARTLEVEL"><code>beginning start
level</code></a> framework property, as described in the <i>Start Level
Specification</i>. If this framework property is not specified, then the
start level of this Framework is moved to start level one (1). Any
exceptions that occur during bundle starting must be wrapped in a
<a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework"><code>BundleException</code></a> and then published as a framework event of type
<a href="../../../../org/osgi/framework/FrameworkEvent.html#ERROR"><code>FrameworkEvent.ERROR</code></a></li>
<li>This Framework's state is set to <a href="../../../../org/osgi/framework/Bundle.html#ACTIVE"><code>Bundle.ACTIVE</code></a>.</li>
<li>A framework event of type <a href="../../../../org/osgi/framework/FrameworkEvent.html#STARTED"><code>FrameworkEvent.STARTED</code></a> is fired</li>
</ol></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#start()">start</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If this Framework could not be started.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd>"Start Level Specification"</dd></dl>
</li>
</ul>
<a name="start(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void start(int options)
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Start this Framework.
<p>
Calling this method is the same as calling <a href="../../../../org/osgi/framework/launch/Framework.html#start()"><code>start()</code></a>. There are no
start options for the Framework.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#start(int)">start</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - Ignored. There are no start options for the Framework.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If this Framework could not be started.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/launch/Framework.html#start()"><code>start()</code></a></dd></dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void stop()
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Stop this Framework.
<p>
The method returns immediately to the caller after initiating the
following steps to be taken on another thread.
<ol>
<li>This Framework's state is set to <a href="../../../../org/osgi/framework/Bundle.html#STOPPING"><code>Bundle.STOPPING</code></a>.</li>
<li>All installed bundles must be stopped without changing each bundle's
persistent <i>autostart setting</i>. The start level of this Framework is
moved to start level zero (0), as described in the <i>Start Level
Specification</i>. Any exceptions that occur during bundle stopping must
be wrapped in a <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework"><code>BundleException</code></a> and then published as a framework
event of type <a href="../../../../org/osgi/framework/FrameworkEvent.html#ERROR"><code>FrameworkEvent.ERROR</code></a></li>
<li>Unregister all services registered by this Framework.</li>
<li>Event handling is disabled.</li>
<li>This Framework's state is set to <a href="../../../../org/osgi/framework/Bundle.html#RESOLVED"><code>Bundle.RESOLVED</code></a>.</li>
<li>All resources held by this Framework are released. This includes
threads, bundle class loaders, open files, etc.</li>
<li>Notify all threads that are waiting at <a href="../../../../org/osgi/framework/launch/Framework.html#waitForStop(long)"><code>waitForStop</code></a> that the stop operation has completed.</li>
</ol>
<p>
After being stopped, this Framework may be discarded, initialized or
started.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#stop()">stop</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If stopping this Framework could not be
initiated.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd>"Start Level Specification"</dd></dl>
</li>
</ul>
<a name="stop(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void stop(int options)
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Stop this Framework.
<p>
Calling this method is the same as calling <a href="../../../../org/osgi/framework/launch/Framework.html#stop()"><code>stop()</code></a>. There are no
stop options for the Framework.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#stop(int)">stop</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - Ignored. There are no stop options for the Framework.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If stopping this Framework could not be
initiated.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,EXECUTE]</code>, and the Java Runtime
Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/launch/Framework.html#stop()"><code>stop()</code></a></dd></dl>
</li>
</ul>
<a name="uninstall()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uninstall</h4>
<pre>void uninstall()
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">The Framework cannot be uninstalled.
<p>
This method always throws a BundleException.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#uninstall()">uninstall</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - This Framework cannot be uninstalled.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,LIFECYCLE]</code>, and the Java
Runtime Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#stop()"><code>Bundle.stop()</code></a></dd></dl>
</li>
</ul>
<a name="update()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void update()
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Stop and restart this Framework.
<p>
The method returns immediately to the caller after initiating the
following steps to be taken on another thread.
<ol>
<li>Perform the steps in the <a href="../../../../org/osgi/framework/launch/Framework.html#stop()"><code>stop()</code></a> method to stop this
Framework.</li>
<li>Perform the steps in the <a href="../../../../org/osgi/framework/launch/Framework.html#start()"><code>start()</code></a> method to start this
Framework.</li>
</ol></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#update()">update</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If stopping and restarting this Framework could
not be initiated.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,LIFECYCLE]</code>, and the Java
Runtime Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#update(java.io.InputStream)"><code>Bundle.update(InputStream)</code></a></dd></dl>
</li>
</ul>
<a name="update(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void update(java.io.InputStream in)
throws <a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></pre>
<div class="block">Stop and restart this Framework.
<p>
Calling this method is the same as calling <a href="../../../../org/osgi/framework/launch/Framework.html#update()"><code>update()</code></a> except that
any provided InputStream is immediately closed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#update(java.io.InputStream)">update</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - Any provided InputStream is immediately closed before returning
from this method and otherwise ignored.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/framework/BundleException.html" title="class in org.osgi.framework">BundleException</a></code> - If stopping and restarting this Framework could
not be initiated.</dd>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,LIFECYCLE]</code>, and the Java
Runtime Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#stop()"><code>Bundle.stop()</code></a>,
<a href="../../../../org/osgi/framework/Bundle.html#start()"><code>Bundle.start()</code></a></dd></dl>
</li>
</ul>
<a name="getBundleId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundleId</h4>
<pre>long getBundleId()</pre>
<div class="block">Returns the Framework unique identifier. This Framework is assigned the
unique identifier zero (0) since this Framework is also a System Bundle.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#getBundleId()">getBundleId</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>0.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#getBundleId()"><code>Bundle.getBundleId()</code></a></dd></dl>
</li>
</ul>
<a name="getLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocation</h4>
<pre>java.lang.String getLocation()</pre>
<div class="block">Returns the Framework location identifier. This Framework is assigned the
unique location "<code>System Bundle</code>" since this
Framework is also a System Bundle.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#getLocation()">getLocation</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The string "<code>System Bundle</code>".</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - If the caller does not have the appropriate
<code>AdminPermission[this,METADATA]</code>, and the Java Runtime
Environment supports permissions.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#getLocation()"><code>Bundle.getLocation()</code></a>,
<a href="../../../../org/osgi/framework/Constants.html#SYSTEM_BUNDLE_LOCATION"><code>Constants.SYSTEM_BUNDLE_LOCATION</code></a></dd></dl>
</li>
</ul>
<a name="getSymbolicName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSymbolicName</h4>
<pre>java.lang.String getSymbolicName()</pre>
<div class="block">Returns the symbolic name of this Framework. The symbolic name is unique
for the implementation of the framework. However, the symbolic name
"<code>system.bundle</code>" must be recognized as an alias to
the implementation-defined symbolic name since this Framework is also a
System Bundle.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#getSymbolicName()">getSymbolicName</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The symbolic name of this Framework.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/osgi/framework/Bundle.html#getSymbolicName()"><code>Bundle.getSymbolicName()</code></a>,
<a href="../../../../org/osgi/framework/Constants.html#SYSTEM_BUNDLE_SYMBOLICNAME"><code>Constants.SYSTEM_BUNDLE_SYMBOLICNAME</code></a></dd></dl>
</li>
</ul>
<a name="getEntryPaths(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntryPaths</h4>
<pre>java.util.Enumeration<java.lang.String> getEntryPaths(java.lang.String path)</pre>
<div class="block">Returns <code>null</code> as a framework implementation does not have a
proper bundle from which to return entry paths.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#getEntryPaths(java.lang.String)">getEntryPaths</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - Ignored.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>null</code> as a framework implementation does not have a
proper bundle from which to return entry paths.</dd></dl>
</li>
</ul>
<a name="getEntry(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntry</h4>
<pre>java.net.URL getEntry(java.lang.String path)</pre>
<div class="block">Returns <code>null</code> as a framework implementation does not have a
proper bundle from which to return an entry.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#getEntry(java.lang.String)">getEntry</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - Ignored.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>null</code> as a framework implementation does not have a
proper bundle from which to return an entry.</dd></dl>
</li>
</ul>
<a name="findEntries(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findEntries</h4>
<pre>java.util.Enumeration<java.net.URL> findEntries(java.lang.String path,
java.lang.String filePattern,
boolean recurse)</pre>
<div class="block">Returns <code>null</code> as a framework implementation does not have a proper
bundle from which to return entries.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#findEntries(java.lang.String, java.lang.String, boolean)">findEntries</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - Ignored.</dd><dd><code>filePattern</code> - Ignored.</dd><dd><code>recurse</code> - Ignored.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>null</code> as a framework implementation does not have a proper
bundle from which to return entries.</dd></dl>
</li>
</ul>
<a name="adapt(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>adapt</h4>
<pre><A> A adapt(java.lang.Class<A> type)</pre>
<div class="block">Adapt this Framework to the specified type.
<p>
Adapting this Framework to the specified type may require certain checks,
including security checks, to succeed. If a check does not succeed, then
this Framework cannot be adapted and <code>null</code> is returned. If this
Framework is not <a href="../../../../org/osgi/framework/launch/Framework.html#init()"><code>initialized</code></a>, then <code>null</code> is
returned if the specified type is one of the OSGi defined types to which
a system bundle can be adapted.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/osgi/framework/Bundle.html#adapt(java.lang.Class)">adapt</a></code> in interface <code><a href="../../../../org/osgi/framework/Bundle.html" title="interface in org.osgi.framework">Bundle</a></code></dd>
<dt><span class="strong">Type Parameters:</span></dt><dd><code>A</code> - The type to which this Framework is to be adapted.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Class object for the type to which this Framework is to be
adapted.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The object, of the specified type, to which this Framework has
been adapted or <code>null</code> if this Framework cannot be adapted</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/framework/launch/FrameworkFactory.html" title="interface in org.osgi.framework.launch"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/framework/launch/Framework.html" target="_top">Frames</a></li>
<li><a href="Framework.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|