| <!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>org.apache.calcite.avatica.server (Apache Calcite Avatica 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="org.apache.calcite.avatica.server (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 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"> |
| <li><a href="../../../../../org/apache/calcite/avatica/remote/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/calcite/avatica/standalone/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/avatica/server/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.avatica.server</h1> |
| <div class="docSummary"> |
| <div class="block">Avatica server that listens for HTTP requests.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a></td> |
| <td class="colLast"> |
| <div class="block">A generic configuration interface that users can implement to configure the <a href="../../../../../org/apache/calcite/avatica/server/HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/DoAsRemoteUserCallback.html" title="interface in org.apache.calcite.avatica.server">DoAsRemoteUserCallback</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/Main.HandlerFactory.html" title="interface in org.apache.calcite.avatica.server">Main.HandlerFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory that instantiates Jetty Handlers</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></td> |
| <td class="colLast"> |
| <div class="block">An <a href="../../../../../org/apache/calcite/avatica/server/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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a></td> |
| <td class="colLast"> |
| <div class="block">Extracts remote user from request</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/ServerCustomizer.html" title="interface in org.apache.calcite.avatica.server">ServerCustomizer</a><T></td> |
| <td class="colLast"> |
| <div class="block">Callback for customizing a Server.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AbstractAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">AbstractAvaticaHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Base-class for Avatica implemented Jetty Handlers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaJsonHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaJsonHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaProtobufHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaSpnegoAuthenticator.html" title="class in org.apache.calcite.avatica.server">AvaticaSpnegoAuthenticator</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/DelegatingAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">DelegatingAvaticaHandler</a></td> |
| <td class="colLast"> |
| <div class="block">An AvaticaHandler implementation that delegates to a provided Jetty Handler instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/HandlerFactory.html" title="class in org.apache.calcite.avatica.server">HandlerFactory</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/HttpQueryStringParameterRemoteUserExtractor.html" title="class in org.apache.calcite.avatica.server">HttpQueryStringParameterRemoteUserExtractor</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/calcite/avatica/server/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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/HttpRequestRemoteUserExtractor.html" title="class in org.apache.calcite.avatica.server">HttpRequestRemoteUserExtractor</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/calcite/avatica/server/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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/HttpServer.html" title="class in org.apache.calcite.avatica.server">HttpServer</a></td> |
| <td class="colLast"> |
| <div class="block">Avatica HTTP server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a><T></td> |
| <td class="colLast"> |
| <div class="block">Builder class for creating instances of <a href="../../../../../org/apache/calcite/avatica/server/HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/Main.html" title="class in org.apache.calcite.avatica.server">Main</a></td> |
| <td class="colLast"> |
| <div class="block">Jetty handler that executes Avatica JSON request-responses.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/PropertyBasedSpnegoLoginService.html" title="class in org.apache.calcite.avatica.server">PropertyBasedSpnegoLoginService</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/ServerKeytabJaasConf.html" title="class in org.apache.calcite.avatica.server">ServerKeytabJaasConf</a></td> |
| <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" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserDisallowedException.html" title="class in org.apache.calcite.avatica.server">RemoteUserDisallowedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception to encapsulate that a user is disallowed to access Avatica.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserExtractionException.html" title="class in org.apache.calcite.avatica.server">RemoteUserExtractionException</a></td> |
| <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> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.calcite.avatica.server Description">Package org.apache.calcite.avatica.server Description</h2> |
| <div class="block">Avatica server that listens for HTTP requests.</div> |
| </div> |
| <!-- ======= 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 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"> |
| <li><a href="../../../../../org/apache/calcite/avatica/remote/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/calcite/avatica/standalone/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/avatica/server/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012–2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
