Module org.apache.arrow.flight.core

Package org.apache.arrow.flight.auth2

Class ServerCallHeaderAuthMiddleware

java.lang.Object

org.apache.arrow.flight.auth2.ServerCallHeaderAuthMiddleware

All Implemented Interfaces:

FlightServerMiddleware

public class ServerCallHeaderAuthMiddleware
extends Object
implements FlightServerMiddleware

Middleware that's used to validate credentials during the handshake and verify the bearer token in subsequent requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerCallHeaderAuthMiddleware.Factory	Factory for accessing ServerAuthMiddleware.

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

FlightServerMiddleware.Key<T extends FlightServerMiddleware>

Constructor Summary

Constructors

Constructor	Description
ServerCallHeaderAuthMiddleware(CallHeaderAuthenticator.AuthResult authResult)

Method Summary

Modifier and Type	Method	Description
void	onBeforeSendingHeaders(CallHeaders outgoingHeaders)	Callback for when the underlying transport is about to send response headers.
void	onCallCompleted(CallStatus status)	Callback for when the underlying transport has completed a call.
void	onCallErrored(Throwable err)	Callback for when an RPC method implementation throws an uncaught exception.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerCallHeaderAuthMiddleware

public ServerCallHeaderAuthMiddleware(CallHeaderAuthenticator.AuthResult authResult)

Method Details

onBeforeSendingHeaders

public void onBeforeSendingHeaders(CallHeaders outgoingHeaders)

Description copied from interface: FlightServerMiddleware

Callback for when the underlying transport is about to send response headers.

Specified by:

onBeforeSendingHeaders in interface FlightServerMiddleware

Parameters:

outgoingHeaders - A mutable set of response headers. These can be manipulated to send different headers to the client.

onCallCompleted

public void onCallCompleted(CallStatus status)

Description copied from interface: FlightServerMiddleware

Callback for when the underlying transport has completed a call.

Specified by:

onCallCompleted in interface FlightServerMiddleware

Parameters:

status - Whether the call completed successfully or not.

onCallErrored

public void onCallErrored(Throwable err)

Description copied from interface: FlightServerMiddleware

Callback for when an RPC method implementation throws an uncaught exception.

May be called multiple times, and may be called before or after FlightServerMiddleware.onCallCompleted(CallStatus). Generally, an uncaught exception will end the call with a error CallStatus, and will be reported to FlightServerMiddleware.onCallCompleted(CallStatus), but not necessarily this method.

Specified by:

onCallErrored in interface FlightServerMiddleware

Parameters:

err - The exception that was thrown.