blob: 6596c8479649e8d6ede902f70d1823b8b2e44761 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>org.eclipse.jetty.server.handler (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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.server.handler (Eclipse Jetty API Doc - v10.0.8)";
}
}
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.server.handler</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Server : Core Handler API</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="BufferedResponseHandler.BufferedInterceptor.html" title="interface in org.eclipse.jetty.server.handler">BufferedResponseHandler.BufferedInterceptor</a></th>
<td class="colLast">
<div class="block">An <a href="../HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server"><code>HttpOutput.Interceptor</code></a> which is created by <a href="BufferedResponseHandler.html#newBufferedInterceptor(org.eclipse.jetty.server.HttpChannel,org.eclipse.jetty.server.HttpOutput.Interceptor)"><code>BufferedResponseHandler.newBufferedInterceptor(HttpChannel, Interceptor)</code></a>
and is used by the implementation to buffer outgoing content.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContextHandler.AliasCheck.html" title="interface in org.eclipse.jetty.server.handler">ContextHandler.AliasCheck</a></th>
<td class="colLast">
<div class="block">Interface to check aliases</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContextHandler.ContextScopeListener.html" title="interface in org.eclipse.jetty.server.handler">ContextHandler.ContextScopeListener</a></th>
<td class="colLast">
<div class="block">Listener for all threads entering context scope, including async IO callbacks</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ErrorHandler.ErrorPageMapper.html" title="interface in org.eclipse.jetty.server.handler">ErrorHandler.ErrorPageMapper</a></th>
<td class="colLast">&nbsp;</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="AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></th>
<td class="colLast">
<div class="block">AbstractHandler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractHandler.ErrorDispatchHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler.ErrorDispatchHandler</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">This class is no longer required as ERROR dispatch is only done if there is an error page target.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">AbstractHandlerContainer</a></th>
<td class="colLast">
<div class="block">Abstract Handler Container.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AllowSymLinkAliasChecker.html" title="class in org.eclipse.jetty.server.handler">AllowSymLinkAliasChecker</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">use <a href="../SymlinkAllowedResourceAliasChecker.html" title="class in org.eclipse.jetty.server"><code>SymlinkAllowedResourceAliasChecker</code></a> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AsyncDelayHandler.html" title="class in org.eclipse.jetty.server.handler">AsyncDelayHandler</a></th>
<td class="colLast">
<div class="block">A handler wrapper that provides the framework to asynchronously
delay the handling of a request.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BufferedResponseHandler.html" title="class in org.eclipse.jetty.server.handler">BufferedResponseHandler</a></th>
<td class="colLast">
<div class="block">
A Handler that can apply a <a href="../HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server"><code>HttpOutput.Interceptor</code></a>
mechanism to buffer the entire response content until the output is closed.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a></th>
<td class="colLast">
<div class="block">ContextHandler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContextHandler.ApproveAliases.html" title="class in org.eclipse.jetty.server.handler">ContextHandler.ApproveAliases</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">use <a href="../AllowedResourceAliasChecker.html" title="class in org.eclipse.jetty.server"><code>AllowedResourceAliasChecker</code></a> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContextHandler.ApproveNonExistentDirectoryAliases.html" title="class in org.eclipse.jetty.server.handler">ContextHandler.ApproveNonExistentDirectoryAliases</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContextHandler.StaticContext.html" title="class in org.eclipse.jetty.server.handler">ContextHandler.StaticContext</a></th>
<td class="colLast">
<div class="block">A simple implementation of ServletContext that is used when there is no
ContextHandler.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContextHandlerCollection.html" title="class in org.eclipse.jetty.server.handler">ContextHandlerCollection</a></th>
<td class="colLast">
<div class="block">This <a href="HandlerCollection.html" title="class in org.eclipse.jetty.server.handler"><code>HandlerCollection</code></a> is creates a
Map of contexts to it's contained handlers based
on the context path and virtual hosts of any contained <a href="ContextHandler.html" title="class in org.eclipse.jetty.server.handler"><code>ContextHandler</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DebugHandler.html" title="class in org.eclipse.jetty.server.handler">DebugHandler</a></th>
<td class="colLast">
<div class="block">Debug Handler.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultHandler.html" title="class in org.eclipse.jetty.server.handler">DefaultHandler</a></th>
<td class="colLast">
<div class="block">Default Handler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ErrorHandler.html" title="class in org.eclipse.jetty.server.handler">ErrorHandler</a></th>
<td class="colLast">
<div class="block">Handler for Error pages
An ErrorHandler is registered with <a href="ContextHandler.html#setErrorHandler(org.eclipse.jetty.server.handler.ErrorHandler)"><code>ContextHandler.setErrorHandler(ErrorHandler)</code></a> or
<a href="../Server.html#setErrorHandler(org.eclipse.jetty.server.handler.ErrorHandler)"><code>Server.setErrorHandler(ErrorHandler)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileBufferedResponseHandler.html" title="class in org.eclipse.jetty.server.handler">FileBufferedResponseHandler</a></th>
<td class="colLast">
<div class="block">
A Handler that can apply a <a href="../HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server"><code>HttpOutput.Interceptor</code></a>
mechanism to buffer the entire response content until the output is closed.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HandlerCollection.html" title="class in org.eclipse.jetty.server.handler">HandlerCollection</a></th>
<td class="colLast">
<div class="block">A collection of handlers.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HandlerCollection.Handlers.html" title="class in org.eclipse.jetty.server.handler">HandlerCollection.Handlers</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HandlerList.html" title="class in org.eclipse.jetty.server.handler">HandlerList</a></th>
<td class="colLast">
<div class="block">HandlerList.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></th>
<td class="colLast">
<div class="block">A <code>HandlerWrapper</code> acts as a <a href="../Handler.html" title="interface in org.eclipse.jetty.server"><code>Handler</code></a> but delegates the <a href="../Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"><code>handle</code></a> method and
<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component"><code>life cycle</code></a> events to a delegate.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HotSwapHandler.html" title="class in org.eclipse.jetty.server.handler">HotSwapHandler</a></th>
<td class="colLast">
<div class="block">A <code>HandlerContainer</code> that allows a hot swap of a wrapped handler.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IdleTimeoutHandler.html" title="class in org.eclipse.jetty.server.handler">IdleTimeoutHandler</a></th>
<td class="colLast">
<div class="block">Handler to adjust the idle timeout of requests while dispatched.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="InetAccessHandler.html" title="class in org.eclipse.jetty.server.handler">InetAccessHandler</a></th>
<td class="colLast">
<div class="block">InetAddress Access Handler</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InetAccessSet.html" title="class in org.eclipse.jetty.server.handler">InetAccessSet</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ManagedAttributeListener.html" title="class in org.eclipse.jetty.server.handler">ManagedAttributeListener</a></th>
<td class="colLast">
<div class="block">Enable Jetty style JMX MBeans from within a Context</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MovedContextHandler.html" title="class in org.eclipse.jetty.server.handler">MovedContextHandler</a></th>
<td class="colLast">
<div class="block">Moved ContextHandler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RequestLogHandler.html" title="class in org.eclipse.jetty.server.handler">RequestLogHandler</a></th>
<td class="colLast">
<div class="block">This handler provides an alternate way (other than <a href="../Server.html#setRequestLog(org.eclipse.jetty.server.RequestLog)"><code>Server.setRequestLog(RequestLog)</code></a>)
to log request, that can be applied to a particular handler (eg context).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ResourceHandler.html" title="class in org.eclipse.jetty.server.handler">ResourceHandler</a></th>
<td class="colLast">
<div class="block">Resource Handler.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></th>
<td class="colLast">
<div class="block">ScopedHandler.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SecuredRedirectHandler.html" title="class in org.eclipse.jetty.server.handler">SecuredRedirectHandler</a></th>
<td class="colLast">
<div class="block">SecuredRedirectHandler redirects from <code>http</code> to <code>https</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ShutdownHandler.html" title="class in org.eclipse.jetty.server.handler">ShutdownHandler</a></th>
<td class="colLast">
<div class="block">A handler that shuts the server down on a valid request.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StatisticsHandler.html" title="class in org.eclipse.jetty.server.handler">StatisticsHandler</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ThreadLimitHandler.html" title="class in org.eclipse.jetty.server.handler">ThreadLimitHandler</a></th>
<td class="colLast">
<div class="block">Handler to limit the threads per IP address for DOS protection</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="ContextHandler.Availability.html" title="enum in org.eclipse.jetty.server.handler">ContextHandler.Availability</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContextHandler.ContextStatus.html" title="enum in org.eclipse.jetty.server.handler">ContextHandler.ContextStatus</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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>