blob: d7358bc8d1cd3c74c65119ea44367a46b8892609 [file] [log] [blame]
<!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 (1.8.0_92) on Thu Jun 07 14:26:35 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ServiceWatcher (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<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="ServiceWatcher (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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";
</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="class-use/ServiceWatcher.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">
<li><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/OSGiWebappClassLoader.html" title="class in org.eclipse.jetty.osgi.boot.internal.webapp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html" target="_top">Frames</a></li>
<li><a href="ServiceWatcher.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.osgi.boot.internal.webapp</div>
<h2 title="Class ServiceWatcher" class="title">Class ServiceWatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.osgi.boot.internal.webapp.ServiceWatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.osgi.util.tracker.ServiceTrackerCustomizer</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ServiceWatcher</span>
extends java.lang.Object
implements org.osgi.util.tracker.ServiceTrackerCustomizer</pre>
<div class="block">ServiceWatcher
When a <a href="../../../../../../../org/eclipse/jetty/server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler"><code>ContextHandler</code></a> is activated as an osgi service we find a jetty deployer
for it. The ContextHandler could be either a WebAppContext or any other derivative of
ContextHandler.
ContextHandlers and WebApps can also be deployed into jetty without creating them as
osgi services. Instead, they can be deployed via manifest headers inside bundles. See
<a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/BundleWatcher.html" title="class in org.eclipse.jetty.osgi.boot.internal.webapp"><code>BundleWatcher</code></a>.</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">&nbsp;</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/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#FILTER">FILTER</a></span></code>&nbsp;</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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#ServiceWatcher--">ServiceWatcher</a></span>()</code>&nbsp;</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">&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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#addingService-org.osgi.framework.ServiceReference-">addingService</a></span>(org.osgi.framework.ServiceReference&nbsp;reference)</code>
<div class="block">A Service that is a ContextHandler is detected.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#addService-org.osgi.framework.BundleContext-org.eclipse.jetty.server.handler.ContextHandler-org.osgi.framework.ServiceReference-">addService</a></span>(org.osgi.framework.BundleContext&nbsp;context,
<a href="../../../../../../../org/eclipse/jetty/server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&nbsp;contextHandler,
org.osgi.framework.ServiceReference&nbsp;reference)</code>
<div class="block">Deploy ContextHandler that is a Service.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;org.osgi.framework.ServiceReference,<a href="../../../../../../../org/eclipse/jetty/osgi/boot/ServiceProvider.html" title="interface in org.eclipse.jetty.osgi.boot">ServiceProvider</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#getDeployers-java.lang.String-">getDeployers</a></span>(java.lang.String&nbsp;managedServerName)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#modifiedService-org.osgi.framework.ServiceReference-java.lang.Object-">modifiedService</a></span>(org.osgi.framework.ServiceReference&nbsp;reference,
java.lang.Object&nbsp;service)</code>
<div class="block">A Service that is a ContextHandler has been modified.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#removedService-org.osgi.framework.ServiceReference-java.lang.Object-">removedService</a></span>(org.osgi.framework.ServiceReference&nbsp;reference,
java.lang.Object&nbsp;service)</code>
<div class="block">A Service that is a ContextHandler is being removed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html#removeService-org.osgi.framework.BundleContext-org.eclipse.jetty.server.handler.ContextHandler-org.osgi.framework.ServiceReference-">removeService</a></span>(org.osgi.framework.BundleContext&nbsp;context,
<a href="../../../../../../../org/eclipse/jetty/server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&nbsp;contextHandler,
org.osgi.framework.ServiceReference&nbsp;reference)</code>
<div class="block">Undeploy a ContextHandler that is a Service.</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&nbsp;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="FILTER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FILTER</h4>
<pre>public static final&nbsp;java.lang.String FILTER</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ServiceWatcher--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServiceWatcher</h4>
<pre>public&nbsp;ServiceWatcher()
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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="getDeployers-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeployers</h4>
<pre>public&nbsp;java.util.Map&lt;org.osgi.framework.ServiceReference,<a href="../../../../../../../org/eclipse/jetty/osgi/boot/ServiceProvider.html" title="interface in org.eclipse.jetty.osgi.boot">ServiceProvider</a>&gt;&nbsp;getDeployers(java.lang.String&nbsp;managedServerName)</pre>
</li>
</ul>
<a name="addingService-org.osgi.framework.ServiceReference-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addingService</h4>
<pre>public&nbsp;java.lang.Object&nbsp;addingService(org.osgi.framework.ServiceReference&nbsp;reference)</pre>
<div class="block">A Service that is a ContextHandler is detected.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>addingService</code>&nbsp;in interface&nbsp;<code>org.osgi.util.tracker.ServiceTrackerCustomizer</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServiceTrackerCustomizer.addingService(org.osgi.framework.ServiceReference)</code></dd>
</dl>
</li>
</ul>
<a name="modifiedService-org.osgi.framework.ServiceReference-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modifiedService</h4>
<pre>public&nbsp;void&nbsp;modifiedService(org.osgi.framework.ServiceReference&nbsp;reference,
java.lang.Object&nbsp;service)</pre>
<div class="block">A Service that is a ContextHandler has been modified. We
undeploy and then redeploy the ContextHandler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>modifiedService</code>&nbsp;in interface&nbsp;<code>org.osgi.util.tracker.ServiceTrackerCustomizer</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServiceTrackerCustomizer.modifiedService(org.osgi.framework.ServiceReference, java.lang.Object)</code></dd>
</dl>
</li>
</ul>
<a name="removedService-org.osgi.framework.ServiceReference-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removedService</h4>
<pre>public&nbsp;void&nbsp;removedService(org.osgi.framework.ServiceReference&nbsp;reference,
java.lang.Object&nbsp;service)</pre>
<div class="block">A Service that is a ContextHandler is being removed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>removedService</code>&nbsp;in interface&nbsp;<code>org.osgi.util.tracker.ServiceTrackerCustomizer</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServiceTrackerCustomizer.removedService(org.osgi.framework.ServiceReference, java.lang.Object)</code></dd>
</dl>
</li>
</ul>
<a name="addService-org.osgi.framework.BundleContext-org.eclipse.jetty.server.handler.ContextHandler-org.osgi.framework.ServiceReference-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addService</h4>
<pre>public&nbsp;java.lang.Object&nbsp;addService(org.osgi.framework.BundleContext&nbsp;context,
<a href="../../../../../../../org/eclipse/jetty/server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&nbsp;contextHandler,
org.osgi.framework.ServiceReference&nbsp;reference)</pre>
<div class="block">Deploy ContextHandler that is a Service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the bundle context</dd>
<dd><code>contextHandler</code> - the context handler</dd>
<dd><code>reference</code> - the service reference</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object added</dd>
</dl>
</li>
</ul>
<a name="removeService-org.osgi.framework.BundleContext-org.eclipse.jetty.server.handler.ContextHandler-org.osgi.framework.ServiceReference-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeService</h4>
<pre>public&nbsp;void&nbsp;removeService(org.osgi.framework.BundleContext&nbsp;context,
<a href="../../../../../../../org/eclipse/jetty/server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&nbsp;contextHandler,
org.osgi.framework.ServiceReference&nbsp;reference)</pre>
<div class="block">Undeploy a ContextHandler that is a Service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the bundle context</dd>
<dd><code>contextHandler</code> - the context handler</dd>
<dd><code>reference</code> - the service reference</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="class-use/ServiceWatcher.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">
<li><a href="../../../../../../../org/eclipse/jetty/osgi/boot/internal/webapp/OSGiWebappClassLoader.html" title="class in org.eclipse.jetty.osgi.boot.internal.webapp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/jetty/osgi/boot/internal/webapp/ServiceWatcher.html" target="_top">Frames</a></li>
<li><a href="ServiceWatcher.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>