blob: 1b8f258cc6ca1c215cd576b89bee93f56392a40f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 -->
<title>MavenQuickStartConfiguration (Eclipse Jetty API Doc - v11.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: MavenQuickStartConfiguration">
<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/MavenQuickStartConfiguration.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.maven.plugin</a></div>
<h1 title="Class MavenQuickStartConfiguration" class="title">Class MavenQuickStartConfiguration</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"><a href="../../webapp/AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">org.eclipse.jetty.webapp.AbstractConfiguration</a>
<div class="inheritance"><a href="../../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">org.eclipse.jetty.quickstart.QuickStartConfiguration</a>
<div class="inheritance">org.eclipse.jetty.maven.plugin.MavenQuickStartConfiguration</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MavenQuickStartConfiguration</span>
<span class="extends-implements">extends <a href="../../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartConfiguration</a></span></div>
<div class="block">MavenQuickStartConfiguration</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.quickstart.QuickStartConfiguration">Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.quickstart.<a href="../../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartConfiguration</a></h2>
<code><a href="../../quickstart/QuickStartConfiguration.Mode.html" title="enum in org.eclipse.jetty.quickstart">QuickStartConfiguration.Mode</a></code></div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.webapp.Configuration">Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h2>
<code><a href="../../webapp/Configuration.Wrapper.html" title="class in org.eclipse.jetty.webapp">Configuration.Wrapper</a>, <a href="../../webapp/Configuration.WrapperFunction.html" title="interface in org.eclipse.jetty.webapp">Configuration.WrapperFunction</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.eclipse.jetty.quickstart.QuickStartConfiguration">Fields inherited from class&nbsp;org.eclipse.jetty.quickstart.<a href="../../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartConfiguration</a></h3>
<code><a href="../../quickstart/QuickStartConfiguration.html#__replacedConfigurations">__replacedConfigurations</a>, <a href="../../quickstart/QuickStartConfiguration.html#MODE">MODE</a>, <a href="../../quickstart/QuickStartConfiguration.html#ORIGIN_ATTRIBUTE">ORIGIN_ATTRIBUTE</a>, <a href="../../quickstart/QuickStartConfiguration.html#QUICKSTART_WEB_XML">QUICKSTART_WEB_XML</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.eclipse.jetty.webapp.Configuration">Fields inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h3>
<code><a href="../../webapp/Configuration.html#ATTR">ATTR</a></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">MavenQuickStartConfiguration</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deconfigure(org.eclipse.jetty.webapp.WebAppContext)" class="member-name-link">deconfigure</a><wbr>(<a href="../../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">DeConfigure WebApp.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replaces()" class="member-name-link">replaces</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get a class that this class replaces/extends.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.quickstart.QuickStartConfiguration">Methods inherited from class&nbsp;org.eclipse.jetty.quickstart.<a href="../../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartConfiguration</a></h3>
<code><a href="../../quickstart/QuickStartConfiguration.html#configure(org.eclipse.jetty.quickstart.QuickStartGeneratorConfiguration,org.eclipse.jetty.webapp.WebAppContext)">configure</a>, <a href="../../quickstart/QuickStartConfiguration.html#configure(org.eclipse.jetty.webapp.WebAppContext)">configure</a>, <a href="../../quickstart/QuickStartConfiguration.html#configureMode(org.eclipse.jetty.server.Server,java.lang.String)">configureMode</a>, <a href="../../quickstart/QuickStartConfiguration.html#getQuickStartWebXml(org.eclipse.jetty.webapp.WebAppContext)">getQuickStartWebXml</a>, <a href="../../quickstart/QuickStartConfiguration.html#postConfigure(org.eclipse.jetty.webapp.WebAppContext)">postConfigure</a>, <a href="../../quickstart/QuickStartConfiguration.html#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">preConfigure</a>, <a href="../../quickstart/QuickStartConfiguration.html#quickStart(org.eclipse.jetty.webapp.WebAppContext)">quickStart</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.webapp.AbstractConfiguration">Methods inherited from class&nbsp;org.eclipse.jetty.webapp.<a href="../../webapp/AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></h3>
<code><a href="../../webapp/AbstractConfiguration.html#abort(org.eclipse.jetty.webapp.WebAppContext)">abort</a>, <a href="../../webapp/AbstractConfiguration.html#addDependencies(java.lang.Class...)">addDependencies</a>, <a href="../../webapp/AbstractConfiguration.html#addDependencies(java.lang.String...)">addDependencies</a>, <a href="../../webapp/AbstractConfiguration.html#addDependents(java.lang.Class...)">addDependents</a>, <a href="../../webapp/AbstractConfiguration.html#addDependents(java.lang.String...)">addDependents</a>, <a href="../../webapp/AbstractConfiguration.html#cloneConfigure(org.eclipse.jetty.webapp.WebAppContext,org.eclipse.jetty.webapp.WebAppContext)">cloneConfigure</a>, <a href="../../webapp/AbstractConfiguration.html#destroy(org.eclipse.jetty.webapp.WebAppContext)">destroy</a>, <a href="../../webapp/AbstractConfiguration.html#expose(java.lang.String...)">expose</a>, <a href="../../webapp/AbstractConfiguration.html#getDependencies()">getDependencies</a>, <a href="../../webapp/AbstractConfiguration.html#getDependents()">getDependents</a>, <a href="../../webapp/AbstractConfiguration.html#getServerClasses()">getServerClasses</a>, <a href="../../webapp/AbstractConfiguration.html#getSystemClasses()">getSystemClasses</a>, <a href="../../webapp/AbstractConfiguration.html#hide(java.lang.String...)">hide</a>, <a href="../../webapp/AbstractConfiguration.html#isEnabledByDefault()">isEnabledByDefault</a>, <a href="../../webapp/AbstractConfiguration.html#protect(java.lang.String...)">protect</a>, <a href="../../webapp/AbstractConfiguration.html#protectAndExpose(java.lang.String...)">protectAndExpose</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.webapp.Configuration">Methods inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h3>
<code><a href="../../webapp/Configuration.html#isAvailable()">isAvailable</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>MavenQuickStartConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MavenQuickStartConfiguration</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="replaces()">
<h3>replaces</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a>&gt;</span>&nbsp;<span class="element-name">replaces</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../webapp/Configuration.html#replaces()">Configuration</a></code></span></div>
<div class="block">Get a class that this class replaces/extends.
If this is added to <a href="../../webapp/Configurations.html" title="class in org.eclipse.jetty.webapp"><code>Configurations</code></a> collection that already contains a
configuration of the replaced class or that reports to replace the same class, then
it is replaced with this instance.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The class this Configuration replaces/extends or null if it replaces no other configuration</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deconfigure(org.eclipse.jetty.webapp.WebAppContext)">
<h3>deconfigure</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">deconfigure</span><wbr><span class="parameters">(<a href="../../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../webapp/Configuration.html#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">Configuration</a></code></span></div>
<div class="block">DeConfigure WebApp.
This method is called to undo all configuration done. This is
called to allow the context to work correctly over a stop/start cycle</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../webapp/Configuration.html#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></code>&nbsp;in interface&nbsp;<code><a href="../../webapp/Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../../webapp/AbstractConfiguration.html#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></code>&nbsp;in class&nbsp;<code><a href="../../webapp/AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - The context to configure</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> - if unable to deconfigure</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>