org.apache.drill.exec.server.rest

Class WebUserConnection

java.lang.Object

org.apache.drill.exec.rpc.AbstractDisposableUserClientConnection

org.apache.drill.exec.server.rest.WebUserConnection

All Implemented Interfaces:

ConnectionThrottle, UserClientConnection

Direct Known Subclasses:

WebUserConnection.AnonWebUserConnection

public class WebUserConnection
extends AbstractDisposableUserClientConnection
implements ConnectionThrottle

WebUserConnectionWrapper which represents the UserClientConnection between WebServer and Foreman, for the WebUser submitting the query. It provides access to the UserSession executing the query. There is no actual physical channel corresponding to this connection wrapper. It returns a close future with no actual underlying Channel associated with it but do have an EventExecutor out of BitServer EventLoopGroup. Since there is no actual connection established using this class, hence the close event will never be fired by underlying layer and close future is set only when the WebSessionResources are closed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebUserConnection.AnonWebUserConnection

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	columns
List<Map<String,String>>	results
protected WebSessionResources	webSessionResources

Fields inherited from class org.apache.drill.exec.rpc.AbstractDisposableUserClientConnection

error, exception, latch

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanupSession() For authenticated WebUser no cleanup of WebSessionResources is done since it's re-used for all the queries until lifetime of the web session.
io.netty.channel.ChannelFuture	getChannelClosureFuture() Returns the ChannelFuture which will be notified when this channel is closed.
SocketAddress	getRemoteAddress()
UserSession	getSession()
void	sendData(RpcOutcomeListener<GeneralRPCProtos.Ack> listener, QueryWritableBatch result) Send query data to client.
void	setAutoRead(boolean enableAutoRead)

Methods inherited from class org.apache.drill.exec.rpc.AbstractDisposableUserClientConnection

await, await, getError, sendResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

webSessionResources

protected WebSessionResources webSessionResources

results

public final List<Map<String,String>> results

columns

public final Set<String> columns

Method Detail

getSession

public UserSession getSession()

Specified by:

getSession in interface UserClientConnection

Returns:

User session object.

sendData

public void sendData(RpcOutcomeListener<GeneralRPCProtos.Ack> listener,
            QueryWritableBatch result)

Description copied from interface: UserClientConnection

Send query data to client. Outcome is returned through listener

Specified by:

sendData in interface UserClientConnection

getChannelClosureFuture

public io.netty.channel.ChannelFuture getChannelClosureFuture()

Description copied from interface: UserClientConnection

Returns the ChannelFuture which will be notified when this channel is closed. This method always returns the same future instance.

Specified by:

getChannelClosureFuture in interface UserClientConnection

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface UserClientConnection

Returns:

Return the client node address.

setAutoRead

public void setAutoRead(boolean enableAutoRead)

Specified by:

setAutoRead in interface ConnectionThrottle

cleanupSession

public void cleanupSession()

For authenticated WebUser no cleanup of WebSessionResources is done since it's re-used for all the queries until lifetime of the web session.