| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.avatica.server (Apache Calcite Avatica API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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="org.apache.calcite.avatica.server (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.avatica.server</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Avatica server that listens for HTTP requests.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></th> |
| <td class="colLast"> |
| <div class="block">A custom interface that extends the Jetty interface to enable extra control within Avatica.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a></th> |
| <td class="colLast"> |
| <div class="block">A generic configuration interface that users can implement to configure the <a href="HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DoAsRemoteUserCallback.html" title="interface in org.apache.calcite.avatica.server">DoAsRemoteUserCallback</a></th> |
| <td class="colLast"> |
| <div class="block">A callback which the server can invoke to allow implementations to control additional logic |
| about whether or not a client from a specific host should be run.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Main.HandlerFactory.html" title="interface in org.apache.calcite.avatica.server">Main.HandlerFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory that instantiates Jetty Handlers</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></th> |
| <td class="colLast"> |
| <div class="block">An <a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server"><code>AvaticaHandler</code></a> that is capable of collecting metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a></th> |
| <td class="colLast"> |
| <div class="block">Extracts remote user from request</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ServerCustomizer.html" title="interface in org.apache.calcite.avatica.server">ServerCustomizer</a><T></th> |
| <td class="colLast"> |
| <div class="block">Callback for customizing a Server.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">AbstractAvaticaHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Base-class for Avatica implemented Jetty Handlers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AvaticaJsonHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaJsonHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaProtobufHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AvaticaSpnegoAuthenticator.html" title="class in org.apache.calcite.avatica.server">AvaticaSpnegoAuthenticator</a></th> |
| <td class="colLast"> |
| <div class="block">Custom SpnegoAuthenticator which will still reponse with a WWW-Authentication: Negotiate |
| header if the client provides some other kind of authentication header.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DelegatingAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">DelegatingAvaticaHandler</a></th> |
| <td class="colLast"> |
| <div class="block">An AvaticaHandler implementation that delegates to a provided Jetty Handler instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HandlerFactory.html" title="class in org.apache.calcite.avatica.server">HandlerFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory that instantiates the desired implementation, typically differing on the method |
| used to serialize messages, for use in the Avatica server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="HttpQueryStringParameterRemoteUserExtractor.html" title="class in org.apache.calcite.avatica.server">HttpQueryStringParameterRemoteUserExtractor</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server"><code>RemoteUserExtractor</code></a> that extracts the remote user from an HTTP query string parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HttpRequestRemoteUserExtractor.html" title="class in org.apache.calcite.avatica.server">HttpRequestRemoteUserExtractor</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server"><code>RemoteUserExtractor</code></a> that extracts the remote user from the HTTP request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="HttpServer.html" title="class in org.apache.calcite.avatica.server">HttpServer</a></th> |
| <td class="colLast"> |
| <div class="block">Avatica HTTP server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a><T></th> |
| <td class="colLast"> |
| <div class="block">Builder class for creating instances of <a href="HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Main.html" title="class in org.apache.calcite.avatica.server">Main</a></th> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PropertyBasedSpnegoLoginService.html" title="class in org.apache.calcite.avatica.server">PropertyBasedSpnegoLoginService</a></th> |
| <td class="colLast"> |
| <div class="block">A customization of <code>SpnegoLoginService</code> which directly |
| specifies the server's principal instead of requiring a file to exist.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ServerKeytabJaasConf.html" title="class in org.apache.calcite.avatica.server">ServerKeytabJaasConf</a></th> |
| <td class="colLast"> |
| <div class="block">Javax Configuration class which always returns a configuration for our keytab-based |
| login suitable for callers which are acting as a initiator or acceptor (e.g.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RemoteUserDisallowedException.html" title="class in org.apache.calcite.avatica.server">RemoteUserDisallowedException</a></th> |
| <td class="colLast"> |
| <div class="block">An exception to encapsulate that a user is disallowed to access Avatica.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RemoteUserExtractionException.html" title="class in org.apache.calcite.avatica.server">RemoteUserExtractionException</a></th> |
| <td class="colLast"> |
| <div class="block">An exception thrown when encountering an error extracting a remote user from a request.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
