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	setClientType(String clientType) Sets human readable name for the channel's client.
GrpcChannelBuilder	setNetworkGroup(GrpcNetworkGroup group) 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

disableAuthentication

public GrpcChannelBuilder disableAuthentication()

Disables authentication with the server.

Returns:

the updated GrpcChannelBuilder instance

setNetworkGroup

public GrpcChannelBuilder setNetworkGroup(GrpcNetworkGroup group)

Sets the pooling strategy.

Parameters:

group - the networking group

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