blob: d78404c331656068e53a67e8f26dbb5e7a4045c2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Tue Mar 30 10:45:41 CDT 2021 -->
<title>AbstractWebAppMojo (Eclipse Jetty API Doc - v10.0.2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-03-30">
<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="AbstractWebAppMojo (Eclipse Jetty API Doc - v10.0.2)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":6,"i19":6,"i20":6,"i21":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractWebAppMojo.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><a href="#nested.class.summary">Nested</a>&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.maven.plugin</a></div>
<h2 title="Class AbstractWebAppMojo" class="title">Class AbstractWebAppMojo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.maven.plugin.AbstractMojo</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.maven.plugin.AbstractWebAppMojo</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="AbstractUnassembledWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractUnassembledWebAppMojo</a></code>, <code><a href="JettyRunWarMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunWarMojo</a></code>, <code><a href="JettyStartWarMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyStartWarMojo</a></code>, <code><a href="JettyStopMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyStopMojo</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractWebAppMojo</span>
extends org.apache.maven.plugin.AbstractMojo</pre>
<div class="block">AbstractWebAppMojo
Base class for common behaviour of jetty mojos.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractWebAppMojo.DeploymentMode.html" title="enum in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo.DeploymentMode</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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>protected java.util.List&lt;<a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextHandlers">contextHandlers</a></span></code></th>
<td class="colLast">
<div class="block">List of other contexts to set up.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextXml">contextXml</a></span></code></th>
<td class="colLast">
<div class="block">Location of a context xml configuration file whose contents
will be applied to the webapp AFTER anything in &lt;webApp&gt;.Optional.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="AbstractWebAppMojo.DeploymentMode.html" title="enum in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo.DeploymentMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deployMode">deployMode</a></span></code></th>
<td class="colLast">
<div class="block">Controls how to run jetty.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#env">env</a></span></code></th>
<td class="colLast">
<div class="block">Extra environment variables to be passed to the forked process</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#excludedGoals">excludedGoals</a></span></code></th>
<td class="colLast">
<div class="block">List of goals that are NOT to be used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.maven.plugin.MojoExecution</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execution">execution</a></span></code></th>
<td class="colLast">
<div class="block">The maven build executing.</div>
</td>
</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="#FAKE_WEBAPP">FAKE_WEBAPP</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forkWebXml">forkWebXml</a></span></code></th>
<td class="colLast">
<div class="block">The file into which to generate the quickstart web xml for the forked process to use</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="MavenServerConnector.html" title="class in org.eclipse.jetty.maven.plugin">MavenServerConnector</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpConnector">httpConnector</a></span></code></th>
<td class="colLast">
<div class="block">A ServerConnector to use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOME_ARTIFACTID">JETTY_HOME_ARTIFACTID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</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="#JETTY_HOME_GROUPID">JETTY_HOME_GROUPID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jettyBase">jettyBase</a></span></code></th>
<td class="colLast">
<div class="block">Location of jetty base directory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jettyHome">jettyHome</a></span></code></th>
<td class="colLast">
<div class="block">Location of jetty home directory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jettyProperties">jettyProperties</a></span></code></th>
<td class="colLast">
<div class="block">Optional jetty properties to put on the command line</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;java.io.File&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jettyXmls">jettyXmls</a></span></code></th>
<td class="colLast">
<div class="block">List of jetty xml configuration files whose contents
will be applied (in order declared) before any plugin configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jvmArgs">jvmArgs</a></span></code></th>
<td class="colLast">
<div class="block">Arbitrary jvm args to pass to the forked process</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loginServices">loginServices</a></span></code></th>
<td class="colLast">
<div class="block">List of security realms to set up.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="utils/MavenProjectHelper.html" title="class in org.eclipse.jetty.maven.plugin.utils">MavenProjectHelper</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mavenProjectHelper">mavenProjectHelper</a></span></code></th>
<td class="colLast">
<div class="block">Helper for interacting with the maven project space</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxChildStartCheckMs">maxChildStartCheckMs</a></span></code></th>
<td class="colLast">
<div class="block">How long to wait in msec between checks to see if jetty has started
correctly when running in FORK or EXTERNAL mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxChildStartChecks">maxChildStartChecks</a></span></code></th>
<td class="colLast">
<div class="block">Max number of times to check to see if jetty has started correctly
when running in FORK or EXTERNAL mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mergedSystemProperties">mergedSystemProperties</a></span></code></th>
<td class="colLast">
<div class="block">System properties from both systemPropertyFile and systemProperties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#modules">modules</a></span></code></th>
<td class="colLast">
<div class="block">Optional list of other modules to
activate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#originalBaseResource">originalBaseResource</a></span></code></th>
<td class="colLast">
<div class="block">Webapp base before applying overlays etc</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.maven.plugin.descriptor.PluginDescriptor</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plugin">plugin</a></span></code></th>
<td class="colLast">
<div class="block">This plugin</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;org.apache.maven.artifact.Artifact&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pluginArtifacts">pluginArtifacts</a></span></code></th>
<td class="colLast">
<div class="block">The artifacts for the plugin itself.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project">project</a></span></code></th>
<td class="colLast">
<div class="block">The maven project.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Set&lt;org.apache.maven.artifact.Artifact&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#projectArtifacts">projectArtifacts</a></span></code></th>
<td class="colLast">
<div class="block">The artifacts for the project.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;java.io.File&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#providedJars">providedJars</a></span></code></th>
<td class="colLast">
<div class="block">List of jars with scope=provided</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;org.apache.maven.project.MavenProject&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reactorProjects">reactorProjects</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestLog">requestLog</a></span></code></th>
<td class="colLast">
<div class="block">A RequestLog implementation to use for the webapp at runtime.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="ScanTargetPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanTargetPattern</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanTargetPatterns">scanTargetPatterns</a></span></code></th>
<td class="colLast">
<div class="block">List of directories with ant-style &lt;include&gt; and &lt;exclude&gt; patterns
for extra targets to periodically scan for changes.Optional.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="#server">server</a></span></code></th>
<td class="colLast">
<div class="block">A wrapper for the Server object</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skip">skip</a></span></code></th>
<td class="colLast">
<div class="block">Skip this mojo execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopKey">stopKey</a></span></code></th>
<td class="colLast">
<div class="block">Key to provide when stopping jetty on executing java -DSTOP.KEY=&lt;stopKey&gt;
-DSTOP.PORT=&lt;stopPort&gt; -jar start.jar --stop</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopPort">stopPort</a></span></code></th>
<td class="colLast">
<div class="block">Port to listen to stop jetty on executing -DSTOP.PORT=&lt;stopPort&gt;
-DSTOP.KEY=&lt;stopKey&gt; -jar start.jar --stop</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportedPackagings">supportedPackagings</a></span></code></th>
<td class="colLast">
<div class="block">Default supported project type is <code>war</code> packaging.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#systemProperties">systemProperties</a></span></code></th>
<td class="colLast">
<div class="block">System properties to set before execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#systemPropertiesFile">systemPropertiesFile</a></span></code></th>
<td class="colLast">
<div class="block">File containing system properties to be set before execution
Note that these properties will NOT override System properties
that have been set on the command line, by the JVM, or directly
in the POM via systemProperties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#target">target</a></span></code></th>
<td class="colLast">
<div class="block">The target directory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useProvidedScope">useProvidedScope</a></span></code></th>
<td class="colLast">
<div class="block">Whether or not to include dependencies on the plugin's classpath with &lt;scope&gt;provided&lt;/scope&gt;
Use WITH CAUTION as you may wind up with duplicate jars/classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useTestScope">useTestScope</a></span></code></th>
<td class="colLast">
<div class="block">If true, the &lt;testOutputDirectory&gt;
and the dependencies of &lt;scope&gt;test&lt;scope&gt;
will be put first on the runtime classpath.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;org.apache.maven.artifact.Artifact&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#warArtifacts">warArtifacts</a></span></code></th>
<td class="colLast">
<div class="block">List of deps that are wars</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="MavenWebAppContext.html" title="class in org.eclipse.jetty.maven.plugin">MavenWebAppContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webApp">webApp</a></span></code></th>
<td class="colLast">
<div class="block">An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.maven.plugin.Mojo</h3>
<code>ROLE</code></li>
</ul>
</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()">AbstractWebAppMojo</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="#augmentPluginClasspath()">augmentPluginClasspath</a></span>()</code></th>
<td class="colLast">
<div class="block">Augment jetty's classpath with dependencies marked as scope=provided
if useProvidedScope==true.</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="#configureScanTargetPatterns(org.eclipse.jetty.util.Scanner)">configureScanTargetPatterns</a></span>&#8203;(<a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a>&nbsp;scanner)</code></th>
<td class="colLast">
<div class="block">Configure any extra files, directories or patterns thereof for the
scanner to watch for changes.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureSystemProperties()">configureSystemProperties</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureWebApp()">configureWebApp</a></span>()</code></th>
<td class="colLast">
<div class="block">Ensure there is a webapp, and that some basic defaults are applied
if the user has not supplied them.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute()">execute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findJettyWebXmlFile(java.io.File)">findJettyWebXmlFile</a></span>&#8203;(java.io.File&nbsp;webInfDir)</code></th>
<td class="colLast">
<div class="block">Try and find a jetty-web.xml file, using some
historical naming conventions if necessary.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContainerClassPath()">getContainerClassPath</a></span>()</code></th>
<td class="colLast">
<div class="block">Synthesize a classpath appropriate for a forked jetty based off
the artifacts associated with the jetty plugin, plus any dependencies
that are marked as provided and useProvidedScope is true.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJettyOutputFile(java.lang.String)">getJettyOutputFile</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get a file into which to write output from jetty.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProjectName()">getProjectName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected java.util.List&lt;java.io.File&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProvidedJars()">getProvidedJars</a></span>()</code></th>
<td class="colLast">
<div class="block">Get any dependencies that are scope "provided" if useProvidedScope == true.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExcludedGoal(java.lang.String)">isExcludedGoal</a></span>&#8203;(java.lang.String&nbsp;goal)</code></th>
<td class="colLast">
<div class="block">Check if the goal that we're executing as is excluded or not.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPackagingSupported()">isPackagingSupported</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPluginArtifact(org.apache.maven.artifact.Artifact)">isPluginArtifact</a></span>&#8203;(org.apache.maven.artifact.Artifact&nbsp;artifact)</code></th>
<td class="colLast">
<div class="block">Check to see if the given artifact is one of the dependency artifacts for this plugin.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mergeSystemProperties()">mergeSystemProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Unite system properties set via systemPropertiesFile element and the systemProperties element.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected <a href="JettyEmbedder.html" title="class in org.eclipse.jetty.maven.plugin">JettyEmbedder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newJettyEmbedder()">newJettyEmbedder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected <a href="JettyForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyForker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newJettyForker()">newJettyForker</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected <a href="JettyHomeForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyHomeForker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newJettyHomeForker()">newJettyHomeForker</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startJetty()">startJetty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startJettyEmbedded()">startJettyEmbedded</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startJettyForked()">startJettyForked</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startJettyHome()">startJettyHome</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verifyPomConfiguration()">verifyPomConfiguration</a></span>()</code></th>
<td class="colLast">
<div class="block">Used by subclasses.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.maven.plugin.AbstractMojo</h3>
<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
</ul>
<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="JETTY_HOME_GROUPID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_HOME_GROUPID</h4>
<pre>public static final&nbsp;java.lang.String JETTY_HOME_GROUPID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.maven.plugin.AbstractWebAppMojo.JETTY_HOME_GROUPID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_HOME_ARTIFACTID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_HOME_ARTIFACTID</h4>
<pre>public static final&nbsp;java.lang.String JETTY_HOME_ARTIFACTID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.maven.plugin.AbstractWebAppMojo.JETTY_HOME_ARTIFACTID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="FAKE_WEBAPP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAKE_WEBAPP</h4>
<pre>public static final&nbsp;java.lang.String FAKE_WEBAPP</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.maven.plugin.AbstractWebAppMojo.FAKE_WEBAPP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="maxChildStartChecks">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxChildStartChecks</h4>
<pre>@Parameter(defaultValue="10")
protected&nbsp;int maxChildStartChecks</pre>
<div class="block">Max number of times to check to see if jetty has started correctly
when running in FORK or EXTERNAL mode.</div>
</li>
</ul>
<a id="maxChildStartCheckMs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxChildStartCheckMs</h4>
<pre>@Parameter(defaultValue="200")
protected&nbsp;long maxChildStartCheckMs</pre>
<div class="block">How long to wait in msec between checks to see if jetty has started
correctly when running in FORK or EXTERNAL mode.</div>
</li>
</ul>
<a id="useProvidedScope">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useProvidedScope</h4>
<pre>@Parameter(defaultValue="false")
protected&nbsp;boolean useProvidedScope</pre>
<div class="block">Whether or not to include dependencies on the plugin's classpath with &lt;scope&gt;provided&lt;/scope&gt;
Use WITH CAUTION as you may wind up with duplicate jars/classes.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>jetty-7.5.2</dd>
</dl>
</li>
</ul>
<a id="excludedGoals">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludedGoals</h4>
<pre>@Parameter
protected&nbsp;java.lang.String[] excludedGoals</pre>
<div class="block">List of goals that are NOT to be used</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>jetty-7.5.2</dd>
</dl>
</li>
</ul>
<a id="webApp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>webApp</h4>
<pre>@Parameter
protected&nbsp;<a href="MavenWebAppContext.html" title="class in org.eclipse.jetty.maven.plugin">MavenWebAppContext</a> webApp</pre>
<div class="block">An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp.
Use any of its setters to configure the webapp. This is the preferred and most
flexible method of configuration, rather than using the (deprecated) individual
parameters like "tmpDirectory", "contextPath" etc.</div>
</li>
</ul>
<a id="skip">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skip</h4>
<pre>@Parameter(property="jetty.skip",
defaultValue="false")
protected&nbsp;boolean skip</pre>
<div class="block">Skip this mojo execution.</div>
</li>
</ul>
<a id="contextXml">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextXml</h4>
<pre>@Parameter
protected&nbsp;java.lang.String contextXml</pre>
<div class="block">Location of a context xml configuration file whose contents
will be applied to the webapp AFTER anything in &lt;webApp&gt;.Optional.</div>
</li>
</ul>
<a id="project">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>project</h4>
<pre>@Parameter(defaultValue="${project}",
readonly=true)
protected&nbsp;org.apache.maven.project.MavenProject project</pre>
<div class="block">The maven project.</div>
</li>
</ul>
<a id="projectArtifacts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>projectArtifacts</h4>
<pre>@Parameter(defaultValue="${project.artifacts}",
readonly=true)
protected&nbsp;java.util.Set&lt;org.apache.maven.artifact.Artifact&gt; projectArtifacts</pre>
<div class="block">The artifacts for the project.</div>
</li>
</ul>
<a id="execution">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execution</h4>
<pre>@Parameter(defaultValue="${mojoExecution}",
readonly=true)
protected&nbsp;org.apache.maven.plugin.MojoExecution execution</pre>
<div class="block">The maven build executing.</div>
</li>
</ul>
<a id="pluginArtifacts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pluginArtifacts</h4>
<pre>@Parameter(defaultValue="${plugin.artifacts}",
readonly=true)
protected&nbsp;java.util.List&lt;org.apache.maven.artifact.Artifact&gt; pluginArtifacts</pre>
<div class="block">The artifacts for the plugin itself.</div>
</li>
</ul>
<a id="useTestScope">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useTestScope</h4>
<pre>@Parameter(defaultValue="false")
protected&nbsp;boolean useTestScope</pre>
<div class="block">If true, the &lt;testOutputDirectory&gt;
and the dependencies of &lt;scope&gt;test&lt;scope&gt;
will be put first on the runtime classpath.</div>
</li>
</ul>
<a id="scanTargetPatterns">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanTargetPatterns</h4>
<pre>@Parameter
protected&nbsp;java.util.List&lt;<a href="ScanTargetPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanTargetPattern</a>&gt; scanTargetPatterns</pre>
<div class="block">List of directories with ant-style &lt;include&gt; and &lt;exclude&gt; patterns
for extra targets to periodically scan for changes.Optional.</div>
</li>
</ul>
<a id="reactorProjects">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reactorProjects</h4>
<pre>@Parameter(defaultValue="${reactorProjects}",
readonly=true,
required=true)
protected&nbsp;java.util.List&lt;org.apache.maven.project.MavenProject&gt; reactorProjects</pre>
</li>
</ul>
<a id="target">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>target</h4>
<pre>@Parameter(defaultValue="${project.build.directory}",
required=true,
readonly=true)
protected&nbsp;java.io.File target</pre>
<div class="block">The target directory</div>
</li>
</ul>
<a id="jettyXmls">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jettyXmls</h4>
<pre>@Parameter
protected&nbsp;java.util.List&lt;java.io.File&gt; jettyXmls</pre>
<div class="block">List of jetty xml configuration files whose contents
will be applied (in order declared) before any plugin configuration. Optional.</div>
</li>
</ul>
<a id="jettyProperties">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jettyProperties</h4>
<pre>@Parameter
protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt; jettyProperties</pre>
<div class="block">Optional jetty properties to put on the command line</div>
</li>
</ul>
<a id="systemPropertiesFile">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>systemPropertiesFile</h4>
<pre>@Parameter(property="jetty.systemPropertiesFile")
protected&nbsp;java.io.File systemPropertiesFile</pre>
<div class="block">File containing system properties to be set before execution
Note that these properties will NOT override System properties
that have been set on the command line, by the JVM, or directly
in the POM via systemProperties. Optional.</div>
</li>
</ul>
<a id="systemProperties">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>systemProperties</h4>
<pre>@Parameter
protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt; systemProperties</pre>
<div class="block">System properties to set before execution.
Note that these properties will NOT override System properties
that have been set on the command line or by the JVM. They WILL
override System properties that have been set via systemPropertiesFile.
Optional.</div>
</li>
</ul>
<a id="deployMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deployMode</h4>
<pre>@Parameter(property="jetty.deployMode",
defaultValue="EMBED")
protected&nbsp;<a href="AbstractWebAppMojo.DeploymentMode.html" title="enum in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo.DeploymentMode</a> deployMode</pre>
<div class="block">Controls how to run jetty. Valid values are EMBED,FORK,EXTERNAL.</div>
</li>
</ul>
<a id="contextHandlers">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextHandlers</h4>
<pre>@Parameter
protected&nbsp;java.util.List&lt;<a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>&gt; contextHandlers</pre>
<div class="block">List of other contexts to set up. Consider using instead
the &lt;jettyXml&gt; element to specify external jetty xml config file.
Optional.</div>
</li>
</ul>
<a id="loginServices">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loginServices</h4>
<pre>@Parameter
protected&nbsp;java.util.List&lt;<a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>&gt; loginServices</pre>
<div class="block">List of security realms to set up. Consider using instead
the &lt;jettyXml&gt; element to specify external jetty xml config file.
Optional.</div>
</li>
</ul>
<a id="requestLog">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestLog</h4>
<pre>@Parameter
protected&nbsp;<a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a> requestLog</pre>
<div class="block">A RequestLog implementation to use for the webapp at runtime.
Consider using instead the &lt;jettyXml&gt; element to specify external jetty xml config file.
Optional.</div>
</li>
</ul>
<a id="httpConnector">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpConnector</h4>
<pre>@Parameter
protected&nbsp;<a href="MavenServerConnector.html" title="class in org.eclipse.jetty.maven.plugin">MavenServerConnector</a> httpConnector</pre>
<div class="block">A ServerConnector to use.</div>
</li>
</ul>
<a id="server">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>server</h4>
<pre>@Parameter
protected&nbsp;<a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server</pre>
<div class="block">A wrapper for the Server object</div>
</li>
</ul>
<a id="env">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>env</h4>
<pre>@Parameter
protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt; env</pre>
<div class="block">Extra environment variables to be passed to the forked process</div>
</li>
</ul>
<a id="jvmArgs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jvmArgs</h4>
<pre>@Parameter(property="jetty.jvmArgs")
protected&nbsp;java.lang.String jvmArgs</pre>
<div class="block">Arbitrary jvm args to pass to the forked process</div>
</li>
</ul>
<a id="stopPort">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopPort</h4>
<pre>@Parameter
protected&nbsp;int stopPort</pre>
<div class="block">Port to listen to stop jetty on executing -DSTOP.PORT=&lt;stopPort&gt;
-DSTOP.KEY=&lt;stopKey&gt; -jar start.jar --stop</div>
</li>
</ul>
<a id="stopKey">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopKey</h4>
<pre>@Parameter
protected&nbsp;java.lang.String stopKey</pre>
<div class="block">Key to provide when stopping jetty on executing java -DSTOP.KEY=&lt;stopKey&gt;
-DSTOP.PORT=&lt;stopPort&gt; -jar start.jar --stop</div>
</li>
</ul>
<a id="jettyHome">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jettyHome</h4>
<pre>@Parameter
protected&nbsp;java.io.File jettyHome</pre>
<div class="block">Location of jetty home directory</div>
</li>
</ul>
<a id="jettyBase">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jettyBase</h4>
<pre>@Parameter
protected&nbsp;java.io.File jettyBase</pre>
<div class="block">Location of jetty base directory</div>
</li>
</ul>
<a id="modules">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>modules</h4>
<pre>@Parameter
protected&nbsp;java.lang.String[] modules</pre>
<div class="block">Optional list of other modules to
activate.</div>
</li>
</ul>
<a id="forkWebXml">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forkWebXml</h4>
<pre>@Parameter(defaultValue="${project.build.directory}/fork-web.xml")
protected&nbsp;java.io.File forkWebXml</pre>
<div class="block">The file into which to generate the quickstart web xml for the forked process to use</div>
</li>
</ul>
<a id="mavenProjectHelper">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mavenProjectHelper</h4>
<pre>protected&nbsp;<a href="utils/MavenProjectHelper.html" title="class in org.eclipse.jetty.maven.plugin.utils">MavenProjectHelper</a> mavenProjectHelper</pre>
<div class="block">Helper for interacting with the maven project space</div>
</li>
</ul>
<a id="plugin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plugin</h4>
<pre>@Parameter(defaultValue="${plugin}",
readonly=true,
required=true)
protected&nbsp;org.apache.maven.plugin.descriptor.PluginDescriptor plugin</pre>
<div class="block">This plugin</div>
</li>
</ul>
<a id="supportedPackagings">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportedPackagings</h4>
<pre>@Parameter
protected&nbsp;java.util.List&lt;java.lang.String&gt; supportedPackagings</pre>
<div class="block">Default supported project type is <code>war</code> packaging.</div>
</li>
</ul>
<a id="warArtifacts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>warArtifacts</h4>
<pre>protected&nbsp;java.util.List&lt;org.apache.maven.artifact.Artifact&gt; warArtifacts</pre>
<div class="block">List of deps that are wars</div>
</li>
</ul>
<a id="originalBaseResource">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>originalBaseResource</h4>
<pre>protected&nbsp;<a href="../../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> originalBaseResource</pre>
<div class="block">Webapp base before applying overlays etc</div>
</li>
</ul>
<a id="providedJars">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>providedJars</h4>
<pre>protected&nbsp;java.util.List&lt;java.io.File&gt; providedJars</pre>
<div class="block">List of jars with scope=provided</div>
</li>
</ul>
<a id="mergedSystemProperties">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mergedSystemProperties</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt; mergedSystemProperties</pre>
<div class="block">System properties from both systemPropertyFile and systemProperties.</div>
</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractWebAppMojo</h4>
<pre>public&nbsp;AbstractWebAppMojo()</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="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
</dl>
</li>
</ul>
<a id="startJetty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startJetty</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;startJetty()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
</dl>
</li>
</ul>
<a id="startJettyEmbedded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startJettyEmbedded</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;startJettyEmbedded()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="startJettyForked()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startJettyForked</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;startJettyForked()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="startJettyHome()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startJettyHome</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;startJettyHome()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="newJettyEmbedder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newJettyEmbedder</h4>
<pre class="methodSignature">protected&nbsp;<a href="JettyEmbedder.html" title="class in org.eclipse.jetty.maven.plugin">JettyEmbedder</a>&nbsp;newJettyEmbedder()
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="newJettyForker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newJettyForker</h4>
<pre class="methodSignature">protected&nbsp;<a href="JettyForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyForker</a>&nbsp;newJettyForker()
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="newJettyHomeForker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newJettyHomeForker</h4>
<pre class="methodSignature">protected&nbsp;<a href="JettyHomeForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyHomeForker</a>&nbsp;newJettyHomeForker()
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="verifyPomConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyPomConfiguration</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;verifyPomConfiguration()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Used by subclasses.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="mergeSystemProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeSystemProperties</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;mergeSystemProperties()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Unite system properties set via systemPropertiesFile element and the systemProperties element.
Properties from the pom override properties from the file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>united properties map</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="configureSystemProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureSystemProperties</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;configureSystemProperties()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="augmentPluginClasspath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>augmentPluginClasspath</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;augmentPluginClasspath()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Augment jetty's classpath with dependencies marked as scope=provided
if useProvidedScope==true.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="getProvidedJars()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProvidedJars</h4>
<pre class="methodSignature">protected&nbsp;java.util.List&lt;java.io.File&gt;&nbsp;getProvidedJars()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Get any dependencies that are scope "provided" if useProvidedScope == true. Ensure
that only those dependencies that are not already present via the plugin are
included.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>provided scope dependencies that are not also plugin dependencies.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
</dl>
</li>
</ul>
<a id="getContainerClassPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerClassPath</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;getContainerClassPath()
throws java.lang.Exception</pre>
<div class="block">Synthesize a classpath appropriate for a forked jetty based off
the artifacts associated with the jetty plugin, plus any dependencies
that are marked as provided and useProvidedScope is true.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>jetty classpath</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="isPluginArtifact(org.apache.maven.artifact.Artifact)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPluginArtifact</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isPluginArtifact&#8203;(org.apache.maven.artifact.Artifact&nbsp;artifact)</pre>
<div class="block">Check to see if the given artifact is one of the dependency artifacts for this plugin.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>artifact</code> - to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it is a plugin dependency, false otherwise</dd>
</dl>
</li>
</ul>
<a id="isExcludedGoal(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExcludedGoal</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isExcludedGoal&#8203;(java.lang.String&nbsp;goal)</pre>
<div class="block">Check if the goal that we're executing as is excluded or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the goal is excluded, false otherwise</dd>
</dl>
</li>
</ul>
<a id="isPackagingSupported()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPackagingSupported</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isPackagingSupported()</pre>
</li>
</ul>
<a id="getProjectName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProjectName</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;getProjectName()</pre>
</li>
</ul>
<a id="configureWebApp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureWebApp</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;configureWebApp()
throws java.lang.Exception</pre>
<div class="block">Ensure there is a webapp, and that some basic defaults are applied
if the user has not supplied them.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="findJettyWebXmlFile(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findJettyWebXmlFile</h4>
<pre class="methodSignature">protected&nbsp;java.io.File&nbsp;findJettyWebXmlFile&#8203;(java.io.File&nbsp;webInfDir)</pre>
<div class="block">Try and find a jetty-web.xml file, using some
historical naming conventions if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>webInfDir</code> - the web inf directory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the jetty web xml file</dd>
</dl>
</li>
</ul>
<a id="getJettyOutputFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJettyOutputFile</h4>
<pre class="methodSignature">protected&nbsp;java.io.File&nbsp;getJettyOutputFile&#8203;(java.lang.String&nbsp;name)
throws java.lang.Exception</pre>
<div class="block">Get a file into which to write output from jetty.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the created file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="configureScanTargetPatterns(org.eclipse.jetty.util.Scanner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configureScanTargetPatterns</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;configureScanTargetPatterns&#8203;(<a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a>&nbsp;scanner)
throws java.io.IOException</pre>
<div class="block">Configure any extra files, directories or patterns thereof for the
scanner to watch for changes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scanner</code> - Scanner that notices changes in files and dirs.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</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/AbstractWebAppMojo.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><a href="#nested.class.summary">Nested</a>&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;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>