org.apache.arrow.flight.auth

Interface ServerAuthHandler

All Known Implementing Classes:

BasicServerAuthHandler

public interface ServerAuthHandler

Interface for Server side authentication handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerAuthHandler.ServerAuthSender Interface for a server implementations to send back authentication messages back to the client.

Field Summary

Fields

Modifier and Type	Field and Description
static ServerAuthHandler	NO_OP An auth handler that does nothing.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(ServerAuthHandler.ServerAuthSender outgoing, Iterator<byte[]> incoming) Handle the initial handshake with the client.
Optional<String>	isValid(byte[] token) Validate the client token provided on each call.

Field Detail

NO_OP

static final ServerAuthHandler NO_OP

An auth handler that does nothing.

Method Detail

isValid

Optional<String> isValid(byte[] token)

Validate the client token provided on each call.

Returns:

An empty optional if the client is not authenticated; the peer identity otherwise (may be the empty string).

authenticate

boolean authenticate(ServerAuthHandler.ServerAuthSender outgoing,
                     Iterator<byte[]> incoming)

Handle the initial handshake with the client.

Parameters:

outgoing - A writer to send messages to the client.

incoming - An iterator of messages from the client.

Returns:

true if client is authenticated, false otherwise.