| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FlightServerMiddleware (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FlightServerMiddleware (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FlightServerMiddleware.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"> |
| <li><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="interface in org.apache.arrow.flight"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flight/FlightServerMiddleware.html" target="_top">Frames</a></li> |
| <li><a href="FlightServerMiddleware.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.arrow.flight</div> |
| <h2 title="Interface FlightServerMiddleware" class="title">Interface FlightServerMiddleware</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/arrow/flight/auth2/ServerCallHeaderAuthMiddleware.html" title="class in org.apache.arrow.flight.auth2">ServerCallHeaderAuthMiddleware</a>, <a href="../../../../org/apache/arrow/flight/ServerHeaderMiddleware.html" title="class in org.apache.arrow.flight">ServerHeaderMiddleware</a>, <a href="../../../../org/apache/arrow/flight/ServerSessionMiddleware.html" title="class in org.apache.arrow.flight">ServerSessionMiddleware</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FlightServerMiddleware</span></pre> |
| <div class="block">Server-side middleware for Flight calls. |
| |
| <p>Middleware are instantiated per-call. |
| |
| <p>Methods are not guaranteed to be called on any particular thread, relative to the thread that Flight requests are |
| executed on. Do not depend on thread-local storage; instead, use state on the middleware instance. Service |
| implementations may communicate with middleware implementations through |
| <code>org.apache.arrow.flight.FlightProducer.CallContext#getMiddleware(Key)</code>. Methods on the middleware instance |
| are non-reentrant, that is, a particular RPC will not make multiple concurrent calls to methods on a single |
| middleware instance. However, methods on the factory instance are expected to be thread-safe, and if the factory |
| instance returns the same middleware object more than once, then that middleware object must be thread-safe.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware.Factory</a><<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="type parameter in FlightServerMiddleware.Factory">T</a> extends <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware</a>></span></code> |
| <div class="block">A factory for Flight server middleware.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Key.html" title="class in org.apache.arrow.flight">FlightServerMiddleware.Key</a><<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Key.html" title="type parameter in FlightServerMiddleware.Key">T</a> extends <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware</a>></span></code> |
| <div class="block">A key for Flight server middleware.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html#onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-">onBeforeSendingHeaders</a></span>(<a href="../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a> outgoingHeaders)</code> |
| <div class="block">Callback for when the underlying transport is about to send response headers.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-">onCallCompleted</a></span>(<a href="../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> status)</code> |
| <div class="block">Callback for when the underlying transport has completed a call.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html#onCallErrored-java.lang.Throwable-">onCallErrored</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> err)</code> |
| <div class="block">Callback for when an RPC method implementation throws an uncaught exception.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="onBeforeSendingHeaders-org.apache.arrow.flight.CallHeaders-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onBeforeSendingHeaders</h4> |
| <pre>void onBeforeSendingHeaders(<a href="../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a> outgoingHeaders)</pre> |
| <div class="block">Callback for when the underlying transport is about to send response headers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>outgoingHeaders</code> - A mutable set of response headers. These can be manipulated to send different headers to the |
| client.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onCallCompleted-org.apache.arrow.flight.CallStatus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onCallCompleted</h4> |
| <pre>void onCallCompleted(<a href="../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight">CallStatus</a> status)</pre> |
| <div class="block">Callback for when the underlying transport has completed a call.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - Whether the call completed successfully or not.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onCallErrored-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onCallErrored</h4> |
| <pre>void onCallErrored(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> err)</pre> |
| <div class="block">Callback for when an RPC method implementation throws an uncaught exception. |
| |
| <p>May be called multiple times, and may be called before or after <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-"><code>onCallCompleted(CallStatus)</code></a>. |
| Generally, an uncaught exception will end the call with a error <a href="../../../../org/apache/arrow/flight/CallStatus.html" title="class in org.apache.arrow.flight"><code>CallStatus</code></a>, and will be reported to <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html#onCallCompleted-org.apache.arrow.flight.CallStatus-"><code>onCallCompleted(CallStatus)</code></a>, but not necessarily this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>err</code> - The exception that was thrown.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FlightServerMiddleware.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"> |
| <li><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="interface in org.apache.arrow.flight"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flight/FlightServerMiddleware.html" target="_top">Frames</a></li> |
| <li><a href="FlightServerMiddleware.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |