| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.6) on Fri May 22 12:37:48 EDT 2020 --> |
| <title>GzipHandler (Jetty :: Project 9.4.29.v20200521 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-05-22"> |
| <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.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.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="GzipHandler (Jetty :: Project 9.4.29.v20200521 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":42,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":42,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/GzipHandler.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><a href="#nested.class.summary">Nested</a> | </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.server.handler.gzip</a></div> |
| <h2 title="Class GzipHandler" class="title">Class GzipHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandler</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandlerContainer</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.HandlerWrapper</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.server.handler.gzip.GzipHandler</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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="../../Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code>, <code><a href="GzipFactory.html" title="interface in org.eclipse.jetty.server.handler.gzip">GzipFactory</a></code>, <code><a href="../../HandlerContainer.html" title="interface in org.eclipse.jetty.server">HandlerContainer</a></code>, <code><a href="../../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">GzipHandler</span> |
| extends <a href="../HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a> |
| implements <a href="GzipFactory.html" title="interface in org.eclipse.jetty.server.handler.gzip">GzipFactory</a></pre> |
| <div class="block">A Handler that can dynamically GZIP uncompress requests, and compress responses. |
| <p> |
| The GzipHandler can be applied to the entire server (a <code>gzip.mod</code> is included in |
| the <code>jetty-home</code>) or it may be applied to individual contexts. |
| </p> |
| <p> |
| Both Request uncompress and Response compress are gated by a configurable |
| <code>DispatcherType</code> check on the GzipHandler. |
| (This is similar in behavior to a <code>Filter</code> configuration |
| you would find in a Servlet Descriptor file (<code>WEB-INF/web.xml</code>) |
| <br>(Default: <code>DispatcherType.REQUEST</code>). |
| </p> |
| <p> |
| Requests with a <code>Content-Encoding</code> header with the value <code>gzip</code> will |
| be uncompressed by a <a href="GzipHttpInputInterceptor.html" title="class in org.eclipse.jetty.server.handler.gzip"><code>GzipHttpInputInterceptor</code></a> for any API that uses |
| <code>ServletRequest.getInputStream()</code> or <code>ServletRequest.getReader()</code>. |
| </p> |
| <p> |
| Response compression has a number of checks before GzipHandler will perform compression. |
| </p> |
| <ol> |
| <li> |
| Does the request contain a <code>Accept-Encoding</code> header that specifies |
| <code>gzip</code> value? |
| </li> |
| <li> |
| Is the <code>HttpServletRequest.getMethod()</code> allowed by the configured HTTP Method Filter. |
| <br> (Default: <code>GET</code>) |
| </li> |
| <li> |
| Is the incoming Path allowed by the configured Path Specs filters? |
| <br> (Default: all paths are allowed) |
| </li> |
| <li> |
| Is the Request User-Agent allowed by the configured User-Agent filters? |
| <br> (Default: MSIE 6 is excluded) |
| </li> |
| <li> |
| Is the Response <code>Content-Length</code> header present, and does its |
| value meet the minimum gzip size requirements (default 32 bytes)? |
| </li> |
| <li> |
| Is the Request <code>Accept</code> header present and does it contain the |
| required <code>gzip</code> value? |
| </li> |
| </ol> |
| <p> |
| When you encounter a configurable filter in the GzipHandler (method, paths, user-agent, |
| mime-types, etc) that has both Included and Excluded values, note that the Included |
| values always win over the Excluded values. |
| </p> |
| <p> |
| <em>Important note about Default Values</em>: |
| It is important to note that the GzipHandler will automatically configure itself from the |
| MimeType present on the Server, System, and Contexts and the ultimate set of default values |
| for the various filters (paths, methods, mime-types, etc) can be influenced by the |
| available mime types to work with. |
| </p> |
| <p> |
| ETag (or Entity Tag) information: any Request headers for <code>If-None-Match</code> or |
| <code>If-Match</code> will be evaluated by the GzipHandler to determine if it was involved |
| in compression of the response earlier. This is usually present as a <code>--gzip</code> suffix |
| on the ETag that the Client User-Agent is tracking and handed to the Jetty server. |
| The special <code>--gzip</code> suffix on the ETag is how GzipHandler knows that the content |
| passed through itself, and this suffix will be stripped from the Request header values |
| before the request is sent onwards to the specific webapp / servlet endpoint for |
| handling. |
| If a ETag is present in the Response headers, and GzipHandler is compressing the |
| contents, it will add the <code>--gzip</code> suffix before the Response headers are committed |
| and sent to the User Agent. |
| </p> |
| <p> |
| This implementation relies on an Jetty internal <a href="../../HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server"><code>HttpOutput.Interceptor</code></a> |
| mechanism to allow for effective and efficient compression of the response on all Output API usages: |
| </p> |
| <ul> |
| <li> |
| <code>ServletOutputStream</code> - Obtained from <code>ServletResponse.getOutputStream()</code> |
| using the traditional Blocking I/O techniques |
| </li> |
| <li> |
| <code>WriteListener</code> - Provided to |
| <code>ServletOutputStream.setWriteListener(javax.servlet.WriteListener)</code> |
| using the new (since Servlet 3.1) Async I/O techniques |
| </li> |
| <li> |
| <code>PrintWriter</code> - Obtained from <code>ServletResponse.getWriter()</code> |
| using Blocking I/O techniques |
| </li> |
| </ul> |
| <p> |
| Historically the compression of responses were accomplished via |
| Servlet Filters (eg: <code>GzipFilter</code>) and usage of <code>HttpServletResponseWrapper</code>. |
| Since the introduction of Async I/O in Servlet 3.1, this older form of Gzip support |
| in web applications has been problematic and bug ridden. |
| </p></div> |
| </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.server.handler.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.<a href="../AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3> |
| <code><a href="../AbstractHandler.ErrorDispatchHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler.ErrorDispatchHandler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</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"> </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>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BREAK_EVEN_GZIP_SIZE">BREAK_EVEN_GZIP_SIZE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_MIN_GZIP_SIZE">DEFAULT_MIN_GZIP_SIZE</a></span></code></th> |
| <td class="colLast"> </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="#DEFLATE">DEFLATE</a></span></code></th> |
| <td class="colLast"> </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="#GZIP">GZIP</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.server.handler.<a href="../HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../HandlerWrapper.html#_handler">_handler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../../util/component/Dumpable.html#KEY">KEY</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"> </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()">GzipHandler</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiates a new GzipHandler.</div> |
| </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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="#addExcludedAgentPatterns(java.lang.String...)">addExcludedAgentPatterns</a></span>​(java.lang.String... patterns)</code></th> |
| <td class="colLast"> |
| <div class="block">Add excluded to the User-Agent filtering.</div> |
| </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="#addExcludedMethods(java.lang.String...)">addExcludedMethods</a></span>​(java.lang.String... methods)</code></th> |
| <td class="colLast"> |
| <div class="block">Add excluded to the HTTP methods filtering.</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="#addExcludedMimeTypes(java.lang.String...)">addExcludedMimeTypes</a></span>​(java.lang.String... types)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds excluded MIME types for response filtering.</div> |
| </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="#addExcludedPaths(java.lang.String...)">addExcludedPaths</a></span>​(java.lang.String... pathspecs)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds excluded Path Specs for request filtering.</div> |
| </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="#addIncludedAgentPatterns(java.lang.String...)">addIncludedAgentPatterns</a></span>​(java.lang.String... patterns)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds included User-Agents for filtering.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addIncludedMethods(java.lang.String...)">addIncludedMethods</a></span>​(java.lang.String... methods)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds included HTTP Methods (eg: POST, PATCH, DELETE) for filtering.</div> |
| </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="#addIncludedMimeTypes(java.lang.String...)">addIncludedMimeTypes</a></span>​(java.lang.String... types)</code></th> |
| <td class="colLast"> |
| <div class="block">Add included MIME types for response filtering</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="#addIncludedPaths(java.lang.String...)">addIncludedPaths</a></span>​(java.lang.String... pathspecs)</code></th> |
| <td class="colLast"> |
| <div class="block">Add included Path Specs for filtering.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCheckGzExists()">getCheckGzExists</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">feature will be removed in Jetty 10.x, with no replacement.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompressionLevel()">getCompressionLevel</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.zip.Deflater</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeflater(org.eclipse.jetty.server.Request,long)">getDeflater</a></span>​(<a href="../../Request.html" title="class in org.eclipse.jetty.server">Request</a> request, |
| long contentLength)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeflaterPoolCapacity()">getDeflaterPoolCapacity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the maximum number of Deflaters that the DeflaterPool can hold.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.util.EnumSet<javax.servlet.DispatcherType></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDispatcherTypes()">getDispatcherTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Set of <code>DispatcherType</code> that this Filter will operate on.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludedAgentPatterns()">getExcludedAgentPatterns</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of excluded User-Agent patterns</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludedMethodList()">getExcludedMethodList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the excluded filter list of HTTP methods in CSV format</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludedMethods()">getExcludedMethods</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of excluded HTTP methods</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludedMimeTypes()">getExcludedMimeTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of excluded MIME types</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExcludedPaths()">getExcludedPaths</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of excluded Path Specs</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludedAgentPatterns()">getIncludedAgentPatterns</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of included User-Agent patterns</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludedMethodList()">getIncludedMethodList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the included filter list of HTTP methods in CSV format</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludedMethods()">getIncludedMethods</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of included HTTP Methods</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludedMimeTypes()">getIncludedMimeTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of included MIME types</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncludedPaths()">getIncludedPaths</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the current filter list of included Path Specs</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInflateBufferSize()">getInflateBufferSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the size (in bytes) of the <code>Inflater</code> buffer used to inflate |
| compressed requests.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethods()">getMethods</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getIncludedMethods()"><code>getIncludedMethods()</code></a> instead.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinGzipSize()">getMinGzipSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the minimum size, in bytes, that a response <code>Content-Length</code> must be |
| before compression will trigger.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVaryField()">getVaryField</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></span>​(java.lang.String target, |
| <a href="../../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code></th> |
| <td class="colLast"> |
| <div class="block">Handle a request.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAgentGzipable(java.lang.String)">isAgentGzipable</a></span>​(java.lang.String ua)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if the provided User-Agent is allowed based on the User-Agent filters.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMimeTypeGzipable(java.lang.String)">isMimeTypeGzipable</a></span>​(java.lang.String mimetype)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if the provided MIME type is allowed based on the MIME type filters.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPathGzipable(java.lang.String)">isPathGzipable</a></span>​(java.lang.String requestURI)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if the provided Request URI is allowed based on the Path Specs filters.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSyncFlush()">isSyncFlush</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Is the <code>Deflater</code> running <code>Deflater.SYNC_FLUSH</code> or not.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newDeflaterPool(int)">newDeflaterPool</a></span>​(int capacity)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recycle(java.util.zip.Deflater)">recycle</a></span>​(java.util.zip.Deflater deflater)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCheckGzExists(boolean)">setCheckGzExists</a></span>​(boolean checkGzExists)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">feature will be removed in Jetty 10.x, with no replacement.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCompressionLevel(int)">setCompressionLevel</a></span>​(int compressionLevel)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Compression level that <code>Deflater</code> uses.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeflaterPoolCapacity(int)">setDeflaterPoolCapacity</a></span>​(int capacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of Deflaters that the DeflaterPool can hold.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDispatcherTypes(java.util.EnumSet)">setDispatcherTypes</a></span>​(java.util.EnumSet<javax.servlet.DispatcherType> dispatchers)</code></th> |
| <td class="colLast"> |
| <div class="block">Set of supported <code>DispatcherType</code> that this filter will operate on.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDispatcherTypes(javax.servlet.DispatcherType...)">setDispatcherTypes</a></span>​(javax.servlet.DispatcherType... dispatchers)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the list of supported <code>DispatcherType</code> that this filter will operate on.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludedAgentPatterns(java.lang.String...)">setExcludedAgentPatterns</a></span>​(java.lang.String... patterns)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the excluded filter list of User-Agent patterns (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludedMethodList(java.lang.String)">setExcludedMethodList</a></span>​(java.lang.String csvMethods)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the excluded filter list of HTTP Methods (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludedMethods(java.lang.String...)">setExcludedMethods</a></span>​(java.lang.String... methods)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the excluded filter list of HTTP methods (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludedMimeTypes(java.lang.String...)">setExcludedMimeTypes</a></span>​(java.lang.String... types)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the excluded filter list of MIME types (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExcludedPaths(java.lang.String...)">setExcludedPaths</a></span>​(java.lang.String... pathspecs)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the excluded filter list of Path specs (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludedAgentPatterns(java.lang.String...)">setIncludedAgentPatterns</a></span>​(java.lang.String... patterns)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the included filter list of User-Agent patterns (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludedMethodList(java.lang.String)">setIncludedMethodList</a></span>​(java.lang.String csvMethods)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the included filter list of HTTP Methods (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludedMethods(java.lang.String...)">setIncludedMethods</a></span>​(java.lang.String... methods)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the included filter list of HTTP methods (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludedMimeTypes(java.lang.String...)">setIncludedMimeTypes</a></span>​(java.lang.String... types)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the included filter list of MIME types (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludedPaths(java.lang.String...)">setIncludedPaths</a></span>​(java.lang.String... pathspecs)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the included filter list of Path specs (replacing any previously set)</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInflateBufferSize(int)">setInflateBufferSize</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the size (in bytes) of the <code>Inflater</code> buffer used to inflate comrpessed requests.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMinGzipSize(int)">setMinGzipSize</a></span>​(int minGzipSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the minimum response size to trigger dynamic compression.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSyncFlush(boolean)">setSyncFlush</a></span>​(boolean syncFlush)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the <code>Deflater</code> flush mode to use.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../HandlerWrapper.html#destroy()">destroy</a>, <a href="../HandlerWrapper.html#expandChildren(java.util.List,java.lang.Class)">expandChildren</a>, <a href="../HandlerWrapper.html#getHandler()">getHandler</a>, <a href="../HandlerWrapper.html#getHandlers()">getHandlers</a>, <a href="../HandlerWrapper.html#insertHandler(org.eclipse.jetty.server.handler.HandlerWrapper)">insertHandler</a>, <a href="../HandlerWrapper.html#setHandler(org.eclipse.jetty.server.Handler)">setHandler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandlerContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">AbstractHandlerContainer</a></h3> |
| <code><a href="../AbstractHandlerContainer.html#doShutdown(java.util.List)">doShutdown</a>, <a href="../AbstractHandlerContainer.html#expandHandler(org.eclipse.jetty.server.Handler,java.util.List,java.lang.Class)">expandHandler</a>, <a href="../AbstractHandlerContainer.html#findContainerOf(org.eclipse.jetty.server.HandlerContainer,java.lang.Class,org.eclipse.jetty.server.Handler)">findContainerOf</a>, <a href="../AbstractHandlerContainer.html#getChildHandlerByClass(java.lang.Class)">getChildHandlerByClass</a>, <a href="../AbstractHandlerContainer.html#getChildHandlers()">getChildHandlers</a>, <a href="../AbstractHandlerContainer.html#getChildHandlersByClass(java.lang.Class)">getChildHandlersByClass</a>, <a href="../AbstractHandlerContainer.html#setServer(org.eclipse.jetty.server.Server)">setServer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3> |
| <code><a href="../AbstractHandler.html#doError(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doError</a>, <a href="../AbstractHandler.html#doStop()">doStop</a>, <a href="../AbstractHandler.html#getServer()">getServer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#addEventListener(org.eclipse.jetty.util.component.Container.Listener)">addEventListener</a>, <a href="../../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String,java.util.Collection...)">dump</a>, <a href="../../../util/component/ContainerLifeCycle.html#dump(org.eclipse.jetty.util.component.Dumpable)">dump</a>, <a href="../../../util/component/ContainerLifeCycle.html#dumpBeans(java.lang.Appendable,java.lang.String,java.util.Collection...)">dumpBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#dumpObject(java.lang.Appendable,java.lang.Object)">dumpObject</a>, <a href="../../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../../util/component/ContainerLifeCycle.html#dumpThis(java.lang.Appendable)">dumpThis</a>, <a href="../../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#removeEventListener(org.eclipse.jetty.util.component.Container.Listener)">removeEventListener</a>, <a href="../../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../../util/component/ContainerLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../../util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../../util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../../util/component/AbstractLifeCycle.html#stop()">stop</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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../../util/component/LifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../../util/component/LifeCycle.html#isFailed()">isFailed</a>, <a href="../../../util/component/LifeCycle.html#isRunning()">isRunning</a>, <a href="../../../util/component/LifeCycle.html#isStarted()">isStarted</a>, <a href="../../../util/component/LifeCycle.html#isStarting()">isStarting</a>, <a href="../../../util/component/LifeCycle.html#isStopped()">isStopped</a>, <a href="../../../util/component/LifeCycle.html#isStopping()">isStopping</a>, <a href="../../../util/component/LifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../../util/component/LifeCycle.html#start()">start</a>, <a href="../../../util/component/LifeCycle.html#stop()">stop</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="GZIP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GZIP</h4> |
| <pre>public static final java.lang.String GZIP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.jetty.server.handler.gzip.GzipHandler.GZIP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFLATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFLATE</h4> |
| <pre>public static final java.lang.String DEFLATE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.jetty.server.handler.gzip.GzipHandler.DEFLATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFAULT_MIN_GZIP_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_MIN_GZIP_SIZE</h4> |
| <pre>public static final int DEFAULT_MIN_GZIP_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.jetty.server.handler.gzip.GzipHandler.DEFAULT_MIN_GZIP_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="BREAK_EVEN_GZIP_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BREAK_EVEN_GZIP_SIZE</h4> |
| <pre>public static final int BREAK_EVEN_GZIP_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.eclipse.jetty.server.handler.gzip.GzipHandler.BREAK_EVEN_GZIP_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </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>GzipHandler</h4> |
| <pre>public GzipHandler()</pre> |
| <div class="block">Instantiates a new GzipHandler.</div> |
| </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="addExcludedAgentPatterns(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludedAgentPatterns</h4> |
| <pre class="methodSignature">public void addExcludedAgentPatterns​(java.lang.String... patterns)</pre> |
| <div class="block">Add excluded to the User-Agent filtering.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patterns</code> - Regular expressions matching user agents to exclude</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addIncludedAgentPatterns(java.lang.String...)"><code>addIncludedAgentPatterns(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExcludedMethods(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludedMethods</h4> |
| <pre class="methodSignature">public void addExcludedMethods​(java.lang.String... methods)</pre> |
| <div class="block">Add excluded to the HTTP methods filtering.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - The methods to exclude in compression</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addIncludedMethods(java.lang.String...)"><code>addIncludedMethods(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDispatcherTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDispatcherTypes</h4> |
| <pre class="methodSignature">public java.util.EnumSet<javax.servlet.DispatcherType> getDispatcherTypes()</pre> |
| <div class="block">Get the Set of <code>DispatcherType</code> that this Filter will operate on.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the set of <code>DispatcherType</code> this filter will operate on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDispatcherTypes(java.util.EnumSet)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDispatcherTypes</h4> |
| <pre class="methodSignature">public void setDispatcherTypes​(java.util.EnumSet<javax.servlet.DispatcherType> dispatchers)</pre> |
| <div class="block">Set of supported <code>DispatcherType</code> that this filter will operate on.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatchers</code> - the set of <code>DispatcherType</code> that this filter will operate on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDispatcherTypes(javax.servlet.DispatcherType...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDispatcherTypes</h4> |
| <pre class="methodSignature">public void setDispatcherTypes​(javax.servlet.DispatcherType... dispatchers)</pre> |
| <div class="block">Set the list of supported <code>DispatcherType</code> that this filter will operate on.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatchers</code> - the list of <code>DispatcherType</code> that this filter will operate on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExcludedMimeTypes(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludedMimeTypes</h4> |
| <pre class="methodSignature">public void addExcludedMimeTypes​(java.lang.String... types)</pre> |
| <div class="block">Adds excluded MIME types for response filtering. |
| |
| <p> |
| <em>Deprecation Warning: </em> |
| For backward compatibility the MIME types parameters may be comma separated strings, |
| but this will not be supported in future versions of Jetty. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - The mime types to exclude (without charset or other parameters).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addIncludedMimeTypes(java.lang.String...)"><code>addIncludedMimeTypes(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExcludedPaths(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludedPaths</h4> |
| <pre class="methodSignature">public void addExcludedPaths​(java.lang.String... pathspecs)</pre> |
| <div class="block">Adds excluded Path Specs for request filtering. |
| |
| <p> |
| There are 2 syntaxes supported, Servlet <code>url-pattern</code> based, and |
| Regex based. This means that the initial characters on the path spec |
| line are very strict, and determine the behavior of the path matching. |
| <ul> |
| <li>If the spec starts with <code>'^'</code> the spec is assumed to be |
| a regex based path spec and will match with normal Java regex rules.</li> |
| <li>If the spec starts with <code>'/'</code> then spec is assumed to be |
| a Servlet url-pattern rules path spec for either an exact match |
| or prefix based match.</li> |
| <li>If the spec starts with <code>'*.'</code> then spec is assumed to be |
| a Servlet url-pattern rules path spec for a suffix based match.</li> |
| <li>All other syntaxes are unsupported</li> |
| </ul> |
| <p> |
| Note: inclusion takes precedence over exclude.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathspecs</code> - Path specs (as per servlet spec) to exclude. If a |
| ServletContext is available, the paths are relative to the context path, |
| otherwise they are absolute.<br> |
| For backward compatibility the pathspecs may be comma separated strings, but this |
| will not be supported in future versions.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addIncludedPaths(java.lang.String...)"><code>addIncludedPaths(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIncludedAgentPatterns(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludedAgentPatterns</h4> |
| <pre class="methodSignature">public void addIncludedAgentPatterns​(java.lang.String... patterns)</pre> |
| <div class="block">Adds included User-Agents for filtering.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patterns</code> - Regular expressions matching user agents to include</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addExcludedAgentPatterns(java.lang.String...)"><code>addExcludedAgentPatterns(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIncludedMethods(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludedMethods</h4> |
| <pre class="methodSignature">public void addIncludedMethods​(java.lang.String... methods)</pre> |
| <div class="block">Adds included HTTP Methods (eg: POST, PATCH, DELETE) for filtering.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - The HTTP methods to include in compression.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addExcludedMethods(java.lang.String...)"><code>addExcludedMethods(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSyncFlush()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSyncFlush</h4> |
| <pre class="methodSignature">public boolean isSyncFlush()</pre> |
| <div class="block">Is the <code>Deflater</code> running <code>Deflater.SYNC_FLUSH</code> or not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if <code>Deflater.SYNC_FLUSH</code> is used, else <code>Deflater.NO_FLUSH</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setSyncFlush(boolean)"><code>setSyncFlush(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSyncFlush(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSyncFlush</h4> |
| <pre class="methodSignature">public void setSyncFlush​(boolean syncFlush)</pre> |
| <div class="block">Set the <code>Deflater</code> flush mode to use. <code>Deflater.SYNC_FLUSH</code> |
| should be used if the application wishes to stream the data, but this may |
| hurt compression performance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>syncFlush</code> - True if <code>Deflater.SYNC_FLUSH</code> is used, else <code>Deflater.NO_FLUSH</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isSyncFlush()"><code>isSyncFlush()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIncludedMimeTypes(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludedMimeTypes</h4> |
| <pre class="methodSignature">public void addIncludedMimeTypes​(java.lang.String... types)</pre> |
| <div class="block">Add included MIME types for response filtering</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - The mime types to include (without charset or other parameters) |
| For backward compatibility the mimetypes may be comma separated strings, but this |
| will not be supported in future versions.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addExcludedMimeTypes(java.lang.String...)"><code>addExcludedMimeTypes(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIncludedPaths(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludedPaths</h4> |
| <pre class="methodSignature">public void addIncludedPaths​(java.lang.String... pathspecs)</pre> |
| <div class="block">Add included Path Specs for filtering. |
| |
| <p> |
| There are 2 syntaxes supported, Servlet <code>url-pattern</code> based, and |
| Regex based. This means that the initial characters on the path spec |
| line are very strict, and determine the behavior of the path matching. |
| <ul> |
| <li>If the spec starts with <code>'^'</code> the spec is assumed to be |
| a regex based path spec and will match with normal Java regex rules.</li> |
| <li>If the spec starts with <code>'/'</code> then spec is assumed to be |
| a Servlet url-pattern rules path spec for either an exact match |
| or prefix based match.</li> |
| <li>If the spec starts with <code>'*.'</code> then spec is assumed to be |
| a Servlet url-pattern rules path spec for a suffix based match.</li> |
| <li>All other syntaxes are unsupported</li> |
| </ul> |
| <p> |
| Note: inclusion takes precedence over exclusion.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathspecs</code> - Path specs (as per servlet spec) to include. If a |
| ServletContext is available, the paths are relative to the context path, |
| otherwise they are absolute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre class="methodSignature">protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractHandler.html#doStart()">doStart</a></code> in class <code><a href="../AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCheckGzExists()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCheckGzExists</h4> |
| <pre class="methodSignature">@Deprecated |
| public boolean getCheckGzExists()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">feature will be removed in Jetty 10.x, with no replacement.</div> |
| </div> |
| </li> |
| </ul> |
| <a id="getCompressionLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompressionLevel</h4> |
| <pre class="methodSignature">public int getCompressionLevel()</pre> |
| </li> |
| </ul> |
| <a id="getDeflater(org.eclipse.jetty.server.Request,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeflater</h4> |
| <pre class="methodSignature">public java.util.zip.Deflater getDeflater​(<a href="../../Request.html" title="class in org.eclipse.jetty.server">Request</a> request, |
| long contentLength)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="GzipFactory.html#getDeflater(org.eclipse.jetty.server.Request,long)">getDeflater</a></code> in interface <code><a href="GzipFactory.html" title="interface in org.eclipse.jetty.server.handler.gzip">GzipFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludedAgentPatterns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludedAgentPatterns</h4> |
| <pre class="methodSignature">public java.lang.String[] getExcludedAgentPatterns()</pre> |
| <div class="block">Get the current filter list of excluded User-Agent patterns</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of excluded User-Agent patterns</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIncludedAgentPatterns()"><code>getIncludedAgentPatterns()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludedMethods()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludedMethods</h4> |
| <pre class="methodSignature">public java.lang.String[] getExcludedMethods()</pre> |
| <div class="block">Get the current filter list of excluded HTTP methods</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of excluded HTTP methods</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIncludedMethods()"><code>getIncludedMethods()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludedMimeTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludedMimeTypes</h4> |
| <pre class="methodSignature">public java.lang.String[] getExcludedMimeTypes()</pre> |
| <div class="block">Get the current filter list of excluded MIME types</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of excluded MIME types</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIncludedMimeTypes()"><code>getIncludedMimeTypes()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludedPaths()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludedPaths</h4> |
| <pre class="methodSignature">public java.lang.String[] getExcludedPaths()</pre> |
| <div class="block">Get the current filter list of excluded Path Specs</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of excluded Path Specs</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIncludedPaths()"><code>getIncludedPaths()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludedAgentPatterns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludedAgentPatterns</h4> |
| <pre class="methodSignature">public java.lang.String[] getIncludedAgentPatterns()</pre> |
| <div class="block">Get the current filter list of included User-Agent patterns</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of included User-Agent patterns</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExcludedAgentPatterns()"><code>getExcludedAgentPatterns()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludedMethods()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludedMethods</h4> |
| <pre class="methodSignature">public java.lang.String[] getIncludedMethods()</pre> |
| <div class="block">Get the current filter list of included HTTP Methods</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of included HTTP methods</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExcludedMethods()"><code>getExcludedMethods()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludedMimeTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludedMimeTypes</h4> |
| <pre class="methodSignature">public java.lang.String[] getIncludedMimeTypes()</pre> |
| <div class="block">Get the current filter list of included MIME types</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of included MIME types</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExcludedMimeTypes()"><code>getExcludedMimeTypes()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludedPaths()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludedPaths</h4> |
| <pre class="methodSignature">public java.lang.String[] getIncludedPaths()</pre> |
| <div class="block">Get the current filter list of included Path Specs</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of included Path Specs</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExcludedPaths()"><code>getExcludedPaths()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMethods()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethods</h4> |
| <pre class="methodSignature">@Deprecated |
| public java.lang.String[] getMethods()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getIncludedMethods()"><code>getIncludedMethods()</code></a> instead. (Will be removed in Jetty 10)</div> |
| </div> |
| <div class="block">Get the current filter list of included HTTP methods</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter list of included HTTP methods</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMinGzipSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinGzipSize</h4> |
| <pre class="methodSignature">public int getMinGzipSize()</pre> |
| <div class="block">Get the minimum size, in bytes, that a response <code>Content-Length</code> must be |
| before compression will trigger.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>minimum response size (in bytes) that triggers compression</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setMinGzipSize(int)"><code>setMinGzipSize(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getVaryField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVaryField</h4> |
| <pre class="methodSignature">protected <a href="../../../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a> getVaryField()</pre> |
| </li> |
| </ul> |
| <a id="getInflateBufferSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInflateBufferSize</h4> |
| <pre class="methodSignature">public int getInflateBufferSize()</pre> |
| <div class="block">Get the size (in bytes) of the <code>Inflater</code> buffer used to inflate |
| compressed requests.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size in bytes of the buffer, or 0 for no inflation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setInflateBufferSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInflateBufferSize</h4> |
| <pre class="methodSignature">public void setInflateBufferSize​(int size)</pre> |
| <div class="block">Set the size (in bytes) of the <code>Inflater</code> buffer used to inflate comrpessed requests.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - size in bytes of the buffer, or 0 for no inflation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handle</h4> |
| <pre class="methodSignature">public void handle​(java.lang.String target, |
| <a href="../../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">Handler</a></code></span></div> |
| <div class="block">Handle a request.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></code> in interface <code><a href="../../Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../HandlerWrapper.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a></code> in class <code><a href="../HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The target of the request - either a URI or a name.</dd> |
| <dd><code>baseRequest</code> - The original unwrapped request object.</dd> |
| <dd><code>request</code> - The request either as the <a href="../../Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object or a wrapper of that request. The |
| <code><a href="../../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../../HttpChannel.html#getRequest()"><code>getRequest()</code></a></code> |
| method can be used access the Request object if required.</dd> |
| <dd><code>response</code> - The response as the <a href="../../Response.html" title="class in org.eclipse.jetty.server"><code>Response</code></a> object or a wrapper of that request. The |
| <code><a href="../../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../../HttpChannel.html#getResponse()"><code>getResponse()</code></a></code> |
| method can be used access the Response object if required.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to handle the request or response processing</dd> |
| <dd><code>javax.servlet.ServletException</code> - if unable to handle the request or response due to underlying servlet issue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAgentGzipable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAgentGzipable</h4> |
| <pre class="methodSignature">protected boolean isAgentGzipable​(java.lang.String ua)</pre> |
| <div class="block">Test if the provided User-Agent is allowed based on the User-Agent filters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ua</code> - the user agent</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether compressing is allowed for the given user agent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isMimeTypeGzipable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMimeTypeGzipable</h4> |
| <pre class="methodSignature">public boolean isMimeTypeGzipable​(java.lang.String mimetype)</pre> |
| <div class="block">Test if the provided MIME type is allowed based on the MIME type filters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="GzipFactory.html#isMimeTypeGzipable(java.lang.String)">isMimeTypeGzipable</a></code> in interface <code><a href="GzipFactory.html" title="interface in org.eclipse.jetty.server.handler.gzip">GzipFactory</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mimetype</code> - the MIME type to test</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if allowed, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isPathGzipable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPathGzipable</h4> |
| <pre class="methodSignature">protected boolean isPathGzipable​(java.lang.String requestURI)</pre> |
| <div class="block">Test if the provided Request URI is allowed based on the Path Specs filters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestURI</code> - the request uri</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether compressing is allowed for the given the path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="recycle(java.util.zip.Deflater)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recycle</h4> |
| <pre class="methodSignature">public void recycle​(java.util.zip.Deflater deflater)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="GzipFactory.html#recycle(java.util.zip.Deflater)">recycle</a></code> in interface <code><a href="GzipFactory.html" title="interface in org.eclipse.jetty.server.handler.gzip">GzipFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCheckGzExists(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCheckGzExists</h4> |
| <pre class="methodSignature">@Deprecated |
| public void setCheckGzExists​(boolean checkGzExists)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">feature will be removed in Jetty 10.x, with no replacement.</div> |
| </div> |
| <div class="block">Set the Check if <code>*.gz</code> file for the incoming file exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkGzExists</code> - whether to check if a static gz file exists for |
| the resource that the DefaultServlet may serve as precompressed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCompressionLevel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressionLevel</h4> |
| <pre class="methodSignature">public void setCompressionLevel​(int compressionLevel)</pre> |
| <div class="block">Set the Compression level that <code>Deflater</code> uses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressionLevel</code> - The compression level to use to initialize <code>Deflater.setLevel(int)</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Deflater.setLevel(int)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludedAgentPatterns(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedAgentPatterns</h4> |
| <pre class="methodSignature">public void setExcludedAgentPatterns​(java.lang.String... patterns)</pre> |
| <div class="block">Set the excluded filter list of User-Agent patterns (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patterns</code> - Regular expressions list matching user agents to exclude</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIncludedAgentPatterns(java.lang.String...)"><code>setIncludedAgentPatterns(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludedMethods(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedMethods</h4> |
| <pre class="methodSignature">public void setExcludedMethods​(java.lang.String... methods)</pre> |
| <div class="block">Set the excluded filter list of HTTP methods (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - the HTTP methods to exclude</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIncludedMethods(java.lang.String...)"><code>setIncludedMethods(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludedMimeTypes(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedMimeTypes</h4> |
| <pre class="methodSignature">public void setExcludedMimeTypes​(java.lang.String... types)</pre> |
| <div class="block">Set the excluded filter list of MIME types (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - The mime types to exclude (without charset or other parameters)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIncludedMimeTypes(java.lang.String...)"><code>setIncludedMimeTypes(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludedPaths(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedPaths</h4> |
| <pre class="methodSignature">public void setExcludedPaths​(java.lang.String... pathspecs)</pre> |
| <div class="block">Set the excluded filter list of Path specs (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathspecs</code> - Path specs (as per servlet spec) to exclude. If a |
| ServletContext is available, the paths are relative to the context path, |
| otherwise they are absolute.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIncludedPaths(java.lang.String...)"><code>setIncludedPaths(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludedAgentPatterns(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedAgentPatterns</h4> |
| <pre class="methodSignature">public void setIncludedAgentPatterns​(java.lang.String... patterns)</pre> |
| <div class="block">Set the included filter list of User-Agent patterns (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>patterns</code> - Regular expressions matching user agents to include</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setExcludedAgentPatterns(java.lang.String...)"><code>setExcludedAgentPatterns(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludedMethods(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedMethods</h4> |
| <pre class="methodSignature">public void setIncludedMethods​(java.lang.String... methods)</pre> |
| <div class="block">Set the included filter list of HTTP methods (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - The methods to include in compression</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setExcludedMethods(java.lang.String...)"><code>setExcludedMethods(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludedMimeTypes(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedMimeTypes</h4> |
| <pre class="methodSignature">public void setIncludedMimeTypes​(java.lang.String... types)</pre> |
| <div class="block">Set the included filter list of MIME types (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>types</code> - The mime types to include (without charset or other parameters)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setExcludedMimeTypes(java.lang.String...)"><code>setExcludedMimeTypes(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludedPaths(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedPaths</h4> |
| <pre class="methodSignature">public void setIncludedPaths​(java.lang.String... pathspecs)</pre> |
| <div class="block">Set the included filter list of Path specs (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathspecs</code> - Path specs (as per servlet spec) to include. If a |
| ServletContext is available, the paths are relative to the context path, |
| otherwise they are absolute</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setExcludedPaths(java.lang.String...)"><code>setExcludedPaths(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMinGzipSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinGzipSize</h4> |
| <pre class="methodSignature">public void setMinGzipSize​(int minGzipSize)</pre> |
| <div class="block">Set the minimum response size to trigger dynamic compression. |
| <p> |
| Sizes below <a href="#BREAK_EVEN_GZIP_SIZE"><code>BREAK_EVEN_GZIP_SIZE</code></a> will result a compressed response that is larger than the |
| original data. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minGzipSize</code> - minimum response size in bytes (not allowed to be lower then <a href="#BREAK_EVEN_GZIP_SIZE"><code>BREAK_EVEN_GZIP_SIZE</code></a>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncludedMethodList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedMethodList</h4> |
| <pre class="methodSignature">public void setIncludedMethodList​(java.lang.String csvMethods)</pre> |
| <div class="block">Set the included filter list of HTTP Methods (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>csvMethods</code> - the list of methods, CSV format</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setExcludedMethodList(java.lang.String)"><code>setExcludedMethodList(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncludedMethodList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncludedMethodList</h4> |
| <pre class="methodSignature">public java.lang.String getIncludedMethodList()</pre> |
| <div class="block">Get the included filter list of HTTP methods in CSV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the included filter list of HTTP methods in CSV format</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExcludedMethodList()"><code>getExcludedMethodList()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExcludedMethodList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedMethodList</h4> |
| <pre class="methodSignature">public void setExcludedMethodList​(java.lang.String csvMethods)</pre> |
| <div class="block">Set the excluded filter list of HTTP Methods (replacing any previously set)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>csvMethods</code> - the list of methods, CSV format</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setIncludedMethodList(java.lang.String)"><code>setIncludedMethodList(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExcludedMethodList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExcludedMethodList</h4> |
| <pre class="methodSignature">public java.lang.String getExcludedMethodList()</pre> |
| <div class="block">Get the excluded filter list of HTTP methods in CSV format</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the excluded filter list of HTTP methods in CSV format</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getIncludedMethodList()"><code>getIncludedMethodList()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeflaterPoolCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeflaterPoolCapacity</h4> |
| <pre class="methodSignature">public int getDeflaterPoolCapacity()</pre> |
| <div class="block">Gets the maximum number of Deflaters that the DeflaterPool can hold.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Deflater pool capacity</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDeflaterPoolCapacity(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeflaterPoolCapacity</h4> |
| <pre class="methodSignature">public void setDeflaterPoolCapacity​(int capacity)</pre> |
| <div class="block">Sets the maximum number of Deflaters that the DeflaterPool can hold.</div> |
| </li> |
| </ul> |
| <a id="newDeflaterPool(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDeflaterPool</h4> |
| <pre class="methodSignature">protected <a href="../../../util/compression/DeflaterPool.html" title="class in org.eclipse.jetty.util.compression">DeflaterPool</a> newDeflaterPool​(int capacity)</pre> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../util/component/AbstractLifeCycle.html#toString()">toString</a></code> in class <code><a href="../../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd> |
| </dl> |
| </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/GzipHandler.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><a href="#nested.class.summary">Nested</a> | </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–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |