Package alluxio.grpc

Class GrpcChannelBuilder

java.lang.Object

alluxio.grpc.GrpcChannelBuilder

public class GrpcChannelBuilder
extends java.lang.Object

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcChannelBuilder(GrpcServerAddress address, AlluxioConfiguration conf, AuthType authType, boolean alwaysEnableTLS)

Method Summary

Modifier and Type	Method	Description
GrpcChannel	build()	Creates an authenticated channel of type GrpcChannel.
GrpcChannelBuilder	disableAuthentication()	Disables authentication with the server.
protected GrpcServerAddress	getAddress()
protected boolean	getAlwaysEnableTLS()
protected AuthType	getAuthType()
protected AlluxioConfiguration	getConfiguration()
protected GrpcNetworkGroup	getNetworkGroup()
protected javax.security.auth.Subject	getParentSubject()
static GrpcChannelBuilder	newBuilder(GrpcServerAddress address, AlluxioConfiguration conf)	Create a channel builder for given address using the given configuration.
static GrpcChannelBuilder	newBuilder(GrpcServerAddress address, AlluxioConfiguration conf, boolean alwaysEnableTLS)	Create a channel builder for given address using the given configuration.
static GrpcChannelBuilder	newBuilder(GrpcServerAddress address, AlluxioConfiguration conf, AuthType authType, boolean alwaysEnableTLS)	Create a channel builder for given address using the given configuration.
GrpcChannelBuilder	setNetworkGroup(GrpcNetworkGroup group)	Sets the pooling strategy.
GrpcChannelBuilder	setSubject(javax.security.auth.Subject subject)	Sets Subject for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcChannelBuilder

protected GrpcChannelBuilder(GrpcServerAddress address,
                             AlluxioConfiguration conf,
                             AuthType authType,
                             boolean alwaysEnableTLS)

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

newBuilder

public static GrpcChannelBuilder newBuilder(GrpcServerAddress address,
                                            AlluxioConfiguration conf,
                                            boolean alwaysEnableTLS)

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

Parameters:

address - the host address

conf - Alluxio configuration

alwaysEnableTLS - whether to always enable TLS

Returns:

a new instance of GrpcChannelBuilder

newBuilder

public static GrpcChannelBuilder newBuilder(GrpcServerAddress address,
                                            AlluxioConfiguration conf,
                                            AuthType authType,
                                            boolean alwaysEnableTLS)

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

Parameters:

address - the host address

conf - Alluxio configuration

authType - the auth type

alwaysEnableTLS - whether to always enable the TLS

Returns:

a new instance of GrpcChannelBuilder

setSubject

public GrpcChannelBuilder setSubject(javax.security.auth.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

getAddress

protected GrpcServerAddress getAddress()

getNetworkGroup

protected GrpcNetworkGroup getNetworkGroup()

getConfiguration

protected AlluxioConfiguration getConfiguration()

getAlwaysEnableTLS

protected boolean getAlwaysEnableTLS()

getAuthType

protected AuthType getAuthType()

getParentSubject

protected javax.security.auth.Subject getParentSubject()

build

public GrpcChannel build()
                  throws AlluxioStatusException

Creates an authenticated channel of type GrpcChannel.

Returns:

the built GrpcChannel

Throws:

AlluxioStatusException