blob: 07fa73bb3c96cabc551b98d11881ade04f9c1fbd [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Fri May 22 12:37:48 EDT 2020 -->
<title>org.eclipse.jetty.maven.plugin (Jetty :: Project 9.4.29.v20200521 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-05-22">
<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="org.eclipse.jetty.maven.plugin (Jetty :: Project 9.4.29.v20200521 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.jetty.maven.plugin</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Maven Plugin : Support for Jetty in Maven build lifecycle</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></th>
<td class="colLast">
<div class="block">Common base class for most jetty mojos.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ConsoleScanner.html" title="class in org.eclipse.jetty.maven.plugin">ConsoleScanner</a></th>
<td class="colLast">
<div class="block">ConsoleScanner
Read input from stdin</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HelpMojo.html" title="class in org.eclipse.jetty.maven.plugin">HelpMojo</a></th>
<td class="colLast">
<div class="block">Display help information on jetty-maven-plugin.<br>
Call <code>mvn jetty:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyDeployWar.html" title="class in org.eclipse.jetty.maven.plugin">JettyDeployWar</a></th>
<td class="colLast">
<div class="block">
This goal is used to run Jetty with a pre-assembled war.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JettyEffectiveWebXml.html" title="class in org.eclipse.jetty.maven.plugin">JettyEffectiveWebXml</a></th>
<td class="colLast">
<div class="block">This goal runs the jetty quickstart feature on an unassembled webapp in order to generate
a comprehensive web.xml that combines all information from annotations, webdefault.xml and all web-fragment.xml
files.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyRunDistro.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunDistro</a></th>
<td class="colLast">
<div class="block">This goal is used to deploy the unassembled webapp into a jetty distribution.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JettyRunForkedMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunForkedMojo</a></th>
<td class="colLast">
<div class="block">This goal is used to deploy your unassembled webapp into a forked JVM.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></th>
<td class="colLast">
<div class="block">This goal is used in-situ on a Maven project without first requiring that the project
is assembled into a war, saving time during the development cycle.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JettyRunWarExplodedMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunWarExplodedMojo</a></th>
<td class="colLast">
<div class="block">
This goal is used to assemble your webapp into an exploded war and automatically deploy it to Jetty.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyRunWarMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunWarMojo</a></th>
<td class="colLast">
<div class="block">
This goal is used to assemble your webapp into a war and automatically deploy it to Jetty.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JettyStartMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyStartMojo</a></th>
<td class="colLast">
<div class="block">
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.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyStopMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyStopMojo</a></th>
<td class="colLast">
<div class="block">This goal stops a running instance of jetty.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JettyWebAppContext.html" title="class in org.eclipse.jetty.maven.plugin">JettyWebAppContext</a></th>
<td class="colLast">
<div class="block">JettyWebAppContext
Extends the WebAppContext to specialize for the maven environment.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MavenQuickStartConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenQuickStartConfiguration</a></th>
<td class="colLast">
<div class="block">MavenQuickStartConfiguration</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MavenServerConnector.html" title="class in org.eclipse.jetty.maven.plugin">MavenServerConnector</a></th>
<td class="colLast">
<div class="block">MavenServerConnector
As the ServerConnector class does not have a no-arg constructor, and moreover requires
the server instance passed in to all its constructors, it cannot
be referenced in the pom.xml.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MavenWebInfConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenWebInfConfiguration</a></th>
<td class="colLast">
<div class="block">MavenWebInfConfiguration
WebInfConfiguration to take account of overlaid wars expressed as project dependencies and
potential configured via the maven-war-plugin.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Overlay.html" title="class in org.eclipse.jetty.maven.plugin">Overlay</a></th>
<td class="colLast">
<div class="block">Overlay</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OverlayConfig.html" title="class in org.eclipse.jetty.maven.plugin">OverlayConfig</a></th>
<td class="colLast">
<div class="block">OverlayConfig</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PluginLog.html" title="class in org.eclipse.jetty.maven.plugin">PluginLog</a></th>
<td class="colLast">
<div class="block">PluginLog
Convenience class to provide access to the plugin
Log for non-mojo classes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScanPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanPattern</a></th>
<td class="colLast">
<div class="block">ScanPattern
Ant-style pattern of includes and excludes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ScanTargetPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanTargetPattern</a></th>
<td class="colLast">
<div class="block">ScanTargetPattern
Utility class to provide the ability for the mvn jetty:run
mojo to be able to specify filesets of extra files to
regularly scan for changes in order to redeploy the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SelectiveJarResource.html" title="class in org.eclipse.jetty.maven.plugin">SelectiveJarResource</a></th>
<td class="colLast">
<div class="block">SelectiveJarResource
Selectively copies resources from a jar file based on includes/excludes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServerConnectorListener.html" title="class in org.eclipse.jetty.maven.plugin">ServerConnectorListener</a></th>
<td class="colLast">
<div class="block">ServerConnectorListener
This is for test support, where we need jetty to run on a random port, and we need
a client to be able to find out which port was picked.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ServerListener.html" title="class in org.eclipse.jetty.maven.plugin">ServerListener</a></th>
<td class="colLast">
<div class="block">ServerListener
Listener to create a file that signals that the startup is completed.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServerSupport.html" title="class in org.eclipse.jetty.maven.plugin">ServerSupport</a></th>
<td class="colLast">
<div class="block">ServerSupport
Helps configure the Server instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Starter.html" title="class in org.eclipse.jetty.maven.plugin">Starter</a></th>
<td class="colLast">
<div class="block">Starter Class which is exec'ed to create a new jetty process.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SystemProperties.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperties</a></th>
<td class="colLast">
<div class="block">SystemProperties
Map of name to SystemProperty.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SystemProperty.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperty</a></th>
<td class="colLast">
<div class="block">SystemProperty
Provides the ability to set System properties
for the mojo execution.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WarPluginInfo.html" title="class in org.eclipse.jetty.maven.plugin">WarPluginInfo</a></th>
<td class="colLast">
<div class="block">WarPluginInfo</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WebAppPropertyConverter.html" title="class in org.eclipse.jetty.maven.plugin">WebAppPropertyConverter</a></th>
<td class="colLast">
<div class="block">WebAppPropertyConverter
Converts a webapp's configuration to a properties file, and
vice versa.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>