blob: 422a67ef56c2cbecb9b7c153d97640247f500a47 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ConnectionConfig (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="ConnectionConfig (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,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":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/ConnectionConfig.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&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>
<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 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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.avatica</a></div>
<h2 title="Interface ConnectionConfig" class="title">Interface ConnectionConfig</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="remote/AvaticaRemoteConnectionConfigImpl.html" title="class in org.apache.calcite.avatica.remote">AvaticaRemoteConnectionConfigImpl</a></code>, <code><a href="ConnectionConfigImpl.html" title="class in org.apache.calcite.avatica">ConnectionConfigImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ConnectionConfig</span></pre>
<div class="block">Connection configuration.</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">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authentication()">authentication</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#avaticaPassword()">avaticaPassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#avaticaUser()">avaticaUser</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="remote/Service.Factory.html" title="interface in org.apache.calcite.avatica.remote">Service.Factory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#factory()">factory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="remote/HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hostnameVerification()">hostnameVerification</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#httpClientClass()">httpClientClass</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="remote/AvaticaHttpClientFactory.html" title="interface in org.apache.calcite.avatica.remote">AvaticaHttpClientFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#httpClientFactory()">httpClientFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#kerberosKeytab()">kerberosKeytab</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#kerberosPrincipal()">kerberosPrincipal</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyPassword()">keyPassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keystore()">keystore</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keystorePassword()">keystorePassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schema()">schema</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serialization()">serialization</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timeZone()">timeZone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truststore()">truststore</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truststorePassword()">truststorePassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#url()">url</a></span>()</code></th>
<td class="colLast">&nbsp;</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="schema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre class="methodSignature">java.lang.String&nbsp;schema()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#SCHEMA"><code>BuiltInConnectionProperty.SCHEMA</code></a></dd>
</dl>
</li>
</ul>
<a id="timeZone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeZone</h4>
<pre class="methodSignature">java.lang.String&nbsp;timeZone()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#TIME_ZONE"><code>BuiltInConnectionProperty.TIME_ZONE</code></a></dd>
</dl>
</li>
</ul>
<a id="factory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factory</h4>
<pre class="methodSignature"><a href="remote/Service.Factory.html" title="interface in org.apache.calcite.avatica.remote">Service.Factory</a>&nbsp;factory()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#FACTORY"><code>BuiltInConnectionProperty.FACTORY</code></a></dd>
</dl>
</li>
</ul>
<a id="url()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>url</h4>
<pre class="methodSignature">java.lang.String&nbsp;url()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#URL"><code>BuiltInConnectionProperty.URL</code></a></dd>
</dl>
</li>
</ul>
<a id="serialization()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialization</h4>
<pre class="methodSignature">java.lang.String&nbsp;serialization()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#SERIALIZATION"><code>BuiltInConnectionProperty.SERIALIZATION</code></a></dd>
</dl>
</li>
</ul>
<a id="authentication()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authentication</h4>
<pre class="methodSignature">java.lang.String&nbsp;authentication()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#AUTHENTICATION"><code>BuiltInConnectionProperty.AUTHENTICATION</code></a></dd>
</dl>
</li>
</ul>
<a id="avaticaUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>avaticaUser</h4>
<pre class="methodSignature">java.lang.String&nbsp;avaticaUser()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#AVATICA_USER"><code>BuiltInConnectionProperty.AVATICA_USER</code></a></dd>
</dl>
</li>
</ul>
<a id="avaticaPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>avaticaPassword</h4>
<pre class="methodSignature">java.lang.String&nbsp;avaticaPassword()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#AVATICA_PASSWORD"><code>BuiltInConnectionProperty.AVATICA_PASSWORD</code></a></dd>
</dl>
</li>
</ul>
<a id="httpClientFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpClientFactory</h4>
<pre class="methodSignature"><a href="remote/AvaticaHttpClientFactory.html" title="interface in org.apache.calcite.avatica.remote">AvaticaHttpClientFactory</a>&nbsp;httpClientFactory()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#HTTP_CLIENT_FACTORY"><code>BuiltInConnectionProperty.HTTP_CLIENT_FACTORY</code></a></dd>
</dl>
</li>
</ul>
<a id="httpClientClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpClientClass</h4>
<pre class="methodSignature">java.lang.String&nbsp;httpClientClass()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#HTTP_CLIENT_IMPL"><code>BuiltInConnectionProperty.HTTP_CLIENT_IMPL</code></a></dd>
</dl>
</li>
</ul>
<a id="kerberosPrincipal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>kerberosPrincipal</h4>
<pre class="methodSignature">java.lang.String&nbsp;kerberosPrincipal()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#PRINCIPAL"><code>BuiltInConnectionProperty.PRINCIPAL</code></a></dd>
</dl>
</li>
</ul>
<a id="kerberosKeytab()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>kerberosKeytab</h4>
<pre class="methodSignature">java.io.File&nbsp;kerberosKeytab()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#KEYTAB"><code>BuiltInConnectionProperty.KEYTAB</code></a></dd>
</dl>
</li>
</ul>
<a id="truststore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truststore</h4>
<pre class="methodSignature">java.io.File&nbsp;truststore()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#TRUSTSTORE"><code>BuiltInConnectionProperty.TRUSTSTORE</code></a></dd>
</dl>
</li>
</ul>
<a id="truststorePassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truststorePassword</h4>
<pre class="methodSignature">java.lang.String&nbsp;truststorePassword()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#TRUSTSTORE_PASSWORD"><code>BuiltInConnectionProperty.TRUSTSTORE_PASSWORD</code></a></dd>
</dl>
</li>
</ul>
<a id="keystore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keystore</h4>
<pre class="methodSignature">java.io.File&nbsp;keystore()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#KEYSTORE"><code>BuiltInConnectionProperty.KEYSTORE</code></a></dd>
</dl>
</li>
</ul>
<a id="keystorePassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keystorePassword</h4>
<pre class="methodSignature">java.lang.String&nbsp;keystorePassword()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#KEYSTORE_PASSWORD"><code>BuiltInConnectionProperty.KEYSTORE_PASSWORD</code></a></dd>
</dl>
</li>
</ul>
<a id="keyPassword()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyPassword</h4>
<pre class="methodSignature">java.lang.String&nbsp;keyPassword()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#KEY_PASSWORD"><code>BuiltInConnectionProperty.KEY_PASSWORD</code></a></dd>
</dl>
</li>
</ul>
<a id="hostnameVerification()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hostnameVerification</h4>
<pre class="methodSignature"><a href="remote/HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a>&nbsp;hostnameVerification()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="BuiltInConnectionProperty.html#HOSTNAME_VERIFICATION"><code>BuiltInConnectionProperty.HOSTNAME_VERIFICATION</code></a></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/ConnectionConfig.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&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>
<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 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>