org.apache.arrow.flight

Class ServerSessionMiddleware

java.lang.Object

org.apache.arrow.flight.ServerSessionMiddleware

All Implemented Interfaces:

FlightServerMiddleware

public class ServerSessionMiddleware
extends Object
implements FlightServerMiddleware

Middleware for handling Flight SQL Sessions including session cookie handling. Currently experimental.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSessionMiddleware.Factory Factory for managing and accessing ServerSessionMiddleware.
static class	ServerSessionMiddleware.Session A thread-safe container for named SessionOptionValues.

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

FlightServerMiddleware.Key<T extends FlightServerMiddleware>

Field Summary

Fields

Modifier and Type	Field and Description
static String	sessionCookieName

Method Summary

Modifier and Type	Method and Description
void	closeSession() Close the current session.
CallHeaders	getCallHeaders()
ServerSessionMiddleware.Session	getSession() Get the existing or new session value map for this call.
boolean	hasSession() Check if there is an open session associated with 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

Field Detail

sessionCookieName

public static final String sessionCookieName

See Also:

Constant Field Values

Method Detail

hasSession

public boolean hasSession()

Check if there is an open session associated with this call.

Returns:

True iff there is an open session associated with this call.

getSession

public ServerSessionMiddleware.Session getSession()

Get the existing or new session value map for this call.

Returns:

The session option value map, or null in case of an id generation collision.

closeSession

public void closeSession()

Close the current session. It is an error to call this without a valid session specified via cookie or equivalent.

getCallHeaders

public CallHeaders getCallHeaders()

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.