| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>BuiltInConnectionProperty (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="BuiltInConnectionProperty (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/BuiltInConnectionProperty.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</a> | </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</a></div> |
| <h2 title="Enum BuiltInConnectionProperty" class="title">Enum BuiltInConnectionProperty</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Enum<<a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.avatica.BuiltInConnectionProperty</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code>java.lang.Comparable<<a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a>></code>, <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public enum <span class="typeNameLabel">BuiltInConnectionProperty</span> |
| extends java.lang.Enum<<a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a>> |
| implements <a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></pre> |
| <div class="block">Enumeration of Avatica's built-in connection properties.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.avatica.ConnectionProperty"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.calcite.avatica.<a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></h3> |
| <code><a href="ConnectionProperty.Type.html" title="enum in org.apache.calcite.avatica">ConnectionProperty.Type</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum Constant</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AUTHENTICATION">AUTHENTICATION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The type of authentication to be used</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AVATICA_PASSWORD">AVATICA_PASSWORD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Avatica-based authentication password</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AVATICA_USER">AVATICA_USER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Avatica-based authentication user name</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FACTORY">FACTORY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HOSTNAME_VERIFICATION">HOSTNAME_VERIFICATION</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HTTP_CLIENT_FACTORY">HTTP_CLIENT_FACTORY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Factory for constructing http clients.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HTTP_CLIENT_IMPL">HTTP_CLIENT_IMPL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">HttpClient implementation class name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#KEY_PASSWORD">KEY_PASSWORD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Password for the key inside keystore</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#KEYSTORE">KEYSTORE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Keystore for MTLS authentication</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#KEYSTORE_PASSWORD">KEYSTORE_PASSWORD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Password for the keystore</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#KEYTAB">KEYTAB</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Keytab to use to perform Kerberos login.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PRINCIPAL">PRINCIPAL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Principal to use to perform Kerberos login.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SCHEMA">SCHEMA</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Name of initial schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SERIALIZATION">SERIALIZATION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Serialization used over remote connections</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TIME_ZONE">TIME_ZONE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Time zone, for example 'gmt-3'.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TRUSTSTORE">TRUSTSTORE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Truststore for SSL/TLS communication</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TRUSTSTORE_PASSWORD">TRUSTSTORE_PASSWORD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Password for the truststore</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#URL">URL</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Remote URL.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TIMEZONE">TIMEZONE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#camelName()">camelName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The name of this property in camel-case.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultValue()">defaultValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default value of this property.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocalProperty(java.lang.Object)">isLocalProperty</a></span>​(java.lang.Object propertyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if the given property only applicable to the remote driver (should not be sent to the |
| Avatica server).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#required()">required</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the property is mandatory.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ConnectionProperty.Type.html" title="enum in org.apache.calcite.avatica">ConnectionProperty.Type</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#type()">type</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the data type of this property.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Class</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueClass()">valueClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Class of values that this property can take.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ConnectionConfigImpl.PropEnv.html" title="class in org.apache.calcite.avatica">ConnectionConfigImpl.PropEnv</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrap(java.util.Properties)">wrap</a></span>​(java.util.Properties properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Wraps this property with a properties object from which its value can be |
| obtained when needed.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Enum</h3> |
| <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.ConnectionProperty"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.calcite.avatica.<a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></h3> |
| <code><a href="ConnectionProperty.html#name()">name</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a id="FACTORY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FACTORY</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> FACTORY</pre> |
| <div class="block">Factory.</div> |
| </li> |
| </ul> |
| <a id="SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCHEMA</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> SCHEMA</pre> |
| <div class="block">Name of initial schema.</div> |
| </li> |
| </ul> |
| <a id="TIME_ZONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIME_ZONE</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> TIME_ZONE</pre> |
| <div class="block">Time zone, for example 'gmt-3'. Default is the JVM's time zone.</div> |
| </li> |
| </ul> |
| <a id="URL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>URL</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> URL</pre> |
| <div class="block">Remote URL.</div> |
| </li> |
| </ul> |
| <a id="SERIALIZATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERIALIZATION</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> SERIALIZATION</pre> |
| <div class="block">Serialization used over remote connections</div> |
| </li> |
| </ul> |
| <a id="AUTHENTICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AUTHENTICATION</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> AUTHENTICATION</pre> |
| <div class="block">The type of authentication to be used</div> |
| </li> |
| </ul> |
| <a id="AVATICA_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AVATICA_USER</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> AVATICA_USER</pre> |
| <div class="block">Avatica-based authentication user name</div> |
| </li> |
| </ul> |
| <a id="AVATICA_PASSWORD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AVATICA_PASSWORD</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> AVATICA_PASSWORD</pre> |
| <div class="block">Avatica-based authentication password</div> |
| </li> |
| </ul> |
| <a id="HTTP_CLIENT_FACTORY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HTTP_CLIENT_FACTORY</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> HTTP_CLIENT_FACTORY</pre> |
| <div class="block">Factory for constructing http clients.</div> |
| </li> |
| </ul> |
| <a id="HTTP_CLIENT_IMPL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HTTP_CLIENT_IMPL</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> HTTP_CLIENT_IMPL</pre> |
| <div class="block">HttpClient implementation class name.</div> |
| </li> |
| </ul> |
| <a id="PRINCIPAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PRINCIPAL</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> PRINCIPAL</pre> |
| <div class="block">Principal to use to perform Kerberos login.</div> |
| </li> |
| </ul> |
| <a id="KEYTAB"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KEYTAB</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> KEYTAB</pre> |
| <div class="block">Keytab to use to perform Kerberos login.</div> |
| </li> |
| </ul> |
| <a id="TRUSTSTORE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRUSTSTORE</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> TRUSTSTORE</pre> |
| <div class="block">Truststore for SSL/TLS communication</div> |
| </li> |
| </ul> |
| <a id="TRUSTSTORE_PASSWORD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRUSTSTORE_PASSWORD</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> TRUSTSTORE_PASSWORD</pre> |
| <div class="block">Password for the truststore</div> |
| </li> |
| </ul> |
| <a id="KEYSTORE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KEYSTORE</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> KEYSTORE</pre> |
| <div class="block">Keystore for MTLS authentication</div> |
| </li> |
| </ul> |
| <a id="KEYSTORE_PASSWORD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KEYSTORE_PASSWORD</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> KEYSTORE_PASSWORD</pre> |
| <div class="block">Password for the keystore</div> |
| </li> |
| </ul> |
| <a id="KEY_PASSWORD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KEY_PASSWORD</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> KEY_PASSWORD</pre> |
| <div class="block">Password for the key inside keystore</div> |
| </li> |
| </ul> |
| <a id="HOSTNAME_VERIFICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HOSTNAME_VERIFICATION</h4> |
| <pre>public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> HOSTNAME_VERIFICATION</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="TIMEZONE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TIMEZONE</h4> |
| <pre>@Deprecated |
| public static final <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> TIMEZONE</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Deprecated; use <a href="#TIME_ZONE"><code>TIME_ZONE</code></a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="values()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre class="methodSignature">public static <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (BuiltInConnectionProperty c : BuiltInConnectionProperty.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre class="methodSignature">public static <a href="BuiltInConnectionProperty.html" title="enum in org.apache.calcite.avatica">BuiltInConnectionProperty</a> valueOf​(java.lang.String name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> |
| <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="camelName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>camelName</h4> |
| <pre class="methodSignature">public java.lang.String camelName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#camelName()">ConnectionProperty</a></code></span></div> |
| <div class="block">The name of this property in camel-case. |
| (E.g. "materializationsEnabled".)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#camelName()">camelName</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="defaultValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre class="methodSignature">public java.lang.Object defaultValue()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#defaultValue()">ConnectionProperty</a></code></span></div> |
| <div class="block">Returns the default value of this property. The type must match its data |
| type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#defaultValue()">defaultValue</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="type()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre class="methodSignature">public <a href="ConnectionProperty.Type.html" title="enum in org.apache.calcite.avatica">ConnectionProperty.Type</a> type()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#type()">ConnectionProperty</a></code></span></div> |
| <div class="block">Returns the data type of this property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#type()">type</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="required()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>required</h4> |
| <pre class="methodSignature">public boolean required()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#required()">ConnectionProperty</a></code></span></div> |
| <div class="block">Whether the property is mandatory.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#required()">required</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueClass</h4> |
| <pre class="methodSignature">public java.lang.Class valueClass()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#valueClass()">ConnectionProperty</a></code></span></div> |
| <div class="block">Class of values that this property can take. Most useful for |
| <a href="ConnectionProperty.Type.html#ENUM"><code>ConnectionProperty.Type.ENUM</code></a> properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#valueClass()">valueClass</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="wrap(java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public <a href="ConnectionConfigImpl.PropEnv.html" title="class in org.apache.calcite.avatica">ConnectionConfigImpl.PropEnv</a> wrap​(java.util.Properties properties)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ConnectionProperty.html#wrap(java.util.Properties)">ConnectionProperty</a></code></span></div> |
| <div class="block">Wraps this property with a properties object from which its value can be |
| obtained when needed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ConnectionProperty.html#wrap(java.util.Properties)">wrap</a></code> in interface <code><a href="ConnectionProperty.html" title="interface in org.apache.calcite.avatica">ConnectionProperty</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLocalProperty(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isLocalProperty</h4> |
| <pre class="methodSignature">public static boolean isLocalProperty​(java.lang.Object propertyName)</pre> |
| <div class="block">Checks if the given property only applicable to the remote driver (should not be sent to the |
| Avatica server).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - Name of the property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the property denoted by the given name is only relevant locally, otherwise |
| false.</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/BuiltInConnectionProperty.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</a> | </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> |