Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / maven / plugin / JettyRunDistro.html
blob: 4e51c55ca87cb6aefde96dace4bddbcc7c7e6dc2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>JettyRunDistro (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<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="JettyRunDistro (Jetty :: Project 9.4.38.v20210224 API)";
}
}
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};
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/JettyRunDistro.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.maven.plugin</a></div>
<h2 title="Class JettyRunDistro" class="title">Class JettyRunDistro</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.JettyRunDistro</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="run-distro",
requiresDependencyResolution=TEST)
@Execute(phase=TEST_COMPILE)
public class <span class="typeNameLabel">JettyRunDistro</span>
extends <a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></pre>
<div class="block">This goal is used to deploy the unassembled webapp into a jetty distribution. If the location
of an existing unpacked distribution is not supplied as the configuration param jettyHome,
this goal will download and unpack the jetty distro matching the version of this plugin before deploying the webapp.
The webapp will execute in the distro in a forked process.
The <b>stopKey</b>, <b>stopPort</b> configuration elements can be used to control the stopping of the forked process. By default, this plugin will launch
the forked jetty instance and wait for it to complete (in which case it acts much like the <b>jetty:run</b> goal, and you will need to Cntrl-C to stop).
By setting the configuration element <b>waitForChild</b> to <b>false</b>, the plugin will terminate after having forked the jetty process. In this case
you can use the <b>jetty:stop</b> goal to terminate the process.
This goal does NOT support the <b>scanIntervalSeconds</b> parameter: the webapp will be deployed only once.
See <a href="https://www.eclipse.org/jetty/documentation/">https://www.eclipse.org/jetty/documentation</a> for more information on this and other jetty plugins.
Runs unassembled webapp in a locally installed jetty distro</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOME_ARTIFACTID">JETTY_HOME_ARTIFACTID</a></span></code></th>
<td class="colLast">&nbsp;</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_GROUPID">JETTY_HOME_GROUPID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<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="rowColor">
<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>
</table>
<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()">JettyRunDistro</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>java.lang.ProcessBuilder</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureCommand()">configureCommand</a></span>()</code></th>
<td class="colLast">
<div class="block">Make the command to spawn a process to
run jetty from a distro.</div>
</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="#configureJettyBase()">configureJettyBase</a></span>()</code></th>
<td class="colLast">
<div class="block">Create or configure a jetty base.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureJettyHome()">configureJettyHome</a></span>()</code></th>
<td class="colLast">
<div class="block">If jetty home does not exist, download it and
unpack to build dir.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureScanner()">configureScanner</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#createPropertiesFile(java.io.File)">createPropertiesFile</a></span>&#8203;(java.io.File&nbsp;file)</code></th>
<td class="colLast">
<div class="block">Convert webapp config to properties</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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="i6" class="altColor">
<td class="colFirst"><code>org.apache.maven.artifact.Artifact</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">resolveArtifact</a></span>&#8203;(java.lang.String&nbsp;groupId,
java.lang.String&nbsp;artifactId,
java.lang.String&nbsp;version,
java.lang.String&nbsp;extension)</code></th>
<td class="colLast">
<div class="block">Resolve an Artifact from remote repo if necessary.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#restartWebApp(boolean)">restartWebApp</a></span>&#8203;(boolean&nbsp;reconfigureScanner)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startJetty()">startJetty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startScanner()">startScanner</a></span>()</code></th>
<td class="colLast">
<div class="block">Run a scanner thread on the given list of files and directories, calling
stop/start on the given list of LifeCycle objects if any of the watched
files change.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopScanner()">stopScanner</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#configureWebApplication()">configureWebApplication</a>, <a href="JettyRunMojo.html#fileSeparators(java.lang.String)">fileSeparators</a>, <a href="JettyRunMojo.html#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</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#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></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">
<!-- ============ 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.JettyRunDistro.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.JettyRunDistro.JETTY_HOME_ARTIFACTID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="plugin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plugin</h4>
<pre>@Parameter(defaultValue="${plugin}",
required=true,
readonly=true)
protected&nbsp;org.apache.maven.plugin.descriptor.PluginDescriptor plugin</pre>
<div class="block">This plugin</div>
</li>
</ul>
<a id="target">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>target</h4>
<pre>@Parameter(defaultValue="${project.build.directory}",
readonly=true,
required=true)
protected&nbsp;java.io.File target</pre>
<div class="block">The target directory</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>JettyRunDistro</h4>
<pre>public&nbsp;JettyRunDistro()</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><a href="JettyRunMojo.html#execute()"><code>JettyRunMojo.execute()</code></a></dd>
</dl>
</li>
</ul>
<a id="startJetty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startJetty</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;startJetty()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractJettyMojo.html#startJetty()">startJetty</a></code>&nbsp;in class&nbsp;<code><a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractJettyMojo.html#startJetty()"><code>AbstractJettyMojo.startJetty()</code></a></dd>
</dl>
</li>
</ul>
<a id="configureJettyHome()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureJettyHome</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configureJettyHome()
throws java.lang.Exception</pre>
<div class="block">If jetty home does not exist, download it and
unpack to build dir.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if jetty distribution cannot be found neither downloaded</dd>
</dl>
</li>
</ul>
<a id="resolveArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveArtifact</h4>
<pre class="methodSignature">public&nbsp;org.apache.maven.artifact.Artifact&nbsp;resolveArtifact&#8203;(java.lang.String&nbsp;groupId,
java.lang.String&nbsp;artifactId,
java.lang.String&nbsp;version,
java.lang.String&nbsp;extension)
throws org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException</pre>
<div class="block">Resolve an Artifact from remote repo if necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>groupId</code> - the groupid of the artifact</dd>
<dd><code>artifactId</code> - the artifactId of the artifact</dd>
<dd><code>version</code> - the version of the artifact</dd>
<dd><code>extension</code> - the extension type of the artifact eg "zip", "jar"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the artifact from the local or remote repo</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException</code> - in case of an error while resolving the artifact</dd>
</dl>
</li>
</ul>
<a id="configureJettyBase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureJettyBase</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configureJettyBase()
throws java.lang.Exception</pre>
<div class="block">Create or configure a jetty base.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if any error occurred while copying files</dd>
</dl>
</li>
</ul>
<a id="createPropertiesFile(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPropertiesFile</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;createPropertiesFile&#8203;(java.io.File&nbsp;file)
throws java.lang.Exception</pre>
<div class="block">Convert webapp config to properties</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - the file to place the properties into</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if any I/O exception during generating the properties file</dd>
</dl>
</li>
</ul>
<a id="configureCommand()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureCommand</h4>
<pre class="methodSignature">public&nbsp;java.lang.ProcessBuilder&nbsp;configureCommand()</pre>
<div class="block">Make the command to spawn a process to
run jetty from a distro.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the command configured</dd>
</dl>
</li>
</ul>
<a id="startScanner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startScanner</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;startScanner()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="AbstractJettyMojo.html#startScanner()">AbstractJettyMojo</a></code></span></div>
<div class="block">Run a scanner thread on the given list of files and directories, calling
stop/start on the given list of LifeCycle objects if any of the watched
files change.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractJettyMojo.html#startScanner()">startScanner</a></code>&nbsp;in class&nbsp;<code><a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to start scanner</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractJettyMojo.html#startScanner()"><code>AbstractJettyMojo.startScanner()</code></a></dd>
</dl>
</li>
</ul>
<a id="stopScanner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopScanner</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stopScanner()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractJettyMojo.html#stopScanner()">stopScanner</a></code>&nbsp;in class&nbsp;<code><a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractJettyMojo.html#stopScanner()"><code>AbstractJettyMojo.stopScanner()</code></a></dd>
</dl>
</li>
</ul>
<a id="restartWebApp(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restartWebApp</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;restartWebApp&#8203;(boolean&nbsp;reconfigureScanner)
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="JettyRunMojo.html#restartWebApp(boolean)">restartWebApp</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractJettyMojo.html#restartWebApp(boolean)"><code>AbstractJettyMojo.restartWebApp(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="configureScanner()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configureScanner</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configureScanner()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="JettyRunMojo.html#configureScanner()">configureScanner</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractJettyMojo.html#configureScanner()"><code>AbstractJettyMojo.configureScanner()</code></a></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/JettyRunDistro.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>