blob: e081cf1e36c5523eb8aedec93b04ca5343a8e5d4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Fri Apr 10 16:48:14 EDT 2020 -->
<title>JettyStartMojo (Jetty :: Project 9.4.28.v20200408 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-10">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JettyStartMojo (Jetty :: Project 9.4.28.v20200408 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
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/JettyStartMojo.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>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 JettyStartMojo" class="title">Class JettyStartMojo</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><a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">org.eclipse.jetty.maven.plugin.AbstractJettyMojo</a></li>
<li>
<ul class="inheritance">
<li><a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">org.eclipse.jetty.maven.plugin.JettyRunMojo</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.maven.plugin.JettyStartMojo</li>
</ul>
</li>
</ul>
</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>
<hr>
<pre>@Mojo(name="start",
requiresDependencyResolution=TEST)
@Execute(phase=VALIDATE)
public class <span class="typeNameLabel">JettyStartMojo</span>
extends <a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></pre>
<div class="block"><p>
This goal is similar to the jetty:run goal, EXCEPT that it is designed to be bound to an execution inside your pom, rather
than being run from the command line.
</p>
<p>
When using it, be careful to ensure that you bind it to a phase in which all necessary generated files and classes for the webapp
will have been created. If you run it from the command line, then also ensure that all necessary generated files and classes for
the webapp already exist.
</p>
Runs jetty directly from a maven project from a binding to an execution in your pom</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>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.maven.plugin.JettyRunMojo">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.maven.plugin.<a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></h3>
<code><a href="JettyRunMojo.html#classesDirectory">classesDirectory</a>, <a href="JettyRunMojo.html#DEFAULT_WEBAPP_SRC">DEFAULT_WEBAPP_SRC</a>, <a href="JettyRunMojo.html#FAKE_WEBAPP">FAKE_WEBAPP</a>, <a href="JettyRunMojo.html#originalBaseResource">originalBaseResource</a>, <a href="JettyRunMojo.html#scanClassesPattern">scanClassesPattern</a>, <a href="JettyRunMojo.html#scanTargetPatterns">scanTargetPatterns</a>, <a href="JettyRunMojo.html#scanTargets">scanTargets</a>, <a href="JettyRunMojo.html#scanTestClassesPattern">scanTestClassesPattern</a>, <a href="JettyRunMojo.html#testClassesDirectory">testClassesDirectory</a>, <a href="JettyRunMojo.html#useTestScope">useTestScope</a>, <a href="JettyRunMojo.html#warArtifacts">warArtifacts</a>, <a href="JettyRunMojo.html#warPluginInfo">warPluginInfo</a>, <a href="JettyRunMojo.html#webAppSourceDirectory">webAppSourceDirectory</a>, <a href="JettyRunMojo.html#webXml">webXml</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.maven.plugin.AbstractJettyMojo">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.maven.plugin.<a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></h3>
<code><a href="AbstractJettyMojo.html#consoleScanner">consoleScanner</a>, <a href="AbstractJettyMojo.html#contextHandlers">contextHandlers</a>, <a href="AbstractJettyMojo.html#contextXml">contextXml</a>, <a href="AbstractJettyMojo.html#dumpOnStart">dumpOnStart</a>, <a href="AbstractJettyMojo.html#excludedGoals">excludedGoals</a>, <a href="AbstractJettyMojo.html#execution">execution</a>, <a href="AbstractJettyMojo.html#httpConnector">httpConnector</a>, <a href="AbstractJettyMojo.html#jettyXml">jettyXml</a>, <a href="AbstractJettyMojo.html#loginServices">loginServices</a>, <a href="AbstractJettyMojo.html#nonBlocking">nonBlocking</a>, <a href="AbstractJettyMojo.html#pluginArtifacts">pluginArtifacts</a>, <a href="AbstractJettyMojo.html#project">project</a>, <a href="AbstractJettyMojo.html#projectArtifacts">projectArtifacts</a>, <a href="AbstractJettyMojo.html#reload">reload</a>, <a href="AbstractJettyMojo.html#requestLog">requestLog</a>, <a href="AbstractJettyMojo.html#scanIntervalSeconds">scanIntervalSeconds</a>, <a href="AbstractJettyMojo.html#scanner">scanner</a>, <a href="AbstractJettyMojo.html#server">server</a>, <a href="AbstractJettyMojo.html#serverSupport">serverSupport</a>, <a href="AbstractJettyMojo.html#skip">skip</a>, <a href="AbstractJettyMojo.html#stopKey">stopKey</a>, <a href="AbstractJettyMojo.html#stopPort">stopPort</a>, <a href="AbstractJettyMojo.html#supportedPackagings">supportedPackagings</a>, <a href="AbstractJettyMojo.html#systemProperties">systemProperties</a>, <a href="AbstractJettyMojo.html#systemPropertiesFile">systemPropertiesFile</a>, <a href="AbstractJettyMojo.html#useProvidedScope">useProvidedScope</a>, <a href="AbstractJettyMojo.html#webApp">webApp</a></code></li>
</ul>
<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()">JettyStartMojo</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="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>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="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.maven.plugin.JettyRunMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.maven.plugin.<a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></h3>
<code><a href="JettyRunMojo.html#checkPomConfiguration()">checkPomConfiguration</a>, <a href="JettyRunMojo.html#configureScanner()">configureScanner</a>, <a href="JettyRunMojo.html#configureWebApplication()">configureWebApplication</a>, <a href="JettyRunMojo.html#fileSeparators(java.lang.String)">fileSeparators</a>, <a href="JettyRunMojo.html#gatherScannables()">gatherScannables</a>, <a href="JettyRunMojo.html#getArtifactForOverlay(org.eclipse.jetty.maven.plugin.OverlayConfig,java.util.List)">getArtifactForOverlay</a>, <a href="JettyRunMojo.html#getJavaBin()">getJavaBin</a>, <a href="JettyRunMojo.html#restartWebApp(boolean)">restartWebApp</a>, <a href="JettyRunMojo.html#unpackOverlay(org.eclipse.jetty.maven.plugin.Overlay)">unpackOverlay</a>, <a href="JettyRunMojo.html#unpackOverlays(java.util.List)">unpackOverlays</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.maven.plugin.AbstractJettyMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.maven.plugin.<a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></h3>
<code><a href="AbstractJettyMojo.html#applyJettyXml()">applyJettyXml</a>, <a href="AbstractJettyMojo.html#checkPackagingConfiguration()">checkPackagingConfiguration</a>, <a href="AbstractJettyMojo.html#configureMonitor()">configureMonitor</a>, <a href="AbstractJettyMojo.html#configurePluginClasspath()">configurePluginClasspath</a>, <a href="AbstractJettyMojo.html#findJettyWebXmlFile(java.io.File)">findJettyWebXmlFile</a>, <a href="AbstractJettyMojo.html#getJettyXmlFiles()">getJettyXmlFiles</a>, <a href="AbstractJettyMojo.html#getSkipMessage(java.lang.String)">getSkipMessage</a>, <a href="AbstractJettyMojo.html#isConfigurationSupported()">isConfigurationSupported</a>, <a href="AbstractJettyMojo.html#isExcluded(java.lang.String)">isExcluded</a>, <a href="AbstractJettyMojo.html#isPluginArtifact(org.apache.maven.artifact.Artifact)">isPluginArtifact</a>, <a href="AbstractJettyMojo.html#isScanningEnabled()">isScanningEnabled</a>, <a href="AbstractJettyMojo.html#printSystemProperties()">printSystemProperties</a>, <a href="AbstractJettyMojo.html#setSystemProperties(org.eclipse.jetty.maven.plugin.SystemProperties)">setSystemProperties</a>, <a href="AbstractJettyMojo.html#setSystemPropertiesFile(java.io.File)">setSystemPropertiesFile</a>, <a href="AbstractJettyMojo.html#startConsoleScanner()">startConsoleScanner</a>, <a href="AbstractJettyMojo.html#startJetty()">startJetty</a>, <a href="AbstractJettyMojo.html#startScanner()">startScanner</a>, <a href="AbstractJettyMojo.html#stopScanner()">stopScanner</a></code></li>
</ul>
<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">
<!-- ========= 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>JettyStartMojo</h4>
<pre>public&nbsp;JettyStartMojo()</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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>execute</code>&nbsp;in interface&nbsp;<code>org.apache.maven.plugin.Mojo</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="JettyRunMojo.html#execute()">execute</a></code>&nbsp;in class&nbsp;<code><a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></code></dd>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Mojo.execute()</code></dd>
</dl>
</li>
</ul>
<a id="finishConfigurationBeforeStart()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finishConfigurationBeforeStart</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;finishConfigurationBeforeStart()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="JettyRunMojo.html#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</a></code>&nbsp;in class&nbsp;<code><a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></code></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/JettyStartMojo.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>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;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>