Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class ServerHeaderMiddleware

java.lang.Object

org.apache.arrow.flight.ServerHeaderMiddleware

All Implemented Interfaces:

FlightServerMiddleware

public class ServerHeaderMiddleware
extends Object
implements FlightServerMiddleware

Middleware that's used to extract and pass headers to the server during requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerHeaderMiddleware.Factory	Factory for accessing ServerHeaderMiddleware.

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

FlightServerMiddleware.Key<T extends FlightServerMiddleware>

Method Summary

Modifier and Type	Method	Description
CallHeaders	headers()	Retrieve the headers for this call.
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

Method Details

headers

public CallHeaders headers()

Retrieve the headers for this call.

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.