Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 11.0.0 / org / eclipse / jetty / webapp / WebInfConfiguration.html
blob: 0d4eefff63548e5d749b495e0284677a85198007 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Mon Dec 07 10:59:53 CST 2020 -->
<title>WebInfConfiguration (Eclipse Jetty API Doc - v11.0.0)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-12-07">
<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="WebInfConfiguration (Eclipse Jetty API Doc - v11.0.0)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
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/WebInfConfiguration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.webapp</a></div>
<h2 title="Class WebInfConfiguration" class="title">Class WebInfConfiguration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">org.eclipse.jetty.webapp.AbstractConfiguration</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.webapp.WebInfConfiguration</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../ant/AntWebInfConfiguration.html" title="class in org.eclipse.jetty.ant">AntWebInfConfiguration</a></code>, <code><a href="../maven/plugin/MavenWebInfConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenWebInfConfiguration</a></code>, <code><a href="../osgi/boot/OSGiWebInfConfiguration.html" title="class in org.eclipse.jetty.osgi.boot">OSGiWebInfConfiguration</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebInfConfiguration</span>
extends <a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.webapp.Configuration">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h3>
<code><a href="Configuration.Wrapper.html" title="class in org.eclipse.jetty.webapp">Configuration.Wrapper</a>, <a href="Configuration.WrapperFunction.html" title="interface in org.eclipse.jetty.webapp">Configuration.WrapperFunction</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== 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">&nbsp;</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 <a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_preUnpackBaseResource">_preUnpackBaseResource</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TEMPDIR_CONFIGURED">TEMPDIR_CONFIGURED</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TEMPORARY_RESOURCE_BASE">TEMPORARY_RESOURCE_BASE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.webapp.Configuration">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h3>
<code><a href="Configuration.html#ATTR">ATTR</a></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">&nbsp;</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()">WebInfConfiguration</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="#cloneConfigure(org.eclipse.jetty.webapp.WebAppContext,org.eclipse.jetty.webapp.WebAppContext)">cloneConfigure</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;template,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.eclipse.jetty.webapp.WebAppContext)">configure</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Configure WebApp.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureTempDirectory(java.io.File,org.eclipse.jetty.webapp.WebAppContext)">configureTempDirectory</a></span>&#8203;(java.io.File&nbsp;dir,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</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="#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">DeConfigure WebApp.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCanonicalNameForWebAppTmpDir(org.eclipse.jetty.webapp.WebAppContext)">getCanonicalNameForWebAppTmpDir</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Create a canonical name for a webapp temp directory.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceBaseName(org.eclipse.jetty.util.resource.Resource)">getResourceBaseName</a></span>&#8203;(<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;resource)</code></th>
<td class="colLast">&nbsp;</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="#makeTempDirectory(java.io.File,org.eclipse.jetty.webapp.WebAppContext)">makeTempDirectory</a></span>&#8203;(java.io.File&nbsp;parent,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</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="#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">preConfigure</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Set up for configuration.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveTempDirectory(org.eclipse.jetty.webapp.WebAppContext)">resolveTempDirectory</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Get a temporary directory in which to unpack the war etc etc.</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="#unpack(org.eclipse.jetty.webapp.WebAppContext)">unpack</a></span>&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.webapp.AbstractConfiguration">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.webapp.<a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></h3>
<code><a href="AbstractConfiguration.html#abort(org.eclipse.jetty.webapp.WebAppContext)">abort</a>, <a href="AbstractConfiguration.html#addDependencies(java.lang.Class...)">addDependencies</a>, <a href="AbstractConfiguration.html#addDependencies(java.lang.String...)">addDependencies</a>, <a href="AbstractConfiguration.html#addDependents(java.lang.Class...)">addDependents</a>, <a href="AbstractConfiguration.html#addDependents(java.lang.String...)">addDependents</a>, <a href="AbstractConfiguration.html#destroy(org.eclipse.jetty.webapp.WebAppContext)">destroy</a>, <a href="AbstractConfiguration.html#expose(java.lang.String...)">expose</a>, <a href="AbstractConfiguration.html#getDependencies()">getDependencies</a>, <a href="AbstractConfiguration.html#getDependents()">getDependents</a>, <a href="AbstractConfiguration.html#getServerClasses()">getServerClasses</a>, <a href="AbstractConfiguration.html#getSystemClasses()">getSystemClasses</a>, <a href="AbstractConfiguration.html#hide(java.lang.String...)">hide</a>, <a href="AbstractConfiguration.html#isEnabledByDefault()">isEnabledByDefault</a>, <a href="AbstractConfiguration.html#postConfigure(org.eclipse.jetty.webapp.WebAppContext)">postConfigure</a>, <a href="AbstractConfiguration.html#protect(java.lang.String...)">protect</a>, <a href="AbstractConfiguration.html#protectAndExpose(java.lang.String...)">protectAndExpose</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.webapp.Configuration">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.webapp.<a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></h3>
<code><a href="Configuration.html#isAvailable()">isAvailable</a>, <a href="Configuration.html#replaces()">replaces</a></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="TEMPDIR_CONFIGURED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEMPDIR_CONFIGURED</h4>
<pre>public static final&nbsp;java.lang.String TEMPDIR_CONFIGURED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.webapp.WebInfConfiguration.TEMPDIR_CONFIGURED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="TEMPORARY_RESOURCE_BASE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEMPORARY_RESOURCE_BASE</h4>
<pre>public static final&nbsp;java.lang.String TEMPORARY_RESOURCE_BASE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.webapp.WebInfConfiguration.TEMPORARY_RESOURCE_BASE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="_preUnpackBaseResource">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_preUnpackBaseResource</h4>
<pre>protected&nbsp;<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> _preUnpackBaseResource</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebInfConfiguration</h4>
<pre>public&nbsp;WebInfConfiguration()</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="preConfigure(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preConfigure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;preConfigure&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Configuration.html#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">Configuration</a></code></span></div>
<div class="block">Set up for configuration.
<p>
Typically this step discovers configuration resources.
Calls to preConfigure may alter the Configurations configured on the
WebAppContext, so long as configurations prior to this configuration
are not altered.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Configuration.html#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">preConfigure</a></code>&nbsp;in interface&nbsp;<code><a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractConfiguration.html#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">preConfigure</a></code>&nbsp;in class&nbsp;<code><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The context to configure</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to pre configure</dd>
</dl>
</li>
</ul>
<a id="configure(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configure&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Configuration.html#configure(org.eclipse.jetty.webapp.WebAppContext)">Configuration</a></code></span></div>
<div class="block">Configure WebApp.
<p>
Typically this step applies the discovered configuration resources to
either the <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a> or the associated <a href="MetaData.html" title="class in org.eclipse.jetty.webapp"><code>MetaData</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Configuration.html#configure(org.eclipse.jetty.webapp.WebAppContext)">configure</a></code>&nbsp;in interface&nbsp;<code><a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractConfiguration.html#configure(org.eclipse.jetty.webapp.WebAppContext)">configure</a></code>&nbsp;in class&nbsp;<code><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The context to configure</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to configure</dd>
</dl>
</li>
</ul>
<a id="deconfigure(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deconfigure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deconfigure&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Configuration.html#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></code>&nbsp;in interface&nbsp;<code><a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractConfiguration.html#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></code>&nbsp;in class&nbsp;<code><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - The context to configure</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to deconfigure</dd>
</dl>
</li>
</ul>
<a id="cloneConfigure(org.eclipse.jetty.webapp.WebAppContext,org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneConfigure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cloneConfigure&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;template,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractConfiguration.html#cloneConfigure(org.eclipse.jetty.webapp.WebAppContext,org.eclipse.jetty.webapp.WebAppContext)">cloneConfigure</a></code>&nbsp;in class&nbsp;<code><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="resolveTempDirectory(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveTempDirectory</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;resolveTempDirectory&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.lang.Exception</pre>
<div class="block">Get a temporary directory in which to unpack the war etc etc.
The algorithm for determining this is to check these alternatives
in the order shown:
<p>
A. Try to use an explicit directory specifically for this webapp:
<ol>
<li>
Iff an explicit directory is set for this webapp, use it. Set delete on
exit depends on value of persistTempDirectory.
</li>
<li>
Iff jakarta.servlet.context.tempdir context attribute is set for
this webapp &amp;&amp; exists &amp;&amp; writeable, then use it. Set delete on exit depends on
value of persistTempDirectory.
</li>
</ol>
<p>
B. Create a directory based on global settings. The new directory
will be called <code>"Jetty-"+host+"-"+port+"__"+context+"-"+virtualhost+"-"+randomdigits+".dir"</code>
<p>
If the user has specified the context attribute org.eclipse.jetty.webapp.basetempdir, the
directory specified by this attribute will be the parent of the temp dir created. Otherwise,
the parent dir is <code>${java.io.tmpdir}</code>. Set delete on exit depends on value of persistTempDirectory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the context to resolve the temp directory from</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if unable to resolve the temp directory</dd>
</dl>
</li>
</ul>
<a id="makeTempDirectory(java.io.File,org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeTempDirectory</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;makeTempDirectory&#8203;(java.io.File&nbsp;parent,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
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="configureTempDirectory(java.io.File,org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureTempDirectory</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;configureTempDirectory&#8203;(java.io.File&nbsp;dir,
<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</pre>
</li>
</ul>
<a id="unpack(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unpack</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unpack&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="getCanonicalNameForWebAppTmpDir(org.eclipse.jetty.webapp.WebAppContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCanonicalNameForWebAppTmpDir</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getCanonicalNameForWebAppTmpDir&#8203;(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a>&nbsp;context)</pre>
<div class="block">Create a canonical name for a webapp temp directory.
<p>
The form of the name is:
<pre>"jetty-"+host+"-"+port+"-"+resourceBase+"-_"+context+"-"+virtualhost+"-"+randomdigits+".dir"</pre>
host and port uniquely identify the server
context and virtual host uniquely identify the webapp
randomdigits ensure every tmp directory is unique</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the context to get the canonical name from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the canonical name for the webapp temp directory</dd>
</dl>
</li>
</ul>
<a id="getResourceBaseName(org.eclipse.jetty.util.resource.Resource)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResourceBaseName</h4>
<pre class="methodSignature">protected static&nbsp;java.lang.String&nbsp;getResourceBaseName&#8203;(<a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>&nbsp;resource)</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/WebInfConfiguration.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>