| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 --> |
| <title>HttpOutput.Interceptor (Jetty :: Project 9.4.38.v20210224 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HttpOutput.Interceptor (Jetty :: Project 9.4.38.v20210224 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":18,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/HttpOutput.Interceptor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</a></div> |
| <h2 title="Interface HttpOutput.Interceptor" class="title">Interface HttpOutput.Interceptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="handler/gzip/GzipHttpOutputInterceptor.html" title="class in org.eclipse.jetty.server.handler.gzip">GzipHttpOutputInterceptor</a></code>, <code><a href="../http2/server/HTTP2ServerConnection.ServerHttpChannelOverHTTP2.html" title="class in org.eclipse.jetty.http2.server">HTTP2ServerConnection.ServerHttpChannelOverHTTP2</a></code>, <code><a href="HttpChannel.html" title="class in org.eclipse.jetty.server">HttpChannel</a></code>, <code><a href="../fcgi/server/HttpChannelOverFCGI.html" title="class in org.eclipse.jetty.fcgi.server">HttpChannelOverFCGI</a></code>, <code><a href="HttpChannelOverHttp.html" title="class in org.eclipse.jetty.server">HttpChannelOverHttp</a></code>, <code><a href="../http2/server/HttpChannelOverHTTP2.html" title="class in org.eclipse.jetty.http2.server">HttpChannelOverHTTP2</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="HttpOutput.html" title="class in org.eclipse.jetty.server">HttpOutput</a></dd> |
| </dl> |
| <hr> |
| <pre>public static interface <span class="typeNameLabel">HttpOutput.Interceptor</span></pre> |
| <div class="block">The HttpOutput.Interceptor is a single intercept point for all |
| output written to the HttpOutput: via writer; via output stream; |
| asynchronously; or blocking. |
| <p> |
| The Interceptor can be used to implement translations (eg Gzip) or |
| additional buffering that acts on all output. Interceptors are |
| created in a chain, so that multiple concerns may intercept. |
| <p> |
| The <a href="HttpChannel.html" title="class in org.eclipse.jetty.server"><code>HttpChannel</code></a> is an <a href="HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server"><code>HttpOutput.Interceptor</code></a> and is always the |
| last link in any Interceptor chain. |
| <p> |
| Responses are committed by the first call to |
| <a href="#write(java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)"><code>write(ByteBuffer, boolean, Callback)</code></a> |
| and closed by a call to <a href="#write(java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)"><code>write(ByteBuffer, boolean, Callback)</code></a> |
| with the last boolean set true. If no content is available to commit |
| or close, then a null buffer is passed.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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><a href="HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server">HttpOutput.Interceptor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextInterceptor()">getNextInterceptor</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOptimizedForDirectBuffers()">isOptimizedForDirectBuffers</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetBuffer()">resetBuffer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reset the buffers.</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="#write(java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)">write</a></span>​(java.nio.ByteBuffer content, |
| boolean last, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Write content.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="write(java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre class="methodSignature">void write​(java.nio.ByteBuffer content, |
| boolean last, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</pre> |
| <div class="block">Write content. |
| The response is committed by the first call to write and is closed by |
| a call with last == true. Empty content buffers may be passed to |
| force a commit or close.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - The content to be written or an empty buffer.</dd> |
| <dd><code>last</code> - True if this is the last call to write</dd> |
| <dd><code>callback</code> - The callback to use to indicate <a href="../util/Callback.html#succeeded()"><code>Callback.succeeded()</code></a> |
| or <a href="../util/Callback.html#failed(java.lang.Throwable)"><code>Callback.failed(Throwable)</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNextInterceptor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNextInterceptor</h4> |
| <pre class="methodSignature"><a href="HttpOutput.Interceptor.html" title="interface in org.eclipse.jetty.server">HttpOutput.Interceptor</a> getNextInterceptor()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The next Interceptor in the chain or null if this is the |
| last Interceptor in the chain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isOptimizedForDirectBuffers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptimizedForDirectBuffers</h4> |
| <pre class="methodSignature">boolean isOptimizedForDirectBuffers()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the Interceptor is optimized to receive direct |
| <code>ByteBuffer</code>s in the <a href="#write(java.nio.ByteBuffer,boolean,org.eclipse.jetty.util.Callback)"><code>write(ByteBuffer, boolean, Callback)</code></a> |
| method. If false is returned, then passing direct buffers may cause |
| inefficiencies.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resetBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resetBuffer</h4> |
| <pre class="methodSignature">default void resetBuffer() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Reset the buffers. |
| <p>If the Interceptor contains buffers then reset them.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the response has been |
| committed and buffers and/or headers cannot be reset.</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/HttpOutput.Interceptor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
