| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>JettyRunMojo (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.maven.plugin, class: JettyRunMojo"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.maven.plugin</a></div> |
| <h1 title="Class JettyRunMojo" class="title">Class JettyRunMojo</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.maven.plugin.AbstractMojo |
| <div class="inheritance"><a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">org.eclipse.jetty.maven.plugin.AbstractWebAppMojo</a> |
| <div class="inheritance"><a href="AbstractUnassembledWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">org.eclipse.jetty.maven.plugin.AbstractUnassembledWebAppMojo</a> |
| <div class="inheritance">org.eclipse.jetty.maven.plugin.JettyRunMojo</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Mojo(name="run", |
| requiresDependencyResolution=TEST) |
| @Execute(phase=TEST_COMPILE) |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">JettyRunMojo</span> |
| <span class="extends-implements">extends <a href="AbstractUnassembledWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractUnassembledWebAppMojo</a></span></div> |
| <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 runs a parallel lifecycle to ensure that the "test-compile" phase has been completed before invoking Jetty. This means |
| that you do not need to explicity 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. |
| Alternatively, you can configure the plugin to wait for an <enter> at the command line to manually control redeployment. |
| <p> |
| You can configure this goal to run your unassembled webapp either in-process with maven, or forked into a new process, or deployed into a |
| jetty distribution.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.maven.plugin.AbstractWebAppMojo">Nested classes/interfaces inherited from class org.eclipse.jetty.maven.plugin.<a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></h2> |
| <code><a href="AbstractWebAppMojo.DeploymentMode.html" title="enum in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo.DeploymentMode</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="JettyEmbedder.html" title="class in org.eclipse.jetty.maven.plugin">JettyEmbedder</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#embedder" class="member-name-link">embedder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Only one of the following will be used, depending the mode |
| the mojo is started in: EMBED, FORK, EXTERNAL</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <a href="JettyForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyForker</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#forker" class="member-name-link">forker</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="JettyHomeForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyHomeForker</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#homeForker" class="member-name-link">homeForker</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#scan" class="member-name-link">scan</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Controls redeployment of the webapp.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#scanner" class="member-name-link">scanner</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Scanner to check for files changes to cause redeploy</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.maven.plugin.AbstractUnassembledWebAppMojo">Fields inherited from class org.eclipse.jetty.maven.plugin.<a href="AbstractUnassembledWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractUnassembledWebAppMojo</a></h3> |
| <code><a href="AbstractUnassembledWebAppMojo.html#classesDirectory">classesDirectory</a>, <a href="AbstractUnassembledWebAppMojo.html#scanClassesPattern">scanClassesPattern</a>, <a href="AbstractUnassembledWebAppMojo.html#scanTestClassesPattern">scanTestClassesPattern</a>, <a href="AbstractUnassembledWebAppMojo.html#testClassesDirectory">testClassesDirectory</a>, <a href="AbstractUnassembledWebAppMojo.html#webAppSourceDirectory">webAppSourceDirectory</a>, <a href="AbstractUnassembledWebAppMojo.html#webXml">webXml</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.maven.plugin.AbstractWebAppMojo">Fields inherited from class org.eclipse.jetty.maven.plugin.<a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></h3> |
| <code><a href="AbstractWebAppMojo.html#contextHandlers">contextHandlers</a>, <a href="AbstractWebAppMojo.html#contextXml">contextXml</a>, <a href="AbstractWebAppMojo.html#deployMode">deployMode</a>, <a href="AbstractWebAppMojo.html#env">env</a>, <a href="AbstractWebAppMojo.html#excludedGoals">excludedGoals</a>, <a href="AbstractWebAppMojo.html#execution">execution</a>, <a href="AbstractWebAppMojo.html#FAKE_WEBAPP">FAKE_WEBAPP</a>, <a href="AbstractWebAppMojo.html#forkWebXml">forkWebXml</a>, <a href="AbstractWebAppMojo.html#httpConnector">httpConnector</a>, <a href="AbstractWebAppMojo.html#JETTY_HOME_ARTIFACTID">JETTY_HOME_ARTIFACTID</a>, <a href="AbstractWebAppMojo.html#JETTY_HOME_GROUPID">JETTY_HOME_GROUPID</a>, <a href="AbstractWebAppMojo.html#jettyBase">jettyBase</a>, <a href="AbstractWebAppMojo.html#jettyHome">jettyHome</a>, <a href="AbstractWebAppMojo.html#jettyOptions">jettyOptions</a>, <a href="AbstractWebAppMojo.html#jettyProperties">jettyProperties</a>, <a href="AbstractWebAppMojo.html#jettyXmls">jettyXmls</a>, <a href="AbstractWebAppMojo.html#jvmArgs">jvmArgs</a>, <a href="AbstractWebAppMojo.html#loginServices">loginServices</a>, <a href="AbstractWebAppMojo.html#mavenProjectHelper">mavenProjectHelper</a>, <a href="AbstractWebAppMojo.html#maxChildStartCheckMs">maxChildStartCheckMs</a>, <a href="AbstractWebAppMojo.html#maxChildStartChecks">maxChildStartChecks</a>, <a href="AbstractWebAppMojo.html#mergedSystemProperties">mergedSystemProperties</a>, <a href="AbstractWebAppMojo.html#modules">modules</a>, <a href="AbstractWebAppMojo.html#originalBaseResource">originalBaseResource</a>, <a href="AbstractWebAppMojo.html#plugin">plugin</a>, <a href="AbstractWebAppMojo.html#pluginArtifacts">pluginArtifacts</a>, <a href="AbstractWebAppMojo.html#project">project</a>, <a href="AbstractWebAppMojo.html#projectArtifacts">projectArtifacts</a>, <a href="AbstractWebAppMojo.html#providedJars">providedJars</a>, <a href="AbstractWebAppMojo.html#reactorProjects">reactorProjects</a>, <a href="AbstractWebAppMojo.html#requestLog">requestLog</a>, <a href="AbstractWebAppMojo.html#scanTargetPatterns">scanTargetPatterns</a>, <a href="AbstractWebAppMojo.html#server">server</a>, <a href="AbstractWebAppMojo.html#skip">skip</a>, <a href="AbstractWebAppMojo.html#stopKey">stopKey</a>, <a href="AbstractWebAppMojo.html#stopPort">stopPort</a>, <a href="AbstractWebAppMojo.html#supportedPackagings">supportedPackagings</a>, <a href="AbstractWebAppMojo.html#systemProperties">systemProperties</a>, <a href="AbstractWebAppMojo.html#systemPropertiesFile">systemPropertiesFile</a>, <a href="AbstractWebAppMojo.html#target">target</a>, <a href="AbstractWebAppMojo.html#useProvidedScope">useProvidedScope</a>, <a href="AbstractWebAppMojo.html#useTestScope">useTestScope</a>, <a href="AbstractWebAppMojo.html#warArtifacts">warArtifacts</a>, <a href="AbstractWebAppMojo.html#webApp">webApp</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> |
| <code>ROLE</code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JettyRunMojo</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureScanner()" class="member-name-link">configureScanner</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#gatherScannables()" class="member-name-link">gatherScannables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restartWebApp(boolean)" class="member-name-link">restartWebApp</a><wbr>(boolean reconfigure)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stop an executing webapp and restart it after optionally |
| reconfiguring it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startJettyEmbedded()" class="member-name-link">startJettyEmbedded</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startJettyForked()" class="member-name-link">startJettyForked</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startJettyHome()" class="member-name-link">startJettyHome</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.maven.plugin.AbstractUnassembledWebAppMojo">Methods inherited from class org.eclipse.jetty.maven.plugin.<a href="AbstractUnassembledWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractUnassembledWebAppMojo</a></h3> |
| <code><a href="AbstractUnassembledWebAppMojo.html#configureUnassembledWebApp()">configureUnassembledWebApp</a>, <a href="AbstractUnassembledWebAppMojo.html#configureWebApp()">configureWebApp</a>, <a href="AbstractUnassembledWebAppMojo.html#getWebInfLibArtifacts()">getWebInfLibArtifacts</a>, <a href="AbstractUnassembledWebAppMojo.html#verifyPomConfiguration()">verifyPomConfiguration</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.maven.plugin.AbstractWebAppMojo">Methods inherited from class org.eclipse.jetty.maven.plugin.<a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></h3> |
| <code><a href="AbstractWebAppMojo.html#augmentPluginClasspath()">augmentPluginClasspath</a>, <a href="AbstractWebAppMojo.html#configureScanTargetPatterns(org.eclipse.jetty.util.Scanner)">configureScanTargetPatterns</a>, <a href="AbstractWebAppMojo.html#configureSystemProperties()">configureSystemProperties</a>, <a href="AbstractWebAppMojo.html#findJettyWebXmlFile(java.io.File)">findJettyWebXmlFile</a>, <a href="AbstractWebAppMojo.html#getContainerClassPath()">getContainerClassPath</a>, <a href="AbstractWebAppMojo.html#getJettyOutputFile(java.lang.String)">getJettyOutputFile</a>, <a href="AbstractWebAppMojo.html#getProjectName()">getProjectName</a>, <a href="AbstractWebAppMojo.html#getProvidedJars()">getProvidedJars</a>, <a href="AbstractWebAppMojo.html#isExcludedGoal(java.lang.String)">isExcludedGoal</a>, <a href="AbstractWebAppMojo.html#isPackagingSupported()">isPackagingSupported</a>, <a href="AbstractWebAppMojo.html#isPluginArtifact(org.apache.maven.artifact.Artifact)">isPluginArtifact</a>, <a href="AbstractWebAppMojo.html#mergeSystemProperties()">mergeSystemProperties</a>, <a href="AbstractWebAppMojo.html#newJettyEmbedder()">newJettyEmbedder</a>, <a href="AbstractWebAppMojo.html#newJettyForker()">newJettyForker</a>, <a href="AbstractWebAppMojo.html#newJettyHomeForker()">newJettyHomeForker</a>, <a href="AbstractWebAppMojo.html#startJetty()">startJetty</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> |
| <code>getLog, getPluginContext, setLog, setPluginContext</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="scan"> |
| <h3>scan</h3> |
| <div class="member-signature"><span class="annotations">@Parameter(defaultValue="-1", |
| property="jetty.scan", |
| required=true) |
| </span><span class="modifiers">protected</span> <span class="return-type">int</span> <span class="element-name">scan</span></div> |
| <div class="block">Controls redeployment of the webapp. |
| <ol> |
| <li> -1 : means no redeployment will be done </li> |
| <li> 0 : means redeployment only occurs if you hit the ENTER key </li> |
| <li> otherwise, the interval in seconds to pause before checking and redeploying if necessary </li> |
| </ol></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scanner"> |
| <h3>scanner</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a></span> <span class="element-name">scanner</span></div> |
| <div class="block">Scanner to check for files changes to cause redeploy</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="embedder"> |
| <h3>embedder</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JettyEmbedder.html" title="class in org.eclipse.jetty.maven.plugin">JettyEmbedder</a></span> <span class="element-name">embedder</span></div> |
| <div class="block">Only one of the following will be used, depending the mode |
| the mojo is started in: EMBED, FORK, EXTERNAL</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forker"> |
| <h3>forker</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JettyForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyForker</a></span> <span class="element-name">forker</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="homeForker"> |
| <h3>homeForker</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JettyHomeForker.html" title="class in org.eclipse.jetty.maven.plugin">JettyHomeForker</a></span> <span class="element-name">homeForker</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>JettyRunMojo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JettyRunMojo</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="execute()"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException, |
| org.apache.maven.plugin.MojoFailureException</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>execute</code> in interface <code>org.apache.maven.plugin.Mojo</code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractWebAppMojo.html#execute()">execute</a></code> in class <code><a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| <dd><code>org.apache.maven.plugin.MojoFailureException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startJettyEmbedded()"> |
| <h3>startJettyEmbedded</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">startJettyEmbedded</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractWebAppMojo.html#startJettyEmbedded()">startJettyEmbedded</a></code> in class <code><a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startJettyForked()"> |
| <h3>startJettyForked</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">startJettyForked</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractWebAppMojo.html#startJettyForked()">startJettyForked</a></code> in class <code><a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startJettyHome()"> |
| <h3>startJettyHome</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">startJettyHome</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractWebAppMojo.html#startJettyHome()">startJettyHome</a></code> in class <code><a href="AbstractWebAppMojo.html" title="class in org.eclipse.jetty.maven.plugin">AbstractWebAppMojo</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configureScanner()"> |
| <h3>configureScanner</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">configureScanner</span>() |
| throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="gatherScannables()"> |
| <h3>gatherScannables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">gatherScannables</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="restartWebApp(boolean)"> |
| <h3>restartWebApp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">restartWebApp</span><wbr><span class="parameters">(boolean reconfigure)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Stop an executing webapp and restart it after optionally |
| reconfiguring it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>reconfigure</code> - if true, the scanner will |
| be reconfigured after changes to the pom. If false, only |
| the webapp will be reconfigured.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
