| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:37:38 EDT 2021 --> |
| <title>AbstractJettyMojo (Jetty :: Project 9.4.42.v20210604 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-06-14"> |
| <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="AbstractJettyMojo (Jetty :: Project 9.4.42.v20210604 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":6,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractJettyMojo.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 AbstractJettyMojo" class="title">Class AbstractJettyMojo</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>org.eclipse.jetty.maven.plugin.AbstractJettyMojo</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="JettyRunMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunMojo</a></code>, <code><a href="JettyRunWarExplodedMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunWarExplodedMojo</a></code>, <code><a href="JettyRunWarMojo.html" title="class in org.eclipse.jetty.maven.plugin">JettyRunWarMojo</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">AbstractJettyMojo</span> |
| extends org.apache.maven.plugin.AbstractMojo</pre> |
| <div class="block">Common base class for most jetty mojos.</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.lang.Thread</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#consoleScanner">consoleScanner</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A scanner to check ENTER hits on the console</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextHandlers">contextHandlers</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">List of other contexts to set up.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextXml">contextXml</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Location of a context xml configuration file whose contents |
| will be applied to the webapp AFTER anything in <webApp>.Optional.</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="#dumpOnStart">dumpOnStart</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Use the dump() facility of jetty to print out the server configuration to logging</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#excludedGoals">excludedGoals</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">List of goals that are NOT to be used</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.plugin.MojoExecution</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execution">execution</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="MavenServerConnector.html" title="class in org.eclipse.jetty.maven.plugin">MavenServerConnector</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpConnector">httpConnector</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A ServerConnector to use.</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="#jettyXml">jettyXml</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Comma separated list of a jetty xml configuration files whose contents |
| will be applied before any plugin configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loginServices">loginServices</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">List of security realms to set up.</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="#nonBlocking">nonBlocking</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"> |
| Determines whether or not the server blocks when started.</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="#pluginArtifacts">pluginArtifacts</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The artifacts for the plugin itself.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#project">project</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The maven project.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.Set<org.apache.maven.artifact.Artifact></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#projectArtifacts">projectArtifacts</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The artifacts for the project.</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="#reload">reload</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">reload can be set to either 'automatic' or 'manual' |
| |
| if 'manual' then the context can be reloaded by a linefeed in the console |
| if 'automatic' then traditional reloading on changed files is enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestLog">requestLog</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A RequestLog implementation to use for the webapp at runtime.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanIntervalSeconds">scanIntervalSeconds</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The interval in seconds to scan the webapp for changes |
| and restart the context if necessary.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanner">scanner</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A scanner to check for changes to the webapp</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#server">server</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A wrapper for the Server object</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="ServerSupport.html" title="class in org.eclipse.jetty.maven.plugin">ServerSupport</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serverSupport">serverSupport</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skip">skip</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Skip this mojo execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopKey">stopKey</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> |
| -DSTOP.PORT=<stopPort> -jar start.jar --stop</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopPort">stopPort</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> |
| -DSTOP.KEY=<stopKey> -jar start.jar --stop</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportedPackagings">supportedPackagings</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Per default this goal support only <code>war</code> packaging.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="SystemProperties.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperties</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#systemProperties">systemProperties</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">System properties to set before execution.</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="#systemPropertiesFile">systemPropertiesFile</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">File containing system properties to be set before execution |
| |
| Note that these properties will NOT override System properties |
| that have been set on the command line, by the JVM, or directly |
| in the POM via systemProperties.</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="#useProvidedScope">useProvidedScope</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Whether or not to include dependencies on the plugin's classpath with <scope>provided</scope> |
| Use WITH CAUTION as you may wind up with duplicate jars/classes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="JettyWebAppContext.html" title="class in org.eclipse.jetty.maven.plugin">JettyWebAppContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#webApp">webApp</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp.</div> |
| </td> |
| </tr> |
| </table> |
| <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()">AbstractJettyMojo</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyJettyXml()">applyJettyXml</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkPackagingConfiguration()">checkPackagingConfiguration</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" 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"> </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="#configureMonitor()">configureMonitor</a></span>()</code></th> |
| <td class="colLast"> </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="#configurePluginClasspath()">configurePluginClasspath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract 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="i6" 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="i7" 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="i8" class="altColor"> |
| <td class="colFirst"><code>java.io.File</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findJettyWebXmlFile(java.io.File)">findJettyWebXmlFile</a></span>​(java.io.File webInfDir)</code></th> |
| <td class="colLast"> |
| <div class="block">Try and find a jetty-web.xml file, using some |
| historical naming conventions if necessary.</div> |
| </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="#finishConfigurationBeforeStart()">finishConfigurationBeforeStart</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.io.File></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJettyXmlFiles()">getJettyXmlFiles</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSkipMessage(java.lang.String)">getSkipMessage</a></span>​(java.lang.String reason)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConfigurationSupported()">isConfigurationSupported</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExcluded(java.lang.String)">isExcluded</a></span>​(java.lang.String goal)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPluginArtifact(org.apache.maven.artifact.Artifact)">isPluginArtifact</a></span>​(org.apache.maven.artifact.Artifact artifact)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isScanningEnabled()">isScanningEnabled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#printSystemProperties()">printSystemProperties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract 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="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSystemProperties(org.eclipse.jetty.maven.plugin.SystemProperties)">setSystemProperties</a></span>​(<a href="SystemProperties.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperties</a> systemProperties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSystemPropertiesFile(java.io.File)">setSystemPropertiesFile</a></span>​(java.io.File file)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startConsoleScanner()">startConsoleScanner</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Run a thread that monitors the console input to detect ENTER hits.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <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="i23" class="rowColor"> |
| <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"> </td> |
| </tr> |
| </table> |
| <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="useProvidedScope"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useProvidedScope</h4> |
| <pre>@Parameter(defaultValue="false") |
| protected boolean useProvidedScope</pre> |
| <div class="block">Whether or not to include dependencies on the plugin's classpath with <scope>provided</scope> |
| Use WITH CAUTION as you may wind up with duplicate jars/classes.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>jetty-7.5.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="excludedGoals"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>excludedGoals</h4> |
| <pre>@Parameter |
| protected java.lang.String[] excludedGoals</pre> |
| <div class="block">List of goals that are NOT to be used</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>jetty-7.5.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="contextHandlers"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contextHandlers</h4> |
| <pre>@Parameter |
| protected <a href="../../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a>[] contextHandlers</pre> |
| <div class="block">List of other contexts to set up. Consider using instead |
| the <jettyXml> element to specify external jetty xml config file. |
| Optional.</div> |
| </li> |
| </ul> |
| <a id="loginServices"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loginServices</h4> |
| <pre>@Parameter |
| protected <a href="../../security/LoginService.html" title="interface in org.eclipse.jetty.security">LoginService</a>[] loginServices</pre> |
| <div class="block">List of security realms to set up. Consider using instead |
| the <jettyXml> element to specify external jetty xml config file. |
| Optional.</div> |
| </li> |
| </ul> |
| <a id="requestLog"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestLog</h4> |
| <pre>@Parameter |
| protected <a href="../../server/RequestLog.html" title="interface in org.eclipse.jetty.server">RequestLog</a> requestLog</pre> |
| <div class="block">A RequestLog implementation to use for the webapp at runtime. |
| Consider using instead the <jettyXml> element to specify external jetty xml config file. |
| Optional.</div> |
| </li> |
| </ul> |
| <a id="webApp"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>webApp</h4> |
| <pre>@Parameter(alias="webAppConfig") |
| protected <a href="JettyWebAppContext.html" title="class in org.eclipse.jetty.maven.plugin">JettyWebAppContext</a> webApp</pre> |
| <div class="block">An instance of org.eclipse.jetty.webapp.WebAppContext that represents the webapp. |
| Use any of its setters to configure the webapp. This is the preferred and most |
| flexible method of configuration, rather than using the (deprecated) individual |
| parameters like "tmpDirectory", "contextPath" etc.</div> |
| </li> |
| </ul> |
| <a id="scanIntervalSeconds"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanIntervalSeconds</h4> |
| <pre>@Parameter(property="jetty.scanIntervalSeconds", |
| defaultValue="0", |
| required=true) |
| protected int scanIntervalSeconds</pre> |
| <div class="block">The interval in seconds to scan the webapp for changes |
| and restart the context if necessary. Ignored if reload |
| is enabled. Disabled by default.</div> |
| </li> |
| </ul> |
| <a id="reload"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reload</h4> |
| <pre>@Parameter(property="jetty.reload", |
| defaultValue="automatic") |
| protected java.lang.String reload</pre> |
| <div class="block">reload can be set to either 'automatic' or 'manual' |
| |
| if 'manual' then the context can be reloaded by a linefeed in the console |
| if 'automatic' then traditional reloading on changed files is enabled.</div> |
| </li> |
| </ul> |
| <a id="systemPropertiesFile"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>systemPropertiesFile</h4> |
| <pre>@Parameter(property="jetty.systemPropertiesFile") |
| protected java.io.File systemPropertiesFile</pre> |
| <div class="block">File containing system properties to be set before execution |
| |
| Note that these properties will NOT override System properties |
| that have been set on the command line, by the JVM, or directly |
| in the POM via systemProperties. Optional.</div> |
| </li> |
| </ul> |
| <a id="systemProperties"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>systemProperties</h4> |
| <pre>@Parameter |
| protected <a href="SystemProperties.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperties</a> systemProperties</pre> |
| <div class="block">System properties to set before execution. |
| Note that these properties will NOT override System properties |
| that have been set on the command line or by the JVM. They WILL |
| override System properties that have been set via systemPropertiesFile. |
| Optional.</div> |
| </li> |
| </ul> |
| <a id="jettyXml"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jettyXml</h4> |
| <pre>@Parameter(alias="jettyConfig") |
| protected java.lang.String jettyXml</pre> |
| <div class="block">Comma separated list of a jetty xml configuration files whose contents |
| will be applied before any plugin configuration. Optional.</div> |
| </li> |
| </ul> |
| <a id="stopPort"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopPort</h4> |
| <pre>@Parameter |
| protected int stopPort</pre> |
| <div class="block">Port to listen to stop jetty on executing -DSTOP.PORT=<stopPort> |
| -DSTOP.KEY=<stopKey> -jar start.jar --stop</div> |
| </li> |
| </ul> |
| <a id="stopKey"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopKey</h4> |
| <pre>@Parameter |
| protected java.lang.String stopKey</pre> |
| <div class="block">Key to provide when stopping jetty on executing java -DSTOP.KEY=<stopKey> |
| -DSTOP.PORT=<stopPort> -jar start.jar --stop</div> |
| </li> |
| </ul> |
| <a id="dumpOnStart"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dumpOnStart</h4> |
| <pre>@Parameter(property="dumponStart", |
| defaultValue="false") |
| protected boolean dumpOnStart</pre> |
| <div class="block">Use the dump() facility of jetty to print out the server configuration to logging</div> |
| </li> |
| </ul> |
| <a id="skip"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skip</h4> |
| <pre>@Parameter(property="jetty.skip", |
| defaultValue="false") |
| protected boolean skip</pre> |
| <div class="block">Skip this mojo execution.</div> |
| </li> |
| </ul> |
| <a id="contextXml"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contextXml</h4> |
| <pre>@Parameter(alias="webAppXml") |
| protected java.lang.String contextXml</pre> |
| <div class="block">Location of a context xml configuration file whose contents |
| will be applied to the webapp AFTER anything in <webApp>.Optional.</div> |
| </li> |
| </ul> |
| <a id="project"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre>@Parameter(defaultValue="${project}", |
| readonly=true) |
| protected org.apache.maven.project.MavenProject project</pre> |
| <div class="block">The maven project.</div> |
| </li> |
| </ul> |
| <a id="projectArtifacts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectArtifacts</h4> |
| <pre>@Parameter(defaultValue="${project.artifacts}", |
| readonly=true) |
| protected java.util.Set<org.apache.maven.artifact.Artifact> projectArtifacts</pre> |
| <div class="block">The artifacts for the project.</div> |
| </li> |
| </ul> |
| <a id="execution"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execution</h4> |
| <pre>@Parameter(defaultValue="${mojoExecution}", |
| readonly=true) |
| protected org.apache.maven.plugin.MojoExecution execution</pre> |
| </li> |
| </ul> |
| <a id="pluginArtifacts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pluginArtifacts</h4> |
| <pre>@Parameter(defaultValue="${plugin.artifacts}", |
| readonly=true) |
| protected java.util.List<org.apache.maven.artifact.Artifact> pluginArtifacts</pre> |
| <div class="block">The artifacts for the plugin itself.</div> |
| </li> |
| </ul> |
| <a id="httpConnector"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>httpConnector</h4> |
| <pre>@Parameter |
| protected <a href="MavenServerConnector.html" title="class in org.eclipse.jetty.maven.plugin">MavenServerConnector</a> httpConnector</pre> |
| <div class="block">A ServerConnector to use.</div> |
| </li> |
| </ul> |
| <a id="server"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>server</h4> |
| <pre>@Parameter |
| protected <a href="../../server/Server.html" title="class in org.eclipse.jetty.server">Server</a> server</pre> |
| <div class="block">A wrapper for the Server object</div> |
| </li> |
| </ul> |
| <a id="scanner"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanner</h4> |
| <pre>protected <a href="../../util/Scanner.html" title="class in org.eclipse.jetty.util">Scanner</a> scanner</pre> |
| <div class="block">A scanner to check for changes to the webapp</div> |
| </li> |
| </ul> |
| <a id="consoleScanner"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consoleScanner</h4> |
| <pre>protected java.lang.Thread consoleScanner</pre> |
| <div class="block">A scanner to check ENTER hits on the console</div> |
| </li> |
| </ul> |
| <a id="serverSupport"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serverSupport</h4> |
| <pre>protected <a href="ServerSupport.html" title="class in org.eclipse.jetty.maven.plugin">ServerSupport</a> serverSupport</pre> |
| </li> |
| </ul> |
| <a id="nonBlocking"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nonBlocking</h4> |
| <pre>@Parameter(defaultValue="false") |
| protected boolean nonBlocking</pre> |
| <div class="block"><p> |
| Determines whether or not the server blocks when started. The default |
| behavior (false) will cause the server to pause other processes |
| while it continues to handle web requests. This is useful when starting the |
| server with the intent to work with it interactively. This is the |
| behaviour of the jetty:run, jetty:run-war, jetty:run-war-exploded goals. |
| </p><p> |
| If true, the server will not block the execution of subsequent code. This |
| is the behaviour of the jetty:start and default behaviour of the jetty:deploy goals. |
| </p></div> |
| </li> |
| </ul> |
| <a id="supportedPackagings"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>supportedPackagings</h4> |
| <pre>@Parameter |
| protected java.util.List<java.lang.String> supportedPackagings</pre> |
| <div class="block">Per default this goal support only <code>war</code> packaging. |
| If your project use an other type please configure it here.</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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractJettyMojo</h4> |
| <pre>public AbstractJettyMojo()</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="restartWebApp(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartWebApp</h4> |
| <pre class="methodSignature">public abstract void restartWebApp​(boolean reconfigureScanner) |
| 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="checkPomConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPomConfiguration</h4> |
| <pre class="methodSignature">public boolean checkPomConfiguration() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configureScanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureScanner</h4> |
| <pre class="methodSignature">public abstract void configureScanner() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSkipMessage(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSkipMessage</h4> |
| <pre class="methodSignature">protected java.lang.String getSkipMessage​(java.lang.String reason)</pre> |
| </li> |
| </ul> |
| <a id="checkPackagingConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPackagingConfiguration</h4> |
| <pre class="methodSignature">public boolean checkPackagingConfiguration()</pre> |
| </li> |
| </ul> |
| <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="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="isConfigurationSupported()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConfigurationSupported</h4> |
| <pre class="methodSignature">public boolean isConfigurationSupported() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configurePluginClasspath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configurePluginClasspath</h4> |
| <pre class="methodSignature">public void configurePluginClasspath() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isPluginArtifact(org.apache.maven.artifact.Artifact)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPluginArtifact</h4> |
| <pre class="methodSignature">public boolean isPluginArtifact​(org.apache.maven.artifact.Artifact artifact)</pre> |
| </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="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="applyJettyXml()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyJettyXml</h4> |
| <pre class="methodSignature">public void applyJettyXml() |
| 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="startJetty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startJetty</h4> |
| <pre class="methodSignature">public void startJetty() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configureMonitor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureMonitor</h4> |
| <pre class="methodSignature">public void configureMonitor()</pre> |
| </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">Subclasses should invoke this to setup basic info |
| on the webapp</div> |
| <dl> |
| <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="startScanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startScanner</h4> |
| <pre class="methodSignature">public void startScanner() |
| throws java.lang.Exception</pre> |
| <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="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to start scanner</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isScanningEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isScanningEnabled</h4> |
| <pre class="methodSignature">public boolean isScanningEnabled()</pre> |
| </li> |
| </ul> |
| <a id="stopScanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopScanner</h4> |
| <pre class="methodSignature">public void stopScanner() |
| 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="startConsoleScanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startConsoleScanner</h4> |
| <pre class="methodSignature">protected void startConsoleScanner() |
| throws java.lang.Exception</pre> |
| <div class="block">Run a thread that monitors the console input to detect ENTER hits.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to start the console</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="printSystemProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>printSystemProperties</h4> |
| <pre class="methodSignature">protected void printSystemProperties()</pre> |
| </li> |
| </ul> |
| <a id="findJettyWebXmlFile(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findJettyWebXmlFile</h4> |
| <pre class="methodSignature">public java.io.File findJettyWebXmlFile​(java.io.File webInfDir)</pre> |
| <div class="block">Try and find a jetty-web.xml file, using some |
| historical naming conventions if necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>webInfDir</code> - the web inf directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the jetty web xml file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSystemPropertiesFile(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSystemPropertiesFile</h4> |
| <pre class="methodSignature">public void setSystemPropertiesFile​(java.io.File file) |
| 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="setSystemProperties(org.eclipse.jetty.maven.plugin.SystemProperties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSystemProperties</h4> |
| <pre class="methodSignature">public void setSystemProperties​(<a href="SystemProperties.html" title="class in org.eclipse.jetty.maven.plugin">SystemProperties</a> systemProperties)</pre> |
| </li> |
| </ul> |
| <a id="getJettyXmlFiles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJettyXmlFiles</h4> |
| <pre class="methodSignature">public java.util.List<java.io.File> getJettyXmlFiles()</pre> |
| </li> |
| </ul> |
| <a id="isExcluded(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isExcluded</h4> |
| <pre class="methodSignature">public boolean isExcluded​(java.lang.String goal)</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/AbstractJettyMojo.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–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |