alluxio.grpc

Class GrpcChannel

java.lang.Object

io.grpc.Channel

alluxio.grpc.GrpcChannel

All Implemented Interfaces:

AutoCloseable

public class GrpcChannel
extends io.grpc.Channel
implements AutoCloseable

Used to gather gRPC level resources and indexes together.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrpcChannel(GrpcChannelKey channelKey, io.grpc.ManagedChannel managedChannel) Creates a new connection object.

Method Summary

Modifier and Type	Method and Description
protected void	authenticate(AuthType authType, Subject subject, AlluxioConfiguration config)
void	authenticate(AuthType authType, Subject subject, AlluxioConfiguration config, SaslClientHandler clientHandler)
String	authority()
void	close() Releases the connection to the pool.
protected SaslClientHandler	createSaslClientHandler(AuthType authType, Subject subject, AlluxioConfiguration config)
boolean	equals(Object other)
io.grpc.Channel	getChannel()
GrpcChannelKey	getChannelKey()
int	hashCode()
void	intercept(io.grpc.ClientInterceptor interceptor) Registers interceptor to the channel.
boolean	isHealthy()
boolean	isShutdown()
<RequestT,ResponseT> io.grpc.ClientCall<RequestT,ResponseT>	newCall(io.grpc.MethodDescriptor<RequestT,ResponseT> methodDescriptor, io.grpc.CallOptions callOptions)
void	shutdown() Shuts down the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcChannel

protected GrpcChannel(GrpcChannelKey channelKey,
                      io.grpc.ManagedChannel managedChannel)

Creates a new connection object.

Parameters:

channelKey - gRPC channel key

managedChannel - the underlying gRPC ManagedChannel

Method Detail

getChannelKey

public GrpcChannelKey getChannelKey()

Returns:

the hannel key that owns the connection

getChannel

public io.grpc.Channel getChannel()

Returns:

the channel

newCall

public <RequestT,ResponseT> io.grpc.ClientCall<RequestT,ResponseT> newCall(io.grpc.MethodDescriptor<RequestT,ResponseT> methodDescriptor,
                                                                           io.grpc.CallOptions callOptions)

Specified by:

newCall in class io.grpc.Channel

authority

public String authority()

Specified by:

authority in class io.grpc.Channel

createSaslClientHandler

protected SaslClientHandler createSaslClientHandler(AuthType authType,
                                                    Subject subject,
                                                    AlluxioConfiguration config)
                                             throws AlluxioStatusException

Throws:

AlluxioStatusException

authenticate

protected void authenticate(AuthType authType,
                            Subject subject,
                            AlluxioConfiguration config)
                     throws AlluxioStatusException

Throws:

AlluxioStatusException

authenticate

public void authenticate(AuthType authType,
                         Subject subject,
                         AlluxioConfiguration config,
                         SaslClientHandler clientHandler)
                  throws AlluxioStatusException

Parameters:

authType - the auth type

subject - the subject

config - the config

clientHandler - the sasl client handler

Throws:

AlluxioStatusException

intercept

public void intercept(io.grpc.ClientInterceptor interceptor)

Registers interceptor to the channel.

Parameters:

interceptor - the gRPC client interceptor

shutdown

public void shutdown()

Shuts down the channel. Shutdown should be thread safe as it could be called concurrently due to: - Authentication long polling - gRPC messaging stream.

isShutdown

public boolean isShutdown()

Returns:

true if the channel has been shut down

isHealthy

public boolean isHealthy()

Returns:

true if channel is healthy

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

close

public void close()

Releases the connection to the pool.

Specified by:

close in interface AutoCloseable