blob: c68b53076a5ccd5907b7c2271c9d1e7f280b29b9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.calcite.avatica.server.AvaticaHandler (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="Uses of Interface org.apache.calcite.avatica.server.AvaticaHandler (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><a href="../package-summary.html">Package</a></li>
<li><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">Class</a></li>
<li class="navBarCell1Rev">Use</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&nbsp;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">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.apache.calcite.avatica.server.AvaticaHandler" class="title">Uses of Interface<br>org.apache.calcite.avatica.server.AvaticaHandler</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.avatica.server">org.apache.calcite.avatica.server</a></th>
<td class="colLast">
<div class="block">Avatica server that listens for HTTP requests.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.calcite.avatica.server">
<!-- -->
</a>
<h3>Uses of <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a> in <a href="../package-summary.html">org.apache.calcite.avatica.server</a></h3>
<table class="useSummary">
<caption><span>Subinterfaces of <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a> in <a href="../package-summary.html">org.apache.calcite.avatica.server</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></span></code></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>
</tbody>
</table>
<table class="useSummary">
<caption><span>Classes in <a href="../package-summary.html">org.apache.calcite.avatica.server</a> that implement <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AbstractAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">AbstractAvaticaHandler</a></span></code></th>
<td class="colLast">
<div class="block">Base-class for Avatica implemented Jetty Handlers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AvaticaJsonHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaJsonHandler</a></span></code></th>
<td class="colLast">
<div class="block">Jetty handler that executes Avatica JSON request-responses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaProtobufHandler</a></span></code></th>
<td class="colLast">
<div class="block">Jetty handler that executes Avatica JSON request-responses.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../DelegatingAvaticaHandler.html" title="class in org.apache.calcite.avatica.server">DelegatingAvaticaHandler</a></span></code></th>
<td class="colLast">
<div class="block">An AvaticaHandler implementation that delegates to a provided Jetty Handler instance.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.calcite.avatica.server</a> that return <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method with metrics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization,org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization,
<a href="../../metrics/MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;metricsConfig)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method with metrics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization,org.apache.calcite.avatica.metrics.MetricsSystemConfiguration,org.apache.calcite.avatica.server.AvaticaServerConfiguration)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization,
<a href="../../metrics/MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;metricsConfig,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;serverConfig)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method and server
configuration with metrics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization,org.apache.calcite.avatica.server.AvaticaServerConfiguration)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;serverConfig)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method and server
configuration with metrics.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.calcite.avatica.server</a> with parameters of type <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a>&lt;<a href="../HttpServer.Builder.html" title="type parameter in HttpServer.Builder">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HttpServer.Builder.</span><code><span class="memberNameLink"><a href="../HttpServer.Builder.html#withHandler(org.apache.calcite.avatica.server.AvaticaHandler)">withHandler</a></span>&#8203;(<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Sets an <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server"><code>AvaticaHandler</code></a> directly on the builder.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../package-summary.html">org.apache.calcite.avatica.server</a> with parameters of type <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(int,org.apache.calcite.avatica.server.AvaticaHandler)">HttpServer</a></span>&#8203;(int&nbsp;port,
<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a> with no additional configuration.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(int,org.apache.calcite.avatica.server.AvaticaHandler,org.apache.calcite.avatica.server.AvaticaServerConfiguration)">HttpServer</a></span>&#8203;(int&nbsp;port,
<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(int,org.apache.calcite.avatica.server.AvaticaHandler,org.apache.calcite.avatica.server.AvaticaServerConfiguration,javax.security.auth.Subject)">HttpServer</a></span>&#8203;(int&nbsp;port,
<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;config,
javax.security.auth.Subject&nbsp;subject)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(int,org.apache.calcite.avatica.server.AvaticaHandler,org.apache.calcite.avatica.server.AvaticaServerConfiguration,javax.security.auth.Subject,org.eclipse.jetty.util.ssl.SslContextFactory)">HttpServer</a></span>&#8203;(int&nbsp;port,
<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;config,
javax.security.auth.Subject&nbsp;subject,
org.eclipse.jetty.util.ssl.SslContextFactory&nbsp;sslFactory)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(int,org.apache.calcite.avatica.server.AvaticaHandler,org.apache.calcite.avatica.server.AvaticaServerConfiguration,javax.security.auth.Subject,org.eclipse.jetty.util.ssl.SslContextFactory,int)">HttpServer</a></span>&#8203;(int&nbsp;port,
<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler,
<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;config,
javax.security.auth.Subject&nbsp;subject,
org.eclipse.jetty.util.ssl.SslContextFactory&nbsp;sslFactory,
int&nbsp;maxAllowedHeaderSize)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../HttpServer.html#%3Cinit%3E(org.apache.calcite.avatica.server.AvaticaHandler)">HttpServer</a></span>&#8203;(<a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Constructs an <a href="../HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a> which binds to an ephemeral port.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">Class</a></li>
<li class="navBarCell1Rev">Use</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&nbsp;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 &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>