| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AvaticaCommonsHttpClientImpl (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="AvaticaCommonsHttpClientImpl (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All 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/AvaticaCommonsHttpClientImpl.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="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</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.remote</a></div> |
| <h2 title="Class AvaticaCommonsHttpClientImpl" class="title">Class AvaticaCommonsHttpClientImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.avatica.remote.AvaticaCommonsHttpClientImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="AvaticaHttpClient.html" title="interface in org.apache.calcite.avatica.remote">AvaticaHttpClient</a></code>, <code><a href="HostnameVerificationConfigurable.html" title="interface in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable</a></code>, <code><a href="KeyStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">KeyStoreConfigurable</a></code>, <code><a href="TrustStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">TrustStoreConfigurable</a></code>, <code><a href="UsernamePasswordAuthenticateable.html" title="interface in org.apache.calcite.avatica.remote">UsernamePasswordAuthenticateable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">AvaticaCommonsHttpClientImpl</span> |
| extends java.lang.Object |
| implements <a href="AvaticaHttpClient.html" title="interface in org.apache.calcite.avatica.remote">AvaticaHttpClient</a>, <a href="UsernamePasswordAuthenticateable.html" title="interface in org.apache.calcite.avatica.remote">UsernamePasswordAuthenticateable</a>, <a href="TrustStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">TrustStoreConfigurable</a>, <a href="KeyStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">KeyStoreConfigurable</a>, <a href="HostnameVerificationConfigurable.html" title="interface in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable</a></pre> |
| <div class="block">A common class to invoke HTTP requests against the Avatica server agnostic of the data being |
| sent and received across the wire.</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.remote.HostnameVerificationConfigurable"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.calcite.avatica.remote.<a href="HostnameVerificationConfigurable.html" title="interface in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable</a></h3> |
| <code><a href="HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a></code></li> |
| </ul> |
| </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>protected org.apache.http.impl.client.BasicAuthCache</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authCache">authCache</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#authRegistry">authRegistry</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.http.impl.client.CloseableHttpClient</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client">client</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.auth.UsernamePasswordCredentials</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#credentials">credentials</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.http.client.CredentialsProvider</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#credentialsProvider">credentialsProvider</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.HttpHost</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#host">host</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="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"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected 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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected 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"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected 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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.http.impl.conn.PoolingHttpClientConnectionManager</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pool">pool</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#socketFactoryRegistry">socketFactoryRegistry</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected 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"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected 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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#uri">uri</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userToken">userToken</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.net.URL)">AvaticaCommonsHttpClientImpl</a></span>​(java.net.URL url)</code></th> |
| <td class="colLast"> </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="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>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureConnectionPool(org.apache.http.config.Registry)">configureConnectionPool</a></span>​(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureHttpRegistry(org.apache.http.config.RegistryBuilder)">configureHttpRegistry</a></span>​(org.apache.http.config.RegistryBuilder<org.apache.http.conn.socket.ConnectionSocketFactory> registryBuilder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureHttpsRegistry(org.apache.http.config.RegistryBuilder)">configureHttpsRegistry</a></span>​(org.apache.http.config.RegistryBuilder<org.apache.http.conn.socket.ConnectionSocketFactory> registryBuilder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureSocketFactories()">configureSocketFactories</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadKeyStore(org.apache.http.ssl.SSLContextBuilder)">loadKeyStore</a></span>​(org.apache.http.ssl.SSLContextBuilder sslContextBuilder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadTrustStore(org.apache.http.ssl.SSLContextBuilder)">loadTrustStore</a></span>​(org.apache.http.ssl.SSLContextBuilder sslContextBuilder)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(byte%5B%5D)">send</a></span>​(byte[] request)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends a serialized request to the Avatica server.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHostnameVerification(org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification)">setHostnameVerification</a></span>​(<a href="HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a> verification)</code></th> |
| <td class="colLast"> |
| <div class="block">Instructs the <a href="AvaticaHttpClient.html" title="interface in org.apache.calcite.avatica.remote"><code>AvaticaHttpClient</code></a> how to perform hostname verification for SSL |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyStore(java.io.File,java.lang.String,java.lang.String)">setKeyStore</a></span>​(java.io.File keystore, |
| java.lang.String keystorepassword, |
| java.lang.String keypassword)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a keystore containing the collection of client side certificates |
| to use for HTTPS mutual authentication along with |
| password for keystore and password for key</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTrustStore(java.io.File,java.lang.String)">setTrustStore</a></span>​(java.io.File truststore, |
| java.lang.String password)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a truststore containing the collection of trust SSL/TLS server certificates |
| to use for HTTPS calls and the password for that truststore.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUsernamePassword(org.apache.calcite.avatica.remote.AuthenticationType,java.lang.String,java.lang.String)">setUsernamePassword</a></span>​(<a href="AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a> authType, |
| java.lang.String username, |
| java.lang.String password)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the username, password and method to be used for authentication.</div> |
| </td> |
| </tr> |
| </table> |
| <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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="host"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>host</h4> |
| <pre>protected final org.apache.http.HttpHost host</pre> |
| </li> |
| </ul> |
| <a id="uri"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uri</h4> |
| <pre>protected final java.net.URI uri</pre> |
| </li> |
| </ul> |
| <a id="authCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authCache</h4> |
| <pre>protected org.apache.http.impl.client.BasicAuthCache authCache</pre> |
| </li> |
| </ul> |
| <a id="client"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>client</h4> |
| <pre>protected org.apache.http.impl.client.CloseableHttpClient client</pre> |
| </li> |
| </ul> |
| <a id="socketFactoryRegistry"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>socketFactoryRegistry</h4> |
| <pre>protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> socketFactoryRegistry</pre> |
| </li> |
| </ul> |
| <a id="pool"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pool</h4> |
| <pre>protected org.apache.http.impl.conn.PoolingHttpClientConnectionManager pool</pre> |
| </li> |
| </ul> |
| <a id="credentials"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>credentials</h4> |
| <pre>protected org.apache.http.auth.UsernamePasswordCredentials credentials</pre> |
| </li> |
| </ul> |
| <a id="credentialsProvider"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>credentialsProvider</h4> |
| <pre>protected org.apache.http.client.CredentialsProvider credentialsProvider</pre> |
| </li> |
| </ul> |
| <a id="authRegistry"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authRegistry</h4> |
| <pre>protected org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider> authRegistry</pre> |
| </li> |
| </ul> |
| <a id="userToken"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>userToken</h4> |
| <pre>protected java.lang.Object userToken</pre> |
| </li> |
| </ul> |
| <a id="truststore"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>truststore</h4> |
| <pre>protected java.io.File truststore</pre> |
| </li> |
| </ul> |
| <a id="keystore"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keystore</h4> |
| <pre>protected java.io.File keystore</pre> |
| </li> |
| </ul> |
| <a id="truststorePassword"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>truststorePassword</h4> |
| <pre>protected java.lang.String truststorePassword</pre> |
| </li> |
| </ul> |
| <a id="keystorePassword"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keystorePassword</h4> |
| <pre>protected java.lang.String keystorePassword</pre> |
| </li> |
| </ul> |
| <a id="keyPassword"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keyPassword</h4> |
| <pre>protected java.lang.String keyPassword</pre> |
| </li> |
| </ul> |
| <a id="hostnameVerification"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hostnameVerification</h4> |
| <pre>protected <a href="HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a> hostnameVerification</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.net.URL)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AvaticaCommonsHttpClientImpl</h4> |
| <pre>public AvaticaCommonsHttpClientImpl​(java.net.URL url)</pre> |
| </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="configureConnectionPool(org.apache.http.config.Registry)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureConnectionPool</h4> |
| <pre class="methodSignature">protected void configureConnectionPool​(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> registry)</pre> |
| </li> |
| </ul> |
| <a id="configureSocketFactories()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureSocketFactories</h4> |
| <pre class="methodSignature">protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> configureSocketFactories()</pre> |
| </li> |
| </ul> |
| <a id="configureHttpsRegistry(org.apache.http.config.RegistryBuilder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureHttpsRegistry</h4> |
| <pre class="methodSignature">protected void configureHttpsRegistry​(org.apache.http.config.RegistryBuilder<org.apache.http.conn.socket.ConnectionSocketFactory> registryBuilder)</pre> |
| </li> |
| </ul> |
| <a id="loadKeyStore(org.apache.http.ssl.SSLContextBuilder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadKeyStore</h4> |
| <pre class="methodSignature">protected void loadKeyStore​(org.apache.http.ssl.SSLContextBuilder sslContextBuilder) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadTrustStore(org.apache.http.ssl.SSLContextBuilder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTrustStore</h4> |
| <pre class="methodSignature">protected void loadTrustStore​(org.apache.http.ssl.SSLContextBuilder sslContextBuilder) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configureHttpRegistry(org.apache.http.config.RegistryBuilder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureHttpRegistry</h4> |
| <pre class="methodSignature">protected void configureHttpRegistry​(org.apache.http.config.RegistryBuilder<org.apache.http.conn.socket.ConnectionSocketFactory> registryBuilder)</pre> |
| </li> |
| </ul> |
| <a id="send(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public byte[] send​(byte[] request)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="AvaticaHttpClient.html#send(byte%5B%5D)">AvaticaHttpClient</a></code></span></div> |
| <div class="block">Sends a serialized request to the Avatica server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AvaticaHttpClient.html#send(byte%5B%5D)">send</a></code> in interface <code><a href="AvaticaHttpClient.html" title="interface in org.apache.calcite.avatica.remote">AvaticaHttpClient</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The serialized request.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The serialized response.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUsernamePassword(org.apache.calcite.avatica.remote.AuthenticationType,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsernamePassword</h4> |
| <pre class="methodSignature">public void setUsernamePassword​(<a href="AuthenticationType.html" title="enum in org.apache.calcite.avatica.remote">AuthenticationType</a> authType, |
| java.lang.String username, |
| java.lang.String password)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="UsernamePasswordAuthenticateable.html#setUsernamePassword(org.apache.calcite.avatica.remote.AuthenticationType,java.lang.String,java.lang.String)">UsernamePasswordAuthenticateable</a></code></span></div> |
| <div class="block">Sets the username, password and method to be used for authentication.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="UsernamePasswordAuthenticateable.html#setUsernamePassword(org.apache.calcite.avatica.remote.AuthenticationType,java.lang.String,java.lang.String)">setUsernamePassword</a></code> in interface <code><a href="UsernamePasswordAuthenticateable.html" title="interface in org.apache.calcite.avatica.remote">UsernamePasswordAuthenticateable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authType</code> - Type of authentication</dd> |
| <dd><code>username</code> - Username</dd> |
| <dd><code>password</code> - Password</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTrustStore(java.io.File,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTrustStore</h4> |
| <pre class="methodSignature">public void setTrustStore​(java.io.File truststore, |
| java.lang.String password)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TrustStoreConfigurable.html#setTrustStore(java.io.File,java.lang.String)">TrustStoreConfigurable</a></code></span></div> |
| <div class="block">Sets a truststore containing the collection of trust SSL/TLS server certificates |
| to use for HTTPS calls and the password for that truststore.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TrustStoreConfigurable.html#setTrustStore(java.io.File,java.lang.String)">setTrustStore</a></code> in interface <code><a href="TrustStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">TrustStoreConfigurable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>truststore</code> - The truststore on the local filesystem</dd> |
| <dd><code>password</code> - The truststore's password</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setKeyStore(java.io.File,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyStore</h4> |
| <pre class="methodSignature">public void setKeyStore​(java.io.File keystore, |
| java.lang.String keystorepassword, |
| java.lang.String keypassword)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="KeyStoreConfigurable.html#setKeyStore(java.io.File,java.lang.String,java.lang.String)">KeyStoreConfigurable</a></code></span></div> |
| <div class="block">Sets a keystore containing the collection of client side certificates |
| to use for HTTPS mutual authentication along with |
| password for keystore and password for key</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="KeyStoreConfigurable.html#setKeyStore(java.io.File,java.lang.String,java.lang.String)">setKeyStore</a></code> in interface <code><a href="KeyStoreConfigurable.html" title="interface in org.apache.calcite.avatica.remote">KeyStoreConfigurable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keystore</code> - The keystore on the local filesystem</dd> |
| <dd><code>keystorepassword</code> - The keystore's password</dd> |
| <dd><code>keypassword</code> - The key's password</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHostnameVerification(org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setHostnameVerification</h4> |
| <pre class="methodSignature">public void setHostnameVerification​(<a href="HostnameVerificationConfigurable.HostnameVerification.html" title="enum in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable.HostnameVerification</a> verification)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="HostnameVerificationConfigurable.html#setHostnameVerification(org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification)">HostnameVerificationConfigurable</a></code></span></div> |
| <div class="block">Instructs the <a href="AvaticaHttpClient.html" title="interface in org.apache.calcite.avatica.remote"><code>AvaticaHttpClient</code></a> how to perform hostname verification for SSL |
| connections.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="HostnameVerificationConfigurable.html#setHostnameVerification(org.apache.calcite.avatica.remote.HostnameVerificationConfigurable.HostnameVerification)">setHostnameVerification</a></code> in interface <code><a href="HostnameVerificationConfigurable.html" title="interface in org.apache.calcite.avatica.remote">HostnameVerificationConfigurable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>verification</code> - The mode of hostname verification</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/AvaticaCommonsHttpClientImpl.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="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</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> |