alluxio.grpc

Class GrpcChannelBuilder

java.lang.Object

alluxio.grpc.GrpcChannelBuilder

public final class GrpcChannelBuilder
extends Object

A gRPC channel builder that authenticates with GrpcServer at the target during channel building.

Method Summary

Modifier and Type	Method and Description
GrpcChannel	build() Creates an authenticated channel of type GrpcChannel.
GrpcChannelBuilder	disableAuthentication() Disables authentication with the server.
static GrpcChannelBuilder	newBuilder(GrpcServerAddress address, AlluxioConfiguration conf) Create a channel builder for given address using the given configuration.
GrpcChannelBuilder	setChannelType(Class<? extends io.netty.channel.Channel> channelType) Sets the channel type.
GrpcChannelBuilder	setClientType(String clientType) Sets human readable name for the channel's client.
GrpcChannelBuilder	setCredentials(String userName, String password, String impersonationUser) Sets authentication content.
GrpcChannelBuilder	setEventLoopGroup(io.netty.channel.EventLoopGroup group) Sets the event loop group.
GrpcChannelBuilder	setFlowControlWindow(int flowControlWindow) Sets the flow control window.
GrpcChannelBuilder	setKeepAliveTime(long keepAliveTime, TimeUnit timeUnit) Sets the time to wait after receiving last message before pinging the server.
GrpcChannelBuilder	setKeepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) Sets the maximum time waiting for response after pinging server before closing connection.
GrpcChannelBuilder	setMaxInboundMessageSize(int maxInboundMessaageSize) Sets the maximum message size allowed for a single gRPC frame.
GrpcChannelBuilder	setPoolingStrategy(GrpcChannelKey.PoolingStrategy strategy) Sets the pooling strategy.
GrpcChannelBuilder	setSubject(Subject subject) Sets Subject for authentication.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static GrpcChannelBuilder newBuilder(GrpcServerAddress address,
                                            AlluxioConfiguration conf)

Create a channel builder for given address using the given configuration.

Parameters:

address - the host address

conf - Alluxio configuration

Returns:

a new instance of GrpcChannelBuilder

setClientType

public GrpcChannelBuilder setClientType(String clientType)

Sets human readable name for the channel's client.

Parameters:

clientType - client type

Returns:

the updated GrpcChannelBuilder instance

setSubject

public GrpcChannelBuilder setSubject(Subject subject)

Sets Subject for authentication.

Parameters:

subject - the subject

Returns:

the updated GrpcChannelBuilder instance

setCredentials

public GrpcChannelBuilder setCredentials(String userName,
                                         String password,
                                         String impersonationUser)

Sets authentication content. Calling this will reset the subject set by setSubject(javax.security.auth.Subject).

Parameters:

userName - the username

password - the password

impersonationUser - the impersonation user

Returns:

the updated GrpcChannelBuilder instance

disableAuthentication

public GrpcChannelBuilder disableAuthentication()

Disables authentication with the server.

Returns:

the updated GrpcChannelBuilder instance

setKeepAliveTime

public GrpcChannelBuilder setKeepAliveTime(long keepAliveTime,
                                           TimeUnit timeUnit)

Sets the time to wait after receiving last message before pinging the server.

Parameters:

keepAliveTime - the time to wait after receiving last message before pinging server

timeUnit - unit of the time

Returns:

the updated GrpcChannelBuilder instance

setKeepAliveTimeout

public GrpcChannelBuilder setKeepAliveTimeout(long keepAliveTimeout,
                                              TimeUnit timeUnit)

Sets the maximum time waiting for response after pinging server before closing connection.

Parameters:

keepAliveTimeout - the time to wait after pinging server before closing the connection

timeUnit - unit of the timeout

Returns:

the updated GrpcChannelBuilder instance

setMaxInboundMessageSize

public GrpcChannelBuilder setMaxInboundMessageSize(int maxInboundMessaageSize)

Sets the maximum message size allowed for a single gRPC frame.

Parameters:

maxInboundMessaageSize - the maximum inbound message size in bytes

Returns:

a new instance of GrpcChannelBuilder

setFlowControlWindow

public GrpcChannelBuilder setFlowControlWindow(int flowControlWindow)

Sets the flow control window.

Parameters:

flowControlWindow - the flow control window in bytes

Returns:

a new instance of GrpcChannelBuilder

setChannelType

public GrpcChannelBuilder setChannelType(Class<? extends io.netty.channel.Channel> channelType)

Sets the channel type.

Parameters:

channelType - the channel type

Returns:

a new instance of GrpcChannelBuilder

setEventLoopGroup

public GrpcChannelBuilder setEventLoopGroup(io.netty.channel.EventLoopGroup group)

Sets the event loop group.

Parameters:

group - the event loop group

Returns:

a new instance of GrpcChannelBuilder

setPoolingStrategy

public GrpcChannelBuilder setPoolingStrategy(GrpcChannelKey.PoolingStrategy strategy)

Sets the pooling strategy.

Parameters:

strategy - the pooling strategy

Returns:

a new instance of GrpcChannelBuilder

build

public GrpcChannel build()
                  throws AlluxioStatusException

Creates an authenticated channel of type GrpcChannel.

Returns:

the built GrpcChannel

Throws:

AlluxioStatusException