Google Git
Sign in
apache / calcite-site / 86a9751a303872bad8b062b0a727a3375ad9eaa7 / . / avatica / apidocs / org / apache / calcite / avatica / server / class-use / HttpServer.Builder.html
blob: 0c43b40ed267a56803bf5a003f904ce02194caab [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Class org.apache.calcite.avatica.server.HttpServer.Builder (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 Class org.apache.calcite.avatica.server.HttpServer.Builder (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="../HttpServer.Builder.html" title="class 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 Class org.apache.calcite.avatica.server.HttpServer.Builder" class="title">Uses of Class<br>org.apache.calcite.avatica.server.HttpServer.Builder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</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="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a> in <a href="../package-summary.html">org.apache.calcite.avatica.server</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.calcite.avatica.server</a> that return <a href="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</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>static &lt;T&gt;&nbsp;<a href="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HttpServer.Builder.</span><code><span class="memberNameLink"><a href="../HttpServer.Builder.html#newBuilder()">newBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a typed Builder for Server customization.</div>
</td>
</tr>
<tr class="rowColor">
<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#withAutomaticLogin(java.io.File)">withAutomaticLogin</a></span>&#8203;(java.io.File&nbsp;keytab)</code></th>
<td class="colLast">
<div class="block">Sets a keytab to be used to perform a Kerberos login automatically (without the use of JAAS).</div>
</td>
</tr>
<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#withBasicAuthentication(java.lang.String,java.lang.String%5B%5D)">withBasicAuthentication</a></span>&#8203;(java.lang.String&nbsp;properties,
java.lang.String[]&nbsp;allowedRoles)</code></th>
<td class="colLast">
<div class="block">Configures the server to use HTTP Basic authentication.</div>
</td>
</tr>
<tr class="rowColor">
<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#withCustomAuthentication(org.apache.calcite.avatica.server.AvaticaServerConfiguration)">withCustomAuthentication</a></span>&#8203;(<a href="../AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Configures the server to use CUSTOM authentication mechanism, which can allow users to
combine benefits of multiple auth methods.</div>
</td>
</tr>
<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#withDigestAuthentication(java.lang.String,java.lang.String%5B%5D)">withDigestAuthentication</a></span>&#8203;(java.lang.String&nbsp;properties,
java.lang.String[]&nbsp;allowedRoles)</code></th>
<td class="colLast">
<div class="block">Configures the server to use HTTP Digest authentication.</div>
</td>
</tr>
<tr class="rowColor">
<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.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization)">withHandler</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">Sets the <a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote"><code>Service</code></a> and <a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote"><code>Driver.Serialization</code></a> information necessary to construct
the appropriate <a href="../AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server"><code>AvaticaHandler</code></a>.</div>
</td>
</tr>
<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>
<tr class="rowColor">
<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#withImpersonation(org.apache.calcite.avatica.server.DoAsRemoteUserCallback)">withImpersonation</a></span>&#8203;(<a href="../DoAsRemoteUserCallback.html" title="interface in org.apache.calcite.avatica.server">DoAsRemoteUserCallback</a>&nbsp;remoteUserCallback)</code></th>
<td class="colLast">
<div class="block">Sets a callback implementation to defer the logic on how to run an action as a given user and
if the action should be permitted for that user.</div>
</td>
</tr>
<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#withMaxHeaderSize(int)">withMaxHeaderSize</a></span>&#8203;(int&nbsp;maxHeaderSize)</code></th>
<td class="colLast">
<div class="block">Configures the maximum size, in bytes, of an HTTP header that the server will read.</div>
</td>
</tr>
<tr class="rowColor">
<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#withMetricsConfiguration(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">withMetricsConfiguration</a></span>&#8203;(<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">Sets the given configuration to enable metrics collection in the server.</div>
</td>
</tr>
<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#withPort(int)">withPort</a></span>&#8203;(int&nbsp;port)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HttpServer.Builder.</span><code><span class="memberNameLink"><a href="../HttpServer.Builder.html#withRemoteUserExtractor(org.apache.calcite.avatica.server.RemoteUserExtractor)">withRemoteUserExtractor</a></span>&#8203;(<a href="../RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a>&nbsp;remoteUserExtractor)</code></th>
<td class="colLast">
<div class="block">Sets a callback implementation to defer the logic on how to use the right remoteUserExtractor
to extract remote user.</div>
</td>
</tr>
<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#withServerCustomizers(java.util.List,java.lang.Class)">withServerCustomizers</a></span>&#8203;(java.util.List&lt;<a href="../ServerCustomizer.html" title="interface in org.apache.calcite.avatica.server">ServerCustomizer</a>&lt;<a href="../HttpServer.Builder.html" title="type parameter in HttpServer.Builder">T</a>&gt;&gt;&nbsp;serverCustomizers,
java.lang.Class&lt;<a href="../HttpServer.Builder.html" title="type parameter in HttpServer.Builder">T</a>&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Adds customizers to configure a Server before startup.</div>
</td>
</tr>
<tr class="rowColor">
<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#withSpnego(java.lang.String)">withSpnego</a></span>&#8203;(java.lang.String&nbsp;principal)</code></th>
<td class="colLast">
<div class="block">Configures the server to use SPNEGO authentication.</div>
</td>
</tr>
<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#withSpnego(java.lang.String,java.lang.String)">withSpnego</a></span>&#8203;(java.lang.String&nbsp;principal,
java.lang.String&nbsp;realm)</code></th>
<td class="colLast">
<div class="block">Configures the server to use SPNEGO authentication.</div>
</td>
</tr>
<tr class="rowColor">
<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#withSpnego(java.lang.String,java.lang.String%5B%5D)">withSpnego</a></span>&#8203;(java.lang.String&nbsp;principal,
java.lang.String[]&nbsp;additionalAllowedRealms)</code></th>
<td class="colLast">
<div class="block">Configures the server to use SPNEGO authentication.</div>
</td>
</tr>
<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#withSpnego(java.lang.String,java.lang.String,java.lang.String%5B%5D)">withSpnego</a></span>&#8203;(java.lang.String&nbsp;principal,
java.lang.String&nbsp;realm,
java.lang.String[]&nbsp;additionalAllowedRealms)</code></th>
<td class="colLast">
<div class="block">Configures the server to use SPNEGO authentication.</div>
</td>
</tr>
<tr class="rowColor">
<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#withTLS(java.io.File,java.lang.String,java.io.File,java.lang.String)">withTLS</a></span>&#8203;(java.io.File&nbsp;keystore,
java.lang.String&nbsp;keystorePassword,
java.io.File&nbsp;truststore,
java.lang.String&nbsp;truststorePassword)</code></th>
<td class="colLast">
<div class="block">Configures the server to use TLS for wire encryption.</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="../HttpServer.Builder.html" title="class 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>