blob: 81ad9bb225964a52a014f03fbb11afbd2876bef5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 -->
<title>ServerInstanceWrapper (Eclipse Jetty API Doc - v10.0.9)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-04">
<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.5.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="ServerInstanceWrapper (Eclipse Jetty API Doc - v10.0.9)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ServerInstanceWrapper.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.internal.serverfactory</a></div>
<h2 title="Class ServerInstanceWrapper" class="title">Class ServerInstanceWrapper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.osgi.boot.internal.serverfactory.ServerInstanceWrapper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ServerInstanceWrapper</span>
extends java.lang.Object</pre>
<div class="block">ServerInstanceWrapper
Configures and starts a jetty Server instance.</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 java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PROPERTY_THIS_JETTY_XML_FOLDER_URL">PROPERTY_THIS_JETTY_XML_FOLDER_URL</a></span></code></th>
<td class="colLast">
<div class="block">The value of this property points to the parent director of the jetty.xml
configuration file currently executed.</div>
</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(java.lang.String)">ServerInstanceWrapper</a></span>&#8203;(java.lang.String&nbsp;managedServerName)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addContainerTldBundleDiscoverer(org.eclipse.jetty.osgi.boot.utils.TldBundleDiscoverer)">addContainerTldBundleDiscoverer</a></span>&#8203;(<a href="../../utils/TldBundleDiscoverer.html" title="interface in org.eclipse.jetty.osgi.boot.utils">TldBundleDiscoverer</a>&nbsp;tldBundleDiscoverer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.eclipse.jetty.server.Server,java.util.List,java.util.Dictionary)">configure</a></span>&#8203;(<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.net.URL&gt;&nbsp;jettyConfigurations,
java.util.Dictionary&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;props)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.util.Collection&lt;<a href="../../utils/TldBundleDiscoverer.html" title="interface in org.eclipse.jetty.osgi.boot.utils">TldBundleDiscoverer</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainerTldBundleDiscoverers()">getContainerTldBundleDiscoverers</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../server/handler/ContextHandlerCollection.html" title="class in org.eclipse.jetty.server.handler">ContextHandlerCollection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContextHandlerCollection()">getContextHandlerCollection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../deploy/DeploymentManager.html" title="class in org.eclipse.jetty.deploy">DeploymentManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeploymentManager()">getDeploymentManager</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManagedServerName()">getManagedServerName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.ClassLoader</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentClassLoaderForWebapps()">getParentClassLoaderForWebapps</a></span>()</code></th>
<td class="colLast">
<div class="block">The classloader that should be the parent classloader for each webapp
deployed on this server.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServer()">getServer</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start(org.eclipse.jetty.server.Server,java.util.Dictionary)">start</a></span>&#8203;(<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.Dictionary&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;props)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<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="PROPERTY_THIS_JETTY_XML_FOLDER_URL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PROPERTY_THIS_JETTY_XML_FOLDER_URL</h4>
<pre>public static final&nbsp;java.lang.String PROPERTY_THIS_JETTY_XML_FOLDER_URL</pre>
<div class="block">The value of this property points to the parent director of the jetty.xml
configuration file currently executed. Everything is passed as a URL to
support the case where the bundle is zipped.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.internal.serverfactory.ServerInstanceWrapper.PROPERTY_THIS_JETTY_XML_FOLDER_URL">Constant Field Values</a></dd>
</dl>
</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;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerInstanceWrapper</h4>
<pre>public&nbsp;ServerInstanceWrapper&#8203;(java.lang.String&nbsp;managedServerName)</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="addContainerTldBundleDiscoverer(org.eclipse.jetty.osgi.boot.utils.TldBundleDiscoverer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContainerTldBundleDiscoverer</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;addContainerTldBundleDiscoverer&#8203;(<a href="../../utils/TldBundleDiscoverer.html" title="interface in org.eclipse.jetty.osgi.boot.utils">TldBundleDiscoverer</a>&nbsp;tldBundleDiscoverer)</pre>
</li>
</ul>
<a id="getContainerTldBundleDiscoverers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerTldBundleDiscoverers</h4>
<pre class="methodSignature">public static&nbsp;java.util.Collection&lt;<a href="../../utils/TldBundleDiscoverer.html" title="interface in org.eclipse.jetty.osgi.boot.utils">TldBundleDiscoverer</a>&gt;&nbsp;getContainerTldBundleDiscoverers()</pre>
</li>
</ul>
<a id="configure(org.eclipse.jetty.server.Server,java.util.List,java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;configure&#8203;(<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.net.URL&gt;&nbsp;jettyConfigurations,
java.util.Dictionary&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;props)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="getManagedServerName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagedServerName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getManagedServerName()</pre>
</li>
</ul>
<a id="getParentClassLoaderForWebapps()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentClassLoaderForWebapps</h4>
<pre class="methodSignature">public&nbsp;java.lang.ClassLoader&nbsp;getParentClassLoaderForWebapps()</pre>
<div class="block">The classloader that should be the parent classloader for each webapp
deployed on this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the classloader</dd>
</dl>
</li>
</ul>
<a id="getDeploymentManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeploymentManager</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../../deploy/DeploymentManager.html" title="class in org.eclipse.jetty.deploy">DeploymentManager</a>&nbsp;getDeploymentManager()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The deployment manager registered on this server.</dd>
</dl>
</li>
</ul>
<a id="getServer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServer</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;getServer()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The app provider registered on this server.</dd>
</dl>
</li>
</ul>
<a id="getContextHandlerCollection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextHandlerCollection</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../../server/handler/ContextHandlerCollection.html" title="class in org.eclipse.jetty.server.handler">ContextHandlerCollection</a>&nbsp;getContextHandlerCollection()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The collection of context handlers</dd>
</dl>
</li>
</ul>
<a id="start(org.eclipse.jetty.server.Server,java.util.Dictionary)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start&#8203;(<a href="../../../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.Dictionary&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;props)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
</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/ServerInstanceWrapper.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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>