blob: 9e5544365ad10e4ac3d7828d2aef903c90f92d5b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:40:13 CDT 2020 -->
<title>PackageAdminServiceTracker (Jetty :: Javadoc Build 11.0.0.beta3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PackageAdminServiceTracker (Jetty :: Javadoc Build 11.0.0.beta3 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PackageAdminServiceTracker.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.osgi.boot.utils.internal</a></div>
<h2 title="Class PackageAdminServiceTracker" class="title">Class PackageAdminServiceTracker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.osgi.boot.utils.internal.PackageAdminServiceTracker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.util.EventListener</code>, <code>org.osgi.framework.ServiceListener</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PackageAdminServiceTracker</span>
extends java.lang.Object
implements org.osgi.framework.ServiceListener</pre>
<div class="block">PackageAdminServiceTracker
<p>
When the PackageAdmin service is activated we can look for the fragments
attached to this bundle and do a fake "activate" on them.
<p>
See particularly the jetty-osgi-boot-jsp fragment bundle that uses this
facility.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="PackageAdminServiceTracker.html" title="class in org.eclipse.jetty.osgi.boot.utils.internal">PackageAdminServiceTracker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE">INSTANCE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.osgi.framework.BundleContext)">PackageAdminServiceTracker</a></span>&#8203;(org.osgi.framework.BundleContext&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectFragmentsAndRequiredBundles(org.osgi.framework.Bundle,org.osgi.service.packageadmin.PackageAdmin,java.util.Map,boolean)">collectFragmentsAndRequiredBundles</a></span>&#8203;(org.osgi.framework.Bundle&nbsp;bundle,
org.osgi.service.packageadmin.PackageAdmin&nbsp;admin,
java.util.Map&lt;java.lang.String,&#8203;org.osgi.framework.Bundle&gt;&nbsp;deps,
boolean&nbsp;onlyReexport)</code></th>
<td class="colLast">
<div class="block">Returns the fragments and the required-bundles.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectRequiredBundles(org.osgi.framework.Bundle,org.osgi.service.packageadmin.PackageAdmin,java.util.Map,boolean)">collectRequiredBundles</a></span>&#8203;(org.osgi.framework.Bundle&nbsp;bundle,
org.osgi.service.packageadmin.PackageAdmin&nbsp;admin,
java.util.Map&lt;java.lang.String,&#8203;org.osgi.framework.Bundle&gt;&nbsp;deps,
boolean&nbsp;onlyReexport)</code></th>
<td class="colLast">
<div class="block">A simplistic but good enough parser for the Require-Bundle header.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#frameworkHasCompletedAutostarts()">frameworkHasCompletedAutostarts</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.osgi.framework.Bundle[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFragments(org.osgi.framework.Bundle)">getFragments</a></span>&#8203;(org.osgi.framework.Bundle&nbsp;bundle)</code></th>
<td class="colLast">
<div class="block">Helper to access the PackageAdmin and return the fragments hosted by a
bundle.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.osgi.framework.Bundle[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFragmentsAndRequiredBundles(org.osgi.framework.Bundle)">getFragmentsAndRequiredBundles</a></span>&#8203;(org.osgi.framework.Bundle&nbsp;bundle)</code></th>
<td class="colLast">
<div class="block">Returns the fragments and the required-bundles of a bundle.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serviceChanged(org.osgi.framework.ServiceEvent)">serviceChanged</a></span>&#8203;(org.osgi.framework.ServiceEvent&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Invokes the optional BundleActivator in each fragment.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="INSTANCE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INSTANCE</h4>
<pre>public static&nbsp;<a href="PackageAdminServiceTracker.html" title="class in org.eclipse.jetty.osgi.boot.utils.internal">PackageAdminServiceTracker</a> INSTANCE</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.osgi.framework.BundleContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PackageAdminServiceTracker</h4>
<pre>public&nbsp;PackageAdminServiceTracker&#8203;(org.osgi.framework.BundleContext&nbsp;context)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="serviceChanged(org.osgi.framework.ServiceEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serviceChanged</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;serviceChanged&#8203;(org.osgi.framework.ServiceEvent&nbsp;event)</pre>
<div class="block">Invokes the optional BundleActivator in each fragment. By convention the
bundle activator for a fragment must be in the package that is defined by
the symbolic name of the fragment and the name of the class must be
'FragmentActivator'.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>serviceChanged</code>&nbsp;in interface&nbsp;<code>org.osgi.framework.ServiceListener</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - The <code>ServiceEvent</code> object.</dd>
</dl>
</li>
</ul>
<a id="getFragments(org.osgi.framework.Bundle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragments</h4>
<pre class="methodSignature">public&nbsp;org.osgi.framework.Bundle[]&nbsp;getFragments&#8203;(org.osgi.framework.Bundle&nbsp;bundle)</pre>
<div class="block">Helper to access the PackageAdmin and return the fragments hosted by a
bundle. when we drop the support for the older versions of OSGi, we will
stop using the PackageAdmin service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bundle fragment list</dd>
</dl>
</li>
</ul>
<a id="getFragmentsAndRequiredBundles(org.osgi.framework.Bundle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragmentsAndRequiredBundles</h4>
<pre class="methodSignature">public&nbsp;org.osgi.framework.Bundle[]&nbsp;getFragmentsAndRequiredBundles&#8203;(org.osgi.framework.Bundle&nbsp;bundle)</pre>
<div class="block">Returns the fragments and the required-bundles of a bundle. Recursively
collect the required-bundles and fragment when the directive
visibility:=reexport is added to a required-bundle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bundle fragment and required list</dd>
</dl>
</li>
</ul>
<a id="collectFragmentsAndRequiredBundles(org.osgi.framework.Bundle,org.osgi.service.packageadmin.PackageAdmin,java.util.Map,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectFragmentsAndRequiredBundles</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;collectFragmentsAndRequiredBundles&#8203;(org.osgi.framework.Bundle&nbsp;bundle,
org.osgi.service.packageadmin.PackageAdmin&nbsp;admin,
java.util.Map&lt;java.lang.String,&#8203;org.osgi.framework.Bundle&gt;&nbsp;deps,
boolean&nbsp;onlyReexport)</pre>
<div class="block">Returns the fragments and the required-bundles. Collects them
transitively when the directive 'visibility:=reexport' is added to a
required-bundle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle</dd>
<dd><code>admin</code> - the admin package</dd>
<dd><code>deps</code> - The map of fragment and required bundles associated to the value of the
jetty-web attribute.</dd>
<dd><code>onlyReexport</code> - true to collect resources and web-fragments
transitively if and only if the directive visibility is
reexport.</dd>
</dl>
</li>
</ul>
<a id="collectRequiredBundles(org.osgi.framework.Bundle,org.osgi.service.packageadmin.PackageAdmin,java.util.Map,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectRequiredBundles</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;collectRequiredBundles&#8203;(org.osgi.framework.Bundle&nbsp;bundle,
org.osgi.service.packageadmin.PackageAdmin&nbsp;admin,
java.util.Map&lt;java.lang.String,&#8203;org.osgi.framework.Bundle&gt;&nbsp;deps,
boolean&nbsp;onlyReexport)</pre>
<div class="block">A simplistic but good enough parser for the Require-Bundle header. Parses
the version range attribute and the visibility directive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bundle</code> - the bundle</dd>
<dd><code>admin</code> - the admin package</dd>
<dd><code>deps</code> - The map of required bundles associated to the value of the
jetty-web attribute.</dd>
<dd><code>onlyReexport</code> - true to collect resources and web-fragments
transitively if and only if the directive visibility is
reexport.</dd>
</dl>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
</li>
</ul>
<a id="frameworkHasCompletedAutostarts()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>frameworkHasCompletedAutostarts</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;frameworkHasCompletedAutostarts()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the framework has completed all the start levels.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PackageAdminServiceTracker.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>