Package org.apache.arrow.flight.auth

Interface ServerAuthHandler

All Known Implementing Classes:

BasicServerAuthHandler

@Deprecated
public interface ServerAuthHandler

Deprecated.

As of 14.0.0. This implements a stateful "login" flow that does not play well with distributed or stateless systems. It will not be removed, but should not be used. Instead, see FlightServer.Builder.headerAuthenticator(CallHeaderAuthenticator) and CallHeaderAuthenticator.

Interface for Server side authentication handlers.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

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

Field Details

NO_OP

static final ServerAuthHandler NO_OP

Deprecated.

An auth handler that does nothing.

Method Details

isValid

Optional<String> isValid(byte[] token)

Deprecated.

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)

Deprecated.

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.