blob: e3ac2f4ccce9f06f1d3bac71a0ef8e25d00a66a1 [file] [log] [blame]
<!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>AvaticaServerConfiguration (Apache Calcite Avatica 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="AvaticaServerConfiguration (Apache Calcite Avatica calcite-avatica API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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="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 class="aboutLanguage"><b>Apache Calcite Avatica</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/avatica/server/AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/server/AvaticaSpnegoAuthenticator.html" title="class in org.apache.calcite.avatica.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/server/AvaticaServerConfiguration.html" target="_top">Frames</a></li>
<li><a href="AvaticaServerConfiguration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.calcite.avatica.server</div>
<h2 title="Interface AvaticaServerConfiguration" class="title">Interface AvaticaServerConfiguration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AvaticaServerConfiguration</span></pre>
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#doAsRemoteUser-java.lang.String-java.lang.String-java.util.concurrent.Callable-">doAsRemoteUser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteUserName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;T&gt;&nbsp;action)</code>
<div class="block">Invokes the given <code>action</code> as the <code>remoteUserName</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAllowedRoles--">getAllowedRoles</a></span>()</code>
<div class="block">Returns the array of allowed roles for login.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAuthenticationType--">getAuthenticationType</a></span>()</code>
<div class="block">Returns the type of authentication the <a href="../../../../../org/apache/calcite/avatica/server/HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a> should use.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getHashLoginServiceProperties--">getHashLoginServiceProperties</a></span>()</code>
<div class="block">Returns the path to a properties file that contains users and realms.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getHashLoginServiceRealm--">getHashLoginServiceRealm</a></span>()</code>
<div class="block">Returns the name of the realm to use in coordination with the properties files specified
by <a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getHashLoginServiceProperties--"><code>getHashLoginServiceProperties()</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getKerberosPrincipal--">getKerberosPrincipal</a></span>()</code>
<div class="block">Returns the Kerberos principal that the Avatica server should log in as.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getKerberosRealm--">getKerberosRealm</a></span>()</code>
<div class="block">Returns the Kerberos realm to use for the server's login.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getRemoteUserExtractor--">getRemoteUserExtractor</a></span>()</code>
<div class="block">Extract the user this request should execute as.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#supportsImpersonation--">supportsImpersonation</a></span>()</code>
<div class="block">Returns true if the Avatica server should run user requests at that remote user.</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="getAuthenticationType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthenticationType</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a>&nbsp;getAuthenticationType()</pre>
<div class="block">Returns the type of authentication the <a href="../../../../../org/apache/calcite/avatica/server/HttpServer.html" title="class in org.apache.calcite.avatica.server"><code>HttpServer</code></a> should use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An enum corresponding to an authentication mechanism</dd>
</dl>
</li>
</ul>
<a name="getKerberosRealm--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKerberosRealm</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKerberosRealm()</pre>
<div class="block">Returns the Kerberos realm to use for the server's login. Only relevant when
<a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAuthenticationType--"><code>getAuthenticationType()</code></a> returns <a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#SPNEGO"><code>AuthenticationType.SPNEGO</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Kerberos realm for the server login, or null if not applicable.</dd>
</dl>
</li>
</ul>
<a name="getKerberosPrincipal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKerberosPrincipal</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKerberosPrincipal()</pre>
<div class="block">Returns the Kerberos principal that the Avatica server should log in as.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Kerberos principal, or null if not applicable.</dd>
</dl>
</li>
</ul>
<a name="getAllowedRoles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowedRoles</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getAllowedRoles()</pre>
<div class="block">Returns the array of allowed roles for login. Only applicable when
<a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAuthenticationType--"><code>getAuthenticationType()</code></a> returns <a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or
<a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#DIGEST"><code>AuthenticationType.DIGEST</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of allowed login roles, or null.</dd>
</dl>
</li>
</ul>
<a name="getHashLoginServiceRealm--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashLoginServiceRealm</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHashLoginServiceRealm()</pre>
<div class="block">Returns the name of the realm to use in coordination with the properties files specified
by <a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getHashLoginServiceProperties--"><code>getHashLoginServiceProperties()</code></a>. Only applicable when
<a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAuthenticationType--"><code>getAuthenticationType()</code></a> returns <a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or
<a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#DIGEST"><code>AuthenticationType.DIGEST</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A realm for the HashLoginService, or null.</dd>
</dl>
</li>
</ul>
<a name="getHashLoginServiceProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashLoginServiceProperties</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getHashLoginServiceProperties()</pre>
<div class="block">Returns the path to a properties file that contains users and realms. Only applicable when
<a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#getAuthenticationType--"><code>getAuthenticationType()</code></a> returns <a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or
<a href="../../../../../org/apache/calcite/avatica/remote/AuthenticationType.html#DIGEST"><code>AuthenticationType.DIGEST</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A realm for the HashLoginService, or null.</dd>
</dl>
</li>
</ul>
<a name="supportsImpersonation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsImpersonation</h4>
<pre>boolean&nbsp;supportsImpersonation()</pre>
<div class="block">Returns true if the Avatica server should run user requests at that remote user. Otherwise,
all requests are run as the Avatica server user (which is the default).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if impersonation is enabled, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="doAsRemoteUser-java.lang.String-java.lang.String-java.util.concurrent.Callable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doAsRemoteUser</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;doAsRemoteUser(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteUserName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a>&lt;T&gt;&nbsp;action)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Invokes the given <code>action</code> as the <code>remoteUserName</code>. This will only be
invoked if <a href="../../../../../org/apache/calcite/avatica/server/AvaticaServerConfiguration.html#supportsImpersonation--"><code>supportsImpersonation()</code></a> returns <code>true</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>remoteUserName</code> - The remote user making a request to the Avatica server.</dd>
<dd><code>remoteAddress</code> - The address the remote user is making the request from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result from the Callable.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserDisallowedException.html" title="class in org.apache.calcite.avatica.server"><code>to deny a remoteUser access</code></a></dd>
</dl>
</li>
</ul>
<a name="getRemoteUserExtractor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRemoteUserExtractor</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/server/RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a>&nbsp;getRemoteUserExtractor()</pre>
<div class="block">Extract the user this request should execute as.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of the RemoteUserExtractor</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="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 class="aboutLanguage"><b>Apache Calcite Avatica</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/avatica/server/AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/server/AvaticaSpnegoAuthenticator.html" title="class in org.apache.calcite.avatica.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/server/AvaticaServerConfiguration.html" target="_top">Frames</a></li>
<li><a href="AvaticaServerConfiguration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &copy; 2012-2019 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>