blob: 6d4c9a0a2f5cc5bbb5549eced41b6b608bd7a987 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:44:01 EDT 2021 -->
<title>org.eclipse.jetty.webapp (Eclipse Jetty API Doc - v11.0.5)</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="org.eclipse.jetty.webapp (Eclipse Jetty API Doc - v11.0.5)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.jetty.webapp</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Util : Modular Web Application Support</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a></th>
<td class="colLast">
<div class="block">A pluggable Configuration for <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Configuration.WrapperFunction.html" title="interface in org.eclipse.jetty.webapp">Configuration.WrapperFunction</a></th>
<td class="colLast">
<div class="block">Experimental Wrapper mechanism for WebApp Configuration components.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DescriptorProcessor.html" title="interface in org.eclipse.jetty.webapp">DescriptorProcessor</a></th>
<td class="colLast">
<div class="block">DescriptorProcessor</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Ordering.html" title="interface in org.eclipse.jetty.webapp">Ordering</a></th>
<td class="colLast">
<div class="block">Ordering options for jars in WEB-INF lib.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WebAppClassLoader.Context.html" title="interface in org.eclipse.jetty.webapp">WebAppClassLoader.Context</a></th>
<td class="colLast">
<div class="block">The Context in which the classloader operates.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbsoluteOrdering.html" title="class in org.eclipse.jetty.webapp">AbsoluteOrdering</a></th>
<td class="colLast">
<div class="block">AbsoluteOrdering</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CachingWebAppClassLoader.html" title="class in org.eclipse.jetty.webapp">CachingWebAppClassLoader</a></th>
<td class="colLast">
<div class="block">A WebAppClassLoader that caches <a href="CachingWebAppClassLoader.html#getResource(java.lang.String)"><code>CachingWebAppClassLoader.getResource(String)</code></a> results.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.html" title="class in org.eclipse.jetty.webapp">ClassMatcher</a></th>
<td class="colLast">
<div class="block">A matcher for classes based on package and/or location and/or module/</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByClass.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByClass</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByLocation.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByLocation</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByLocationOrModule.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByLocationOrModule</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByModule.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByModule</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByPackage.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByPackage</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.ByPackageOrName.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.ByPackageOrName</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClassMatcher.Entry.html" title="class in org.eclipse.jetty.webapp">ClassMatcher.Entry</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Configuration.Wrapper.html" title="class in org.eclipse.jetty.webapp">Configuration.Wrapper</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Configurations.html" title="class in org.eclipse.jetty.webapp">Configurations</a></th>
<td class="colLast">
<div class="block">An ordered list of <a href="Configuration.html" title="interface in org.eclipse.jetty.webapp"><code>Configuration</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DecoratingListener.html" title="class in org.eclipse.jetty.webapp">DecoratingListener</a></th>
<td class="colLast">
<div class="block">An extended org.eclipse.jetty.servlet.DecoratingListener.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultsDescriptor.html" title="class in org.eclipse.jetty.webapp">DefaultsDescriptor</a></th>
<td class="colLast">
<div class="block">DefaultsDescriptor</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Descriptor.html" title="class in org.eclipse.jetty.webapp">Descriptor</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DiscoveredAnnotation.html" title="class in org.eclipse.jetty.webapp">DiscoveredAnnotation</a></th>
<td class="colLast">
<div class="block">DiscoveredAnnotation
Represents an annotation that has been discovered
by scanning source code of WEB-INF/classes and WEB-INF/lib jars.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FragmentConfiguration.html" title="class in org.eclipse.jetty.webapp">FragmentConfiguration</a></th>
<td class="colLast">
<div class="block">FragmentConfiguration</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FragmentDescriptor.html" title="class in org.eclipse.jetty.webapp">FragmentDescriptor</a></th>
<td class="colLast">
<div class="block">Fragment
A web-fragment.xml descriptor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IterativeDescriptorProcessor.html" title="class in org.eclipse.jetty.webapp">IterativeDescriptorProcessor</a></th>
<td class="colLast">
<div class="block">IterativeDescriptorProcessor</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JaasConfiguration.html" title="class in org.eclipse.jetty.webapp">JaasConfiguration</a></th>
<td class="colLast">
<div class="block">JAAS Configuration</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JettyWebXmlConfiguration.html" title="class in org.eclipse.jetty.webapp">JettyWebXmlConfiguration</a></th>
<td class="colLast">
<div class="block">JettyWebConfiguration.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JmxConfiguration.html" title="class in org.eclipse.jetty.webapp">JmxConfiguration</a></th>
<td class="colLast">
<div class="block">JMX Configuration</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JndiConfiguration.html" title="class in org.eclipse.jetty.webapp">JndiConfiguration</a></th>
<td class="colLast">
<div class="block">JNDI Configuration</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JspConfiguration.html" title="class in org.eclipse.jetty.webapp">JspConfiguration</a></th>
<td class="colLast">
<div class="block">JSP Configuration</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetaData.html" title="class in org.eclipse.jetty.webapp">MetaData</a></th>
<td class="colLast">
<div class="block">MetaData
All data associated with the configuration and deployment of a web application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetaData.OriginInfo.html" title="class in org.eclipse.jetty.webapp">MetaData.OriginInfo</a></th>
<td class="colLast">
<div class="block">Metadata regarding where a deployable element was declared:
by annotation or by descriptor.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetaInfConfiguration.html" title="class in org.eclipse.jetty.webapp">MetaInfConfiguration</a></th>
<td class="colLast">
<div class="block">MetaInfConfiguration</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OverrideDescriptor.html" title="class in org.eclipse.jetty.webapp">OverrideDescriptor</a></th>
<td class="colLast">
<div class="block">OverrideDescriptor</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RelativeOrdering.html" title="class in org.eclipse.jetty.webapp">RelativeOrdering</a></th>
<td class="colLast">
<div class="block">Relative Fragment Ordering</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ServletsConfiguration.html" title="class in org.eclipse.jetty.webapp">ServletsConfiguration</a></th>
<td class="colLast">
<div class="block">Jetty Servlets Configuration</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="StandardDescriptorProcessor.html" title="class in org.eclipse.jetty.webapp">StandardDescriptorProcessor</a></th>
<td class="colLast">
<div class="block">StandardDescriptorProcessor.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WebAppClassLoader.html" title="class in org.eclipse.jetty.webapp">WebAppClassLoader</a></th>
<td class="colLast">
<div class="block">ClassLoader for HttpContext.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WebAppConfiguration.html" title="class in org.eclipse.jetty.webapp">WebAppConfiguration</a></th>
<td class="colLast">
<div class="block">WebApp Configuration</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a></th>
<td class="colLast">
<div class="block">Web Application Context Handler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WebDescriptor.html" title="class in org.eclipse.jetty.webapp">WebDescriptor</a></th>
<td class="colLast">
<div class="block">Descriptor
A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WebInfConfiguration.html" title="class in org.eclipse.jetty.webapp">WebInfConfiguration</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WebXmlConfiguration.html" title="class in org.eclipse.jetty.webapp">WebXmlConfiguration</a></th>
<td class="colLast">
<div class="block">Configure by parsing default web.xml and web.xml</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FragmentDescriptor.OtherType.html" title="enum in org.eclipse.jetty.webapp">FragmentDescriptor.OtherType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetaData.Complete.html" title="enum in org.eclipse.jetty.webapp">MetaData.Complete</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Origin.html" title="enum in org.eclipse.jetty.webapp">Origin</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>