Package org.apache.arrow.flight.auth

Class BasicServerAuthHandler

java.lang.Object

org.apache.arrow.flight.auth.BasicServerAuthHandler

All Implemented Interfaces:

ServerAuthHandler

public class BasicServerAuthHandler
extends Object
implements ServerAuthHandler

A ServerAuthHandler for username/password authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BasicServerAuthHandler.BasicAuthValidator	Interface that this handler delegates for determining if credentials are valid.

Nested classes/interfaces inherited from interface org.apache.arrow.flight.auth.ServerAuthHandler

ServerAuthHandler.ServerAuthSender

Field Summary

Fields inherited from interface org.apache.arrow.flight.auth.ServerAuthHandler

NO_OP

Constructor Summary

Constructors

Constructor	Description
BasicServerAuthHandler(BasicServerAuthHandler.BasicAuthValidator authValidator)

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicServerAuthHandler

public BasicServerAuthHandler(BasicServerAuthHandler.BasicAuthValidator authValidator)

Method Details

authenticate

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

Description copied from interface: ServerAuthHandler

Handle the initial handshake with the client.

Specified by:

authenticate in interface ServerAuthHandler

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.

isValid

public Optional<String> isValid(byte[] token)

Description copied from interface: ServerAuthHandler

Validate the client token provided on each call.

Specified by:

isValid in interface ServerAuthHandler

Returns:

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