| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UserClient (Drill : 1.20.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="UserClient (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserClient.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"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/QueryResultHandler.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserClient.html" target="_top">Frames</a></li> |
| <li><a href="UserClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.drill.exec.rpc.BasicClient">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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill.exec.rpc.user</div> |
| <h2 title="Class UserClient" class="title">Class UserClient</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">org.apache.drill.exec.rpc.RpcBus</a><T,CC></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">org.apache.drill.exec.rpc.BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.drill.exec.rpc.user.UserClient</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">UserClient</span> |
| extends <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.rpc.RpcBus"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">RpcBus</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.ChannelClosedHandler.html" title="class in org.apache.drill.exec.rpc">RpcBus.ChannelClosedHandler</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.InboundHandler.html" title="class in org.apache.drill.exec.rpc">RpcBus.InboundHandler</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.rpc.BasicClient"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#connection">connection</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.rpc.RpcBus"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">RpcBus</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#local">local</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#remote">remote</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#rpcConfig">rpcConfig</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#UserClient-java.lang.String-org.apache.drill.common.config.DrillConfig-java.util.Properties-boolean-org.apache.drill.exec.memory.BufferAllocator-io.netty.channel.EventLoopGroup-java.util.concurrent.Executor-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-">UserClient</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties, |
| boolean supportComplexTypes, |
| <a href="../../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator, |
| io.netty.channel.EventLoopGroup eventLoopGroup, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> eventExecutor, |
| <a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a> endpoint)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#connect-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-org.apache.drill.common.config.DrillProperties-org.apache.drill.exec.proto.UserBitShared.UserCredentials-">connect</a></span>(<a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a> endpoint, |
| <a href="../../../../../../org/apache/drill/common/config/DrillProperties.html" title="class in org.apache.drill.common.config">DrillProperties</a> properties, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a> credentials)</code> |
| <div class="block">Connects, and if required, authenticates.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/rpc/ProtobufLengthDecoder.html" title="class in org.apache.drill.exec.rpc">ProtobufLengthDecoder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#getDecoder-org.apache.drill.exec.memory.BufferAllocator-">getDecoder</a></span>(<a href="../../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected com.google.protobuf.MessageLite</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#getResponseDefaultInstance-int-">getResponseDefaultInstance</a></span>(int rpcType)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcEndpointInfos.html" title="class in org.apache.drill.exec.proto">UserProtos.RpcEndpointInfos</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#getServerInfos--">getServerInfos</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#getSupportedMethods--">getSupportedMethods</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#handle-org.apache.drill.exec.rpc.user.UserClient.UserToBitConnection-int-io.netty.buffer.ByteBuf-io.netty.buffer.ByteBuf-org.apache.drill.exec.rpc.ResponseSender-">handle</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a> connection, |
| int rpcType, |
| io.netty.buffer.ByteBuf pBody, |
| io.netty.buffer.ByteBuf dBody, |
| <a href="../../../../../../org/apache/drill/exec/rpc/ResponseSender.html" title="interface in org.apache.drill.exec.rpc">ResponseSender</a> sender)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#initRemoteConnection-io.netty.channel.socket.SocketChannel-">initRemoteConnection</a></span>(io.netty.channel.socket.SocketChannel channel)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#isSslEnabled--">isSslEnabled</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.QueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.QueryPlanFragments</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#planQuery-org.apache.drill.exec.proto.UserProtos.GetQueryPlanFragments-">planQuery</a></span>(<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.GetQueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.GetQueryPlanFragments</a> req)</code> |
| <div class="block">planQuery is an API to plan a query without query execution</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#prepareSaslHandshake-org.apache.drill.exec.rpc.RpcConnectionHandler-java.util.List-">prepareSaslHandshake</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/RpcConnectionHandler.html" title="interface in org.apache.drill.exec.rpc">RpcConnectionHandler</a><<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>> connectionHandler, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> serverAuthMechanisms)</code> |
| <div class="block">Creates various instances needed to start the SASL handshake.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <SEND extends com.google.protobuf.MessageLite,RECEIVE extends com.google.protobuf.MessageLite><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#send-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserProtos.RpcType-SEND-java.lang.Class-boolean-io.netty.buffer.ByteBuf...-">send</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a><RECEIVE> listener, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a> rpcType, |
| SEND protobufBody, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><RECEIVE> clazz, |
| boolean allowInEventLoop, |
| io.netty.buffer.ByteBuf... dataBodies)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#setupSSL-io.netty.channel.ChannelPipeline-org.apache.drill.exec.rpc.ConnectionMultiListener.SSLHandshakeListener-">setupSSL</a></span>(io.netty.channel.ChannelPipeline pipe, |
| <a href="../../../../../../org/apache/drill/exec/rpc/ConnectionMultiListener.SSLHandshakeListener.html" title="class in org.apache.drill.exec.rpc">ConnectionMultiListener.SSLHandshakeListener</a> sslHandshakeListener)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#submitQuery-org.apache.drill.exec.rpc.user.UserResultsListener-org.apache.drill.exec.proto.UserProtos.RunQuery-">submitQuery</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a> resultsListener, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RunQuery.html" title="class in org.apache.drill.exec.proto">UserProtos.RunQuery</a> query)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.html#validateHandshake-org.apache.drill.exec.proto.UserProtos.BitToUserHandshake-">validateHandshake</a></span>(<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a> inbound)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.BasicClient"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#close--">close</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#connectAsClient-org.apache.drill.exec.rpc.RpcConnectionHandler-HS-java.lang.String-int-">connectAsClient</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#finalizeConnection-HR-CC-">finalizeConnection</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#hasPing-long-">hasPing</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#isActive--">isActive</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#isAuthComplete--">isAuthComplete</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#send-org.apache.drill.exec.rpc.RpcOutcomeListener-SEND-boolean-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#send-org.apache.drill.exec.rpc.RpcOutcomeListener-T-SEND-java.lang.Class-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#send-T-SEND-java.lang.Class-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#setAuthComplete-boolean-">setAuthComplete</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#setAutoRead-boolean-">setAutoRead</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#setSslChannel-io.netty.channel.Channel-">setSslChannel</a>, <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#startSaslHandshake-org.apache.drill.exec.rpc.RpcConnectionHandler-java.util.Map-org.apache.hadoop.security.UserGroupInformation-org.apache.drill.exec.rpc.security.AuthenticatorFactory-T-">startSaslHandshake</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.rpc.RpcBus"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.drill.exec.rpc.<a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">RpcBus</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#get-io.netty.buffer.ByteBuf-com.google.protobuf.Parser-">get</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#getCloseHandler-io.netty.channel.socket.SocketChannel-C-">getCloseHandler</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#send-C-T-SEND-java.lang.Class-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#send-org.apache.drill.exec.rpc.RpcOutcomeListener-C-T-SEND-java.lang.Class-boolean-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#send-org.apache.drill.exec.rpc.RpcOutcomeListener-C-T-SEND-java.lang.Class-io.netty.buffer.ByteBuf...-">send</a>, <a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#setAddresses-java.net.SocketAddress-java.net.SocketAddress-">setAddresses</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="UserClient-java.lang.String-org.apache.drill.common.config.DrillConfig-java.util.Properties-boolean-org.apache.drill.exec.memory.BufferAllocator-io.netty.channel.EventLoopGroup-java.util.concurrent.Executor-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UserClient</h4> |
| <pre>public UserClient(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties, |
| boolean supportComplexTypes, |
| <a href="../../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator, |
| io.netty.channel.EventLoopGroup eventLoopGroup, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> eventExecutor, |
| <a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a> endpoint) |
| throws <a href="../../../../../../org/apache/drill/exec/rpc/NonTransientRpcException.html" title="class in org.apache.drill.exec.rpc">NonTransientRpcException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/NonTransientRpcException.html" title="class in org.apache.drill.exec.rpc">NonTransientRpcException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setupSSL-io.netty.channel.ChannelPipeline-org.apache.drill.exec.rpc.ConnectionMultiListener.SSLHandshakeListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setupSSL</h4> |
| <pre>protected void setupSSL(io.netty.channel.ChannelPipeline pipe, |
| <a href="../../../../../../org/apache/drill/exec/rpc/ConnectionMultiListener.SSLHandshakeListener.html" title="class in org.apache.drill.exec.rpc">ConnectionMultiListener.SSLHandshakeListener</a> sslHandshakeListener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#setupSSL-io.netty.channel.ChannelPipeline-org.apache.drill.exec.rpc.ConnectionMultiListener.SSLHandshakeListener-">setupSSL</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSslEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSslEnabled</h4> |
| <pre>protected boolean isSslEnabled()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#isSslEnabled--">isSslEnabled</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerInfos--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerInfos</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcEndpointInfos.html" title="class in org.apache.drill.exec.proto">UserProtos.RpcEndpointInfos</a> getServerInfos()</pre> |
| </li> |
| </ul> |
| <a name="getSupportedMethods--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSupportedMethods</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>> getSupportedMethods()</pre> |
| </li> |
| </ul> |
| <a name="submitQuery-org.apache.drill.exec.rpc.user.UserResultsListener-org.apache.drill.exec.proto.UserProtos.RunQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submitQuery</h4> |
| <pre>public void submitQuery(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a> resultsListener, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RunQuery.html" title="class in org.apache.drill.exec.proto">UserProtos.RunQuery</a> query)</pre> |
| </li> |
| </ul> |
| <a name="connect-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-org.apache.drill.common.config.DrillProperties-org.apache.drill.exec.proto.UserBitShared.UserCredentials-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connect</h4> |
| <pre>public void connect(<a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a> endpoint, |
| <a href="../../../../../../org/apache/drill/common/config/DrillProperties.html" title="class in org.apache.drill.common.config">DrillProperties</a> properties, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a> credentials) |
| throws <a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre> |
| <div class="block">Connects, and if required, authenticates. This method blocks until both operations are complete.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpoint</code> - endpoint to connect to</dd> |
| <dd><code>properties</code> - properties</dd> |
| <dd><code>credentials</code> - credentials</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code> - if either connection or authentication fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="send-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserProtos.RpcType-com.google.protobuf.MessageLite-java.lang.Class-boolean-io.netty.buffer.ByteBuf:A-"> |
| <!-- --> |
| </a><a name="send-org.apache.drill.exec.rpc.RpcOutcomeListener-org.apache.drill.exec.proto.UserProtos.RpcType-SEND-java.lang.Class-boolean-io.netty.buffer.ByteBuf...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre>protected <SEND extends com.google.protobuf.MessageLite,RECEIVE extends com.google.protobuf.MessageLite> void send(<a href="../../../../../../org/apache/drill/exec/rpc/RpcOutcomeListener.html" title="interface in org.apache.drill.exec.rpc">RpcOutcomeListener</a><RECEIVE> listener, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a> rpcType, |
| SEND protobufBody, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><RECEIVE> clazz, |
| boolean allowInEventLoop, |
| io.netty.buffer.ByteBuf... dataBodies)</pre> |
| </li> |
| </ul> |
| <a name="getResponseDefaultInstance-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseDefaultInstance</h4> |
| <pre>protected com.google.protobuf.MessageLite getResponseDefaultInstance(int rpcType) |
| throws <a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#getResponseDefaultInstance-int-">getResponseDefaultInstance</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">RpcBus</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handle-org.apache.drill.exec.rpc.user.UserClient.UserToBitConnection-int-io.netty.buffer.ByteBuf-io.netty.buffer.ByteBuf-org.apache.drill.exec.rpc.ResponseSender-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handle</h4> |
| <pre>protected void handle(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a> connection, |
| int rpcType, |
| io.netty.buffer.ByteBuf pBody, |
| io.netty.buffer.ByteBuf dBody, |
| <a href="../../../../../../org/apache/drill/exec/rpc/ResponseSender.html" title="interface in org.apache.drill.exec.rpc">ResponseSender</a> sender) |
| throws <a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html#handle-C-int-io.netty.buffer.ByteBuf-io.netty.buffer.ByteBuf-org.apache.drill.exec.rpc.ResponseSender-">handle</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/RpcBus.html" title="class in org.apache.drill.exec.rpc">RpcBus</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareSaslHandshake-org.apache.drill.exec.rpc.RpcConnectionHandler-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareSaslHandshake</h4> |
| <pre>protected void prepareSaslHandshake(<a href="../../../../../../org/apache/drill/exec/rpc/RpcConnectionHandler.html" title="interface in org.apache.drill.exec.rpc">RpcConnectionHandler</a><<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>> connectionHandler, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> serverAuthMechanisms)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#prepareSaslHandshake-org.apache.drill.exec.rpc.RpcConnectionHandler-java.util.List-">BasicClient</a></code></span></div> |
| <div class="block">Creates various instances needed to start the SASL handshake. This is called from |
| <a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#validateHandshake-HR-"><code>BasicClient.validateHandshake(MessageLite)</code></a> if authentication is required from server side.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#prepareSaslHandshake-org.apache.drill.exec.rpc.RpcConnectionHandler-java.util.List-">prepareSaslHandshake</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectionHandler</code> - - Connection handler used by client's to know about success/failure conditions.</dd> |
| <dd><code>serverAuthMechanisms</code> - - List of auth mechanisms configured on server side</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateHandshake-org.apache.drill.exec.proto.UserProtos.BitToUserHandshake-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateHandshake</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> validateHandshake(<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a> inbound) |
| throws <a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#validateHandshake-HR-">validateHandshake</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initRemoteConnection-io.netty.channel.socket.SocketChannel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initRemoteConnection</h4> |
| <pre>protected <a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a> initRemoteConnection(io.netty.channel.socket.SocketChannel channel)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#initRemoteConnection-io.netty.channel.socket.SocketChannel-">initRemoteConnection</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDecoder-org.apache.drill.exec.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDecoder</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/rpc/ProtobufLengthDecoder.html" title="class in org.apache.drill.exec.rpc">ProtobufLengthDecoder</a> getDecoder(<a href="../../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html#getDecoder-org.apache.drill.exec.memory.BufferAllocator-">getDecoder</a></code> in class <code><a href="../../../../../../org/apache/drill/exec/rpc/BasicClient.html" title="class in org.apache.drill.exec.rpc">BasicClient</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.RpcType.html" title="enum in org.apache.drill.exec.proto">UserProtos.RpcType</a>,<a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user">UserClient.UserToBitConnection</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.UserToBitHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.UserToBitHandshake</a>,<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.BitToUserHandshake.html" title="class in org.apache.drill.exec.proto">UserProtos.BitToUserHandshake</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="planQuery-org.apache.drill.exec.proto.UserProtos.GetQueryPlanFragments-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>planQuery</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a><<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.QueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.QueryPlanFragments</a>> planQuery(<a href="../../../../../../org/apache/drill/exec/proto/UserProtos.GetQueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.GetQueryPlanFragments</a> req)</pre> |
| <div class="block">planQuery is an API to plan a query without query execution</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - - data necessary to plan query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of PlanFragments that can later on be submitted for execution</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UserClient.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"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/QueryResultHandler.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserClient.UserToBitConnection.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserClient.html" target="_top">Frames</a></li> |
| <li><a href="UserClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.drill.exec.rpc.BasicClient">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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |