| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AvaticaServerConfiguration (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="AvaticaServerConfiguration (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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"; |
| 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AvaticaServerConfiguration.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.avatica.server</a></div> |
| <h2 title="Interface AvaticaServerConfiguration" class="title">Interface AvaticaServerConfiguration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <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="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 =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doAsRemoteUser(java.lang.String,java.lang.String,java.util.concurrent.Callable)">doAsRemoteUser</a></span>​(java.lang.String remoteUserName, |
| java.lang.String remoteAddress, |
| java.util.concurrent.Callable<T> action)</code></th> |
| <td class="colLast"> |
| <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>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowedRoles()">getAllowedRoles</a></span>()</code></th> |
| <td class="colLast"> |
| <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="../remote/AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationType()">getAuthenticationType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of authentication the <a href="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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHashLoginServiceProperties()">getHashLoginServiceProperties</a></span>()</code></th> |
| <td class="colLast"> |
| <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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHashLoginServiceRealm()">getHashLoginServiceRealm</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of the realm to use in coordination with the properties files specified |
| by <a href="#getHashLoginServiceProperties()"><code>getHashLoginServiceProperties()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKerberosPrincipal()">getKerberosPrincipal</a></span>()</code></th> |
| <td class="colLast"> |
| <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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKerberosRealm()">getKerberosRealm</a></span>()</code></th> |
| <td class="colLast"> |
| <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="RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteUserExtractor()">getRemoteUserExtractor</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportsImpersonation()">supportsImpersonation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the Avatica server should run user requests at that remote user.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getAuthenticationType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationType</h4> |
| <pre class="methodSignature"><a href="../remote/AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a> getAuthenticationType()</pre> |
| <div class="block">Returns the type of authentication the <a href="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 id="getKerberosRealm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKerberosRealm</h4> |
| <pre class="methodSignature">java.lang.String getKerberosRealm()</pre> |
| <div class="block">Returns the Kerberos realm to use for the server's login. Only relevant when |
| <a href="#getAuthenticationType()"><code>getAuthenticationType()</code></a> returns <a href="../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 id="getKerberosPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKerberosPrincipal</h4> |
| <pre class="methodSignature">java.lang.String 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 id="getAllowedRoles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowedRoles</h4> |
| <pre class="methodSignature">java.lang.String[] getAllowedRoles()</pre> |
| <div class="block">Returns the array of allowed roles for login. Only applicable when |
| <a href="#getAuthenticationType()"><code>getAuthenticationType()</code></a> returns <a href="../remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or |
| <a href="../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 id="getHashLoginServiceRealm()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHashLoginServiceRealm</h4> |
| <pre class="methodSignature">java.lang.String getHashLoginServiceRealm()</pre> |
| <div class="block">Returns the name of the realm to use in coordination with the properties files specified |
| by <a href="#getHashLoginServiceProperties()"><code>getHashLoginServiceProperties()</code></a>. Only applicable when |
| <a href="#getAuthenticationType()"><code>getAuthenticationType()</code></a> returns <a href="../remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or |
| <a href="../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 id="getHashLoginServiceProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHashLoginServiceProperties</h4> |
| <pre class="methodSignature">java.lang.String getHashLoginServiceProperties()</pre> |
| <div class="block">Returns the path to a properties file that contains users and realms. Only applicable when |
| <a href="#getAuthenticationType()"><code>getAuthenticationType()</code></a> returns <a href="../remote/AuthenticationType.html#BASIC"><code>AuthenticationType.BASIC</code></a> or |
| <a href="../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 id="supportsImpersonation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsImpersonation</h4> |
| <pre class="methodSignature">boolean 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 id="doAsRemoteUser(java.lang.String,java.lang.String,java.util.concurrent.Callable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doAsRemoteUser</h4> |
| <pre class="methodSignature"><T> T doAsRemoteUser​(java.lang.String remoteUserName, |
| java.lang.String remoteAddress, |
| java.util.concurrent.Callable<T> action) |
| throws java.lang.Exception</pre> |
| <div class="block">Invokes the given <code>action</code> as the <code>remoteUserName</code>. This will only be |
| invoked if <a href="#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>java.lang.Exception</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="RemoteUserDisallowedException.html" title="class in org.apache.calcite.avatica.server"><code>to deny a remoteUser access</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteUserExtractor()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRemoteUserExtractor</h4> |
| <pre class="methodSignature"><a href="RemoteUserExtractor.html" title="interface in org.apache.calcite.avatica.server">RemoteUserExtractor</a> 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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AvaticaServerConfiguration.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
