alluxio.security.authentication

Class AuthenticatedChannelClientDriver

java.lang.Object

alluxio.security.authentication.AuthenticatedChannelClientDriver

All Implemented Interfaces:

io.grpc.stub.StreamObserver<SaslMessage>

public class AuthenticatedChannelClientDriver
extends Object
implements io.grpc.stub.StreamObserver<SaslMessage>

Responsible for driving authentication traffic from client-side. An authentication between client and server is managed by AuthenticatedChannelClientDriver and AuthenticatedChannelServerDriver respectively. These drivers are wrappers over gRPC StreamObservers that manages the stream traffic destined for the other participant. They make sure messages are exchanged between client and server synchronously. Authentication is initiated by the client. Following the initiate call, depending on the scheme, one or more messages are exchanged to establish authenticated session between client and server. After the authentication is established, client and server streams are not closed in order to use them as long polling on authentication state changes. -> Client closing the stream means that it doesn't want to be authenticated anymore. -> Server closing the stream means the client is not authenticated at the server anymore.

Constructor Summary

Constructors

Constructor and Description
AuthenticatedChannelClientDriver(SaslClientHandler saslClientHandler, GrpcChannelKey channelKey) Creates client driver with given handshake handler.

Method Summary

Modifier and Type	Method and Description
void	close() Stops authenticated session with the server by releasing the long poll.
boolean	isAuthenticated()
void	onCompleted()
void	onError(Throwable throwable)
void	onNext(SaslMessage saslMessage)
void	setServerObserver(io.grpc.stub.StreamObserver<SaslMessage> requestObserver) Sets the server's Sasl stream.
void	startAuthenticatedChannel(long timeoutMs) Starts authentication with the server and wait until completion.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedChannelClientDriver

public AuthenticatedChannelClientDriver(SaslClientHandler saslClientHandler,
                                        GrpcChannelKey channelKey)
                                 throws SaslException

Creates client driver with given handshake handler.

Parameters:

saslClientHandler - sasl client handler

channelKey - channel key

Throws:

SaslException

Method Detail

setServerObserver

public void setServerObserver(io.grpc.stub.StreamObserver<SaslMessage> requestObserver)

Sets the server's Sasl stream.

Parameters:

requestObserver - server Sasl stream

onNext

public void onNext(SaslMessage saslMessage)

Specified by:

onNext in interface io.grpc.stub.StreamObserver<SaslMessage>

onError

public void onError(Throwable throwable)

Specified by:

onError in interface io.grpc.stub.StreamObserver<SaslMessage>

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<SaslMessage>

close

public void close()

Stops authenticated session with the server by releasing the long poll.

isAuthenticated

public boolean isAuthenticated()

Returns:

true if the channel is still authenticated

startAuthenticatedChannel

public void startAuthenticatedChannel(long timeoutMs)
                               throws AlluxioStatusException

Starts authentication with the server and wait until completion.

Parameters:

timeoutMs - time to wait for authentication

Throws:

UnauthenticatedException

AlluxioStatusException