| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:38:39 CST 2022 --> |
| <title>JettyRunMojo (Jetty :: Project 9.4.45.v20220203 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-02-08"> |
| <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="JettyRunMojo (Jetty :: Project 9.4.45.v20220203 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/JettyRunMojo.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.maven.plugin</a></div> |
| <h2 title="Class JettyRunMojo" class="title">Class JettyRunMojo</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>org.eclipse.jetty.maven.plugin.JettyRunMojo</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="JettyEffectiveWebXml.html" title="class in org.eclipse.jetty.maven.plugin">JettyEffectiveWebXml</a></code>, <code><a href="JettyRunDistro.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunDistro</a></code>, <code><a href="JettyRunForkedMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunForkedMojo</a></code>, <code><a href="JettyStartMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyStartMojo</a></code></dd> |
| </dl> |
| <hr> |
| <pre>@Mojo(name="run", |
| requiresDependencyResolution=TEST) |
| @Execute(phase=TEST_COMPILE) |
| public class <span class="typeNameLabel">JettyRunMojo</span> |
| extends <a href="AbstractJettyMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractJettyMojo</a></pre> |
| <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. |
| <p> |
| The plugin forks a parallel lifecycle to ensure that the "compile" phase has been completed before invoking Jetty. This means |
| that you do not need to explicitly execute a "mvn compile" first. It also means that a "mvn clean jetty:run" will ensure that |
| a full fresh compile is done before invoking Jetty. |
| <p> |
| Once invoked, the plugin can be configured to run continuously, scanning for changes in the project and automatically performing a |
| hot redeploy when necessary. This allows the developer to concentrate on coding changes to the project using their IDE of choice and have those changes |
| immediately and transparently reflected in the running web container, eliminating development time that is wasted on rebuilding, reassembling and redeploying. |
| <p> |
| You may also specify the location of a jetty.xml file whose contents will be applied before any plugin configuration. |
| This can be used, for example, to deploy a static webapp that is not part of your maven build. |
| <p> |
| There is a <a href="https://www.eclipse.org/jetty/documentation/current/maven-and-jetty.html">reference guide</a> to the configuration parameters for this plugin. |
| |
| Runs jetty directly from a maven project</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"> </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.io.File</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classesDirectory">classesDirectory</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The directory containing generated classes.</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="#DEFAULT_WEBAPP_SRC">DEFAULT_WEBAPP_SRC</a></span></code></th> |
| <td class="colLast"> </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"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="ScanPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanPattern</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanClassesPattern">scanClassesPattern</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An optional pattern for includes/excludes of classes in the classesDirectory</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="ScanTargetPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanTargetPattern</a>[]</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 <include> and <exclude> patterns |
| for extra targets to periodically scan for changes.</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="#scanTargets">scanTargets</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">List of files or directories to additionally periodically scan for changes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="ScanPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanPattern</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanTestClassesPattern">scanTestClassesPattern</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An optional pattern for includes/excludes of classes in the testClassesDirectory</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="#testClassesDirectory">testClassesDirectory</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The directory containing generated test classes.</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="#useTestScope">useTestScope</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">If true, the <testOutputDirectory> |
| and the dependencies of <scope>test<scope> |
| will be put first on the runtime classpath.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<org.apache.maven.artifact.Artifact></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="rowColor"> |
| <td class="colFirst"><code>protected <a href="WarPluginInfo.html" title="class in org.eclipse.jetty.maven.plugin">WarPluginInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#warPluginInfo">warPluginInfo</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">maven-war-plugin reference</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="#webAppSourceDirectory">webAppSourceDirectory</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Root directory for all html/jsp etc files</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="#webXml">webXml</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The default location of the web.xml file.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.maven.plugin.AbstractJettyMojo"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class 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 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"> </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()">JettyRunMojo</a></span>()</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkPomConfiguration()">checkPomConfiguration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Verify the configuration given in the pom.</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="#configureScanner()">configureScanner</a></span>()</code></th> |
| <td class="colLast"> </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="#configureWebApplication()">configureWebApplication</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Subclasses should invoke this to setup basic info |
| on the webapp</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="#execute()">execute</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileSeparators(java.lang.String)">fileSeparators</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> </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="#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#gatherScannables()">gatherScannables</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.artifact.Artifact</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArtifactForOverlay(org.eclipse.jetty.maven.plugin.OverlayConfig,java.util.List)">getArtifactForOverlay</a></span>​(<a href="OverlayConfig.html" title="class in org.eclipse.jetty.maven.plugin">OverlayConfig</a> o, |
| java.util.List<org.apache.maven.artifact.Artifact> warArtifacts)</code></th> |
| <td class="colLast"> </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="#getJavaBin()">getJavaBin</a></span>()</code></th> |
| <td class="colLast"> </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="#restartWebApp(boolean)">restartWebApp</a></span>​(boolean reconfigureScanner)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><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="#unpackOverlay(org.eclipse.jetty.maven.plugin.Overlay)">unpackOverlay</a></span>​(<a href="Overlay.html" title="class in org.eclipse.jetty.maven.plugin">Overlay</a> overlay)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unpackOverlays(java.util.List)">unpackOverlays</a></span>​(java.util.List<<a href="Overlay.html" title="class in org.eclipse.jetty.maven.plugin">Overlay</a>> overlays)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.maven.plugin.AbstractJettyMojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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 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 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="DEFAULT_WEBAPP_SRC"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_WEBAPP_SRC</h4> |
| <pre>public static final java.lang.String DEFAULT_WEBAPP_SRC</pre> |
| </li> |
| </ul> |
| <a id="FAKE_WEBAPP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FAKE_WEBAPP</h4> |
| <pre>public static final 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.JettyRunMojo.FAKE_WEBAPP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="useTestScope"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useTestScope</h4> |
| <pre>@Parameter(alias="useTestClasspath", |
| defaultValue="false") |
| protected boolean useTestScope</pre> |
| <div class="block">If true, the <testOutputDirectory> |
| and the dependencies of <scope>test<scope> |
| will be put first on the runtime classpath.</div> |
| </li> |
| </ul> |
| <a id="webXml"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>webXml</h4> |
| <pre>@Parameter(defaultValue="${maven.war.webxml}", |
| readonly=true) |
| protected java.lang.String webXml</pre> |
| <div class="block">The default location of the web.xml file. Will be used |
| if <webApp><descriptor> is not set.</div> |
| </li> |
| </ul> |
| <a id="classesDirectory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classesDirectory</h4> |
| <pre>@Parameter(defaultValue="${project.build.outputDirectory}", |
| required=true) |
| protected java.io.File classesDirectory</pre> |
| <div class="block">The directory containing generated classes.</div> |
| </li> |
| </ul> |
| <a id="scanClassesPattern"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanClassesPattern</h4> |
| <pre>@Parameter |
| protected <a href="ScanPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanPattern</a> scanClassesPattern</pre> |
| <div class="block">An optional pattern for includes/excludes of classes in the classesDirectory</div> |
| </li> |
| </ul> |
| <a id="testClassesDirectory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>testClassesDirectory</h4> |
| <pre>@Parameter(defaultValue="${project.build.testOutputDirectory}", |
| required=true) |
| protected java.io.File testClassesDirectory</pre> |
| <div class="block">The directory containing generated test classes.</div> |
| </li> |
| </ul> |
| <a id="scanTestClassesPattern"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanTestClassesPattern</h4> |
| <pre>@Parameter |
| protected <a href="ScanPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanPattern</a> scanTestClassesPattern</pre> |
| <div class="block">An optional pattern for includes/excludes of classes in the testClassesDirectory</div> |
| </li> |
| </ul> |
| <a id="webAppSourceDirectory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>webAppSourceDirectory</h4> |
| <pre>@Parameter(defaultValue="${maven.war.src}") |
| protected java.io.File webAppSourceDirectory</pre> |
| <div class="block">Root directory for all html/jsp etc files</div> |
| </li> |
| </ul> |
| <a id="scanTargets"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanTargets</h4> |
| <pre>@Parameter |
| protected java.io.File[] scanTargets</pre> |
| <div class="block">List of files or directories to additionally periodically scan for changes. Optional.</div> |
| </li> |
| </ul> |
| <a id="scanTargetPatterns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanTargetPatterns</h4> |
| <pre>@Parameter |
| protected <a href="ScanTargetPattern.html" title="class in org.eclipse.jetty.maven.plugin">ScanTargetPattern</a>[] scanTargetPatterns</pre> |
| <div class="block">List of directories with ant-style <include> and <exclude> patterns |
| for extra targets to periodically scan for changes. Can be used instead of, |
| or in conjunction with <scanTargets>.Optional.</div> |
| </li> |
| </ul> |
| <a id="warPluginInfo"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>warPluginInfo</h4> |
| <pre>protected <a href="WarPluginInfo.html" title="class in org.eclipse.jetty.maven.plugin">WarPluginInfo</a> warPluginInfo</pre> |
| <div class="block">maven-war-plugin reference</div> |
| </li> |
| </ul> |
| <a id="warArtifacts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>warArtifacts</h4> |
| <pre>protected java.util.List<org.apache.maven.artifact.Artifact> warArtifacts</pre> |
| <div class="block">List of deps that are wars</div> |
| </li> |
| </ul> |
| <a id="originalBaseResource"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>originalBaseResource</h4> |
| <pre>protected <a href="../../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> originalBaseResource</pre> |
| </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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JettyRunMojo</h4> |
| <pre>public JettyRunMojo()</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 void 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> in interface <code>org.apache.maven.plugin.Mojo</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#execute()">execute</a></code> in class <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> |
| <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="checkPomConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPomConfiguration</h4> |
| <pre class="methodSignature">public boolean checkPomConfiguration() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <div class="block">Verify the configuration given in the pom.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#checkPomConfiguration()">checkPomConfiguration</a></code> in class <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="finishConfigurationBeforeStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishConfigurationBeforeStart</h4> |
| <pre class="methodSignature">public void finishConfigurationBeforeStart() |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</a></code> in class <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="configureWebApplication()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureWebApplication</h4> |
| <pre class="methodSignature">public void configureWebApplication() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="AbstractJettyMojo.html#configureWebApplication()">AbstractJettyMojo</a></code></span></div> |
| <div class="block">Subclasses should invoke this to setup basic info |
| on the webapp</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#configureWebApplication()">configureWebApplication</a></code> in class <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 configure web application</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configureScanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureScanner</h4> |
| <pre class="methodSignature">public void configureScanner() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#configureScanner()">configureScanner</a></code> in class <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="gatherScannables()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>gatherScannables</h4> |
| <pre class="methodSignature">public void gatherScannables() |
| 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="restartWebApp(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartWebApp</h4> |
| <pre class="methodSignature">public void restartWebApp​(boolean reconfigureScanner) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AbstractJettyMojo.html#restartWebApp(boolean)">restartWebApp</a></code> in class <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="unpackOverlays(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpackOverlays</h4> |
| <pre class="methodSignature">public void unpackOverlays​(java.util.List<<a href="Overlay.html" title="class in org.eclipse.jetty.maven.plugin">Overlay</a>> overlays) |
| 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="unpackOverlay(org.eclipse.jetty.maven.plugin.Overlay)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpackOverlay</h4> |
| <pre class="methodSignature">public <a href="../../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> unpackOverlay​(<a href="Overlay.html" title="class in org.eclipse.jetty.maven.plugin">Overlay</a> overlay) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getArtifactForOverlay(org.eclipse.jetty.maven.plugin.OverlayConfig,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArtifactForOverlay</h4> |
| <pre class="methodSignature">protected org.apache.maven.artifact.Artifact getArtifactForOverlay​(<a href="OverlayConfig.html" title="class in org.eclipse.jetty.maven.plugin">OverlayConfig</a> o, |
| java.util.List<org.apache.maven.artifact.Artifact> warArtifacts)</pre> |
| </li> |
| </ul> |
| <a id="getJavaBin()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaBin</h4> |
| <pre class="methodSignature">protected java.lang.String getJavaBin()</pre> |
| </li> |
| </ul> |
| <a id="fileSeparators(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fileSeparators</h4> |
| <pre class="methodSignature">public static java.lang.String fileSeparators​(java.lang.String path)</pre> |
| </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/JettyRunMojo.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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |