blob: 2f76be0bf55464962a05c4c6239b216bfc48765d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 -->
<title>ServerSupport (Eclipse Jetty API Doc - v10.0.7)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-10-11">
<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="ServerSupport (Eclipse Jetty API Doc - v10.0.7)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ServerSupport.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>Field&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>Field&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.maven.plugin</a></div>
<h2 title="Class ServerSupport" class="title">Class ServerSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.maven.plugin.ServerSupport</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ServerSupport</span>
extends java.lang.Object</pre>
<div class="block">ServerSupport
Helps configure the Server instance.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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()">ServerSupport</a></span>()</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="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="#addWebApplication(org.eclipse.jetty.server.Server,org.eclipse.jetty.webapp.WebAppContext)">addWebApplication</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
<a href="../../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;webapp)</code></th>
<td class="colLast">
<div class="block">Add a WebAppContext to a Server</div>
</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="#applyXmlConfigurations(org.eclipse.jetty.server.Server,java.util.List)">applyXmlConfigurations</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.io.File&gt;&nbsp;files)</code></th>
<td class="colLast">
<div class="block">Apply xml files to server instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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="#applyXmlConfigurations(org.eclipse.jetty.server.Server,java.util.List,java.util.Map)">applyXmlConfigurations</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.io.File&gt;&nbsp;files,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)</code></th>
<td class="colLast">
<div class="block">Apply xml files to server instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureConnectors(org.eclipse.jetty.server.Server,org.eclipse.jetty.server.Connector,java.util.Map)">configureConnectors</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
<a href="../../server/Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)</code></th>
<td class="colLast">
<div class="block">Configure at least one connector for the server</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureDefaultConfigurationClasses(org.eclipse.jetty.server.Server)">configureDefaultConfigurationClasses</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureHandlers(org.eclipse.jetty.server.Server,java.util.List,org.eclipse.jetty.server.RequestLog)">configureHandlers</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;<a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&gt;&nbsp;contextHandlers,
<a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a>&nbsp;requestLog)</code></th>
<td class="colLast">
<div class="block">Set up the handler structure to receive a webapp.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureLoginServices(org.eclipse.jetty.server.Server,java.util.List)">configureLoginServices</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;<a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&gt;&nbsp;loginServices)</code></th>
<td class="colLast">
<div class="block">Set up any security LoginServices provided.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <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="#findContextHandlerCollection(org.eclipse.jetty.server.Server)">findContextHandlerCollection</a></span>&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</code></th>
<td class="colLast">
<div class="block">Locate a ContextHandlerCollection for a Server.</div>
</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">
<!-- ========= 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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerSupport</h4>
<pre>public&nbsp;ServerSupport()</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="configureDefaultConfigurationClasses(org.eclipse.jetty.server.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureDefaultConfigurationClasses</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;configureDefaultConfigurationClasses&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</pre>
</li>
</ul>
<a id="configureHandlers(org.eclipse.jetty.server.Server,java.util.List,org.eclipse.jetty.server.RequestLog)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureHandlers</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;configureHandlers&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;<a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&gt;&nbsp;contextHandlers,
<a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a>&nbsp;requestLog)
throws java.lang.Exception</pre>
<div class="block">Set up the handler structure to receive a webapp.
Also put in a DefaultHandler so we get a nicer page
than a 404 if we hit the root and the webapp's
context isn't at root.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server to use</dd>
<dd><code>contextHandlers</code> - the context handlers to include</dd>
<dd><code>requestLog</code> - a request log to use</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="configureConnectors(org.eclipse.jetty.server.Server,org.eclipse.jetty.server.Connector,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureConnectors</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;configureConnectors&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
<a href="../../server/Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)</pre>
<div class="block">Configure at least one connector for the server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server</dd>
<dd><code>connector</code> - the connector</dd>
<dd><code>properties</code> - jetty properties</dd>
</dl>
</li>
</ul>
<a id="configureLoginServices(org.eclipse.jetty.server.Server,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureLoginServices</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;configureLoginServices&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;<a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&gt;&nbsp;loginServices)</pre>
<div class="block">Set up any security LoginServices provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server</dd>
<dd><code>loginServices</code> - the login services</dd>
</dl>
</li>
</ul>
<a id="addWebApplication(org.eclipse.jetty.server.Server,org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWebApplication</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;addWebApplication&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
<a href="../../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;webapp)
throws java.lang.Exception</pre>
<div class="block">Add a WebAppContext to a Server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server to use</dd>
<dd><code>webapp</code> - the webapp to add</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="findContextHandlerCollection(org.eclipse.jetty.server.Server)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findContextHandlerCollection</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../server/handler/ContextHandlerCollection.html" title="class in org.eclipse.jetty.server.handler">ContextHandlerCollection</a>&nbsp;findContextHandlerCollection&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server)</pre>
<div class="block">Locate a ContextHandlerCollection for a Server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the Server to check.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The ContextHandlerCollection or null if not found.</dd>
</dl>
</li>
</ul>
<a id="applyXmlConfigurations(org.eclipse.jetty.server.Server,java.util.List,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyXmlConfigurations</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;applyXmlConfigurations&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.io.File&gt;&nbsp;files,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)
throws java.lang.Exception</pre>
<div class="block">Apply xml files to server instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the server to apply the xml to</dd>
<dd><code>files</code> - the list of xml files</dd>
<dd><code>properties</code> - list of jetty properties</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Server implementation, after the xml is applied</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to apply the xml configuration</dd>
</dl>
</li>
</ul>
<a id="applyXmlConfigurations(org.eclipse.jetty.server.Server,java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>applyXmlConfigurations</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;applyXmlConfigurations&#8203;(<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a>&nbsp;server,
java.util.List&lt;java.io.File&gt;&nbsp;files)
throws java.lang.Exception</pre>
<div class="block">Apply xml files to server instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - the Server instance to configure</dd>
<dd><code>files</code> - the xml configs to apply</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Server after application of configs</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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/ServerSupport.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>Field&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>Field&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;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>