Package io.deephaven.server.session

Class SessionServiceGrpcImpl

java.lang.Object

io.deephaven.proto.backplane.grpc.SessionServiceGrpc.SessionServiceImplBase

io.deephaven.server.session.SessionServiceGrpcImpl

All Implemented Interfaces:

io.grpc.BindableService

public class SessionServiceGrpcImpl
extends SessionServiceGrpc.SessionServiceImplBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionServiceGrpcImpl.InterceptedCall<ReqT,RespT>
static class	SessionServiceGrpcImpl.SessionServiceInterceptor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEEPHAVEN_SESSION_ID	Deprecated.
static final io.grpc.Context.Key<SessionState>	SESSION_CONTEXT_KEY
static final io.grpc.Metadata.Key<String>	SESSION_HEADER_KEY

Constructor Summary

Constructors

Constructor	Description
SessionServiceGrpcImpl(SessionService service, TicketRouter ticketRouter)

Method Summary

Modifier and Type	Method	Description
void	closeSession(@NotNull HandshakeRequest request, @NotNull io.grpc.stub.StreamObserver<CloseSessionResponse> responseObserver)	Proactively close an open session.
void	exportFromTicket(@NotNull ExportRequest request, @NotNull io.grpc.stub.StreamObserver<ExportResponse> responseObserver)	Makes a copy from a source ticket to a client managed result ticket.
void	exportNotifications(@NotNull ExportNotificationRequest request, @NotNull io.grpc.stub.StreamObserver<ExportNotification> responseObserver)	Establish a stream to manage all session exports, including those lost due to partially complete rpc calls.
static void	insertCallHeader(String key, String value)
void	newSession(@NotNull HandshakeRequest request, @NotNull io.grpc.stub.StreamObserver<HandshakeResponse> responseObserver)	Handshake between client and server to create a new session.
void	publishFromTicket(@NotNull PublishRequest request, @NotNull io.grpc.stub.StreamObserver<PublishResponse> responseObserver)	Makes a copy from a source ticket and publishes to a result ticket.
void	refreshSessionToken(@NotNull HandshakeRequest request, @NotNull io.grpc.stub.StreamObserver<HandshakeResponse> responseObserver)	Keep-alive a given token to ensure that a session is not cleaned prematurely.
void	release(@NotNull ReleaseRequest request, @NotNull io.grpc.stub.StreamObserver<ReleaseResponse> responseObserver)	Attempts to release an export by its ticket.
void	terminationNotification(@NotNull TerminationNotificationRequest request, @NotNull io.grpc.stub.StreamObserver<TerminationNotificationResponse> responseObserver)	Receive a best-effort message on-exit indicating why this server is exiting.

Methods inherited from class io.deephaven.proto.backplane.grpc.SessionServiceGrpc.SessionServiceImplBase

bindService

Methods inherited from class java.lang.Object

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

Field Details

DEEPHAVEN_SESSION_ID

@Deprecated
public static final String DEEPHAVEN_SESSION_ID

Deprecated.

Deprecated, use Auth2Constants.AUTHORIZATION_HEADER instead.

See Also:

• Constant Field Values

SESSION_HEADER_KEY

public static final io.grpc.Metadata.Key<String> SESSION_HEADER_KEY

SESSION_CONTEXT_KEY

public static final io.grpc.Context.Key<SessionState> SESSION_CONTEXT_KEY

Constructor Details

SessionServiceGrpcImpl

@Inject
public SessionServiceGrpcImpl(SessionService service,
 TicketRouter ticketRouter)

Method Details

newSession

public void newSession(@NotNull
 @NotNull HandshakeRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<HandshakeResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Handshake between client and server to create a new session. The response includes a metadata header name and the
 token to send on every subsequent request. The auth mechanisms here are unary to best support grpc-web.
 Deprecated: Please use Flight's Handshake or http authorization headers instead.
 

Overrides:

newSession in class SessionServiceGrpc.SessionServiceImplBase

refreshSessionToken

public void refreshSessionToken(@NotNull
 @NotNull HandshakeRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<HandshakeResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Keep-alive a given token to ensure that a session is not cleaned prematurely. The response may include an updated
 token that should replace the existing token for subsequent requests.
 Deprecated: Please use Flight's Handshake with an empty payload.
 

Overrides:

refreshSessionToken in class SessionServiceGrpc.SessionServiceImplBase

closeSession

public void closeSession(@NotNull
 @NotNull HandshakeRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<CloseSessionResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Proactively close an open session. Sessions will automatically close on timeout. When a session is closed, all
 unreleased exports will be automatically released.
 

Overrides:

closeSession in class SessionServiceGrpc.SessionServiceImplBase

release

public void release(@NotNull
 @NotNull ReleaseRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<ReleaseResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Attempts to release an export by its ticket. Returns true if an existing export was found. It is the client's
 responsibility to release all resources they no longer want the server to hold on to. Proactively cancels work; do
 not release a ticket that is needed by dependent work that has not yet finished
 (i.e. the dependencies that are staying around should first be in EXPORTED state).
 

Overrides:

release in class SessionServiceGrpc.SessionServiceImplBase

exportFromTicket

public void exportFromTicket(@NotNull
 @NotNull ExportRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<ExportResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Makes a copy from a source ticket to a client managed result ticket. The source ticket does not need to be
 a client managed ticket.
 

Overrides:

exportFromTicket in class SessionServiceGrpc.SessionServiceImplBase

publishFromTicket

public void publishFromTicket(@NotNull
 @NotNull PublishRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<PublishResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Makes a copy from a source ticket and publishes to a result ticket. Neither the source ticket, nor the destination
 ticket, need to be a client managed ticket.
 

Overrides:

publishFromTicket in class SessionServiceGrpc.SessionServiceImplBase

exportNotifications

public void exportNotifications(@NotNull
 @NotNull ExportNotificationRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<ExportNotification> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Establish a stream to manage all session exports, including those lost due to partially complete rpc calls.
 New streams will flush notifications for all un-released exports, prior to seeing any new or updated exports
 for all live exports. After the refresh of existing state, subscribers will receive notifications of new and
 updated exports. An export id of zero will be sent to indicate all pre-existing exports have been sent.
 

Overrides:

exportNotifications in class SessionServiceGrpc.SessionServiceImplBase

terminationNotification

public void terminationNotification(@NotNull
 @NotNull TerminationNotificationRequest request,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<TerminationNotificationResponse> responseObserver)

Description copied from class: SessionServiceGrpc.SessionServiceImplBase

 Receive a best-effort message on-exit indicating why this server is exiting. Reception of this message cannot be
 guaranteed.
 

Overrides:

terminationNotification in class SessionServiceGrpc.SessionServiceImplBase

insertCallHeader

public static void insertCallHeader(String key,
 String value)