Package io.deephaven.server.session

Class SessionService

java.lang.Object

io.deephaven.server.session.SessionService

@Singleton
public class SessionService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SessionService.ErrorTransformer	Implementations of error transformer give the server one last chance to convert errors to useful messages before responding to gRPC users.
static class	SessionService.ObfuscatingErrorTransformer
static final class	SessionService.TokenExpiration

Constructor Summary

Constructors

Constructor	Description
SessionService(Scheduler scheduler, SessionState.Factory sessionFactory, long tokenExpireMs, Map<String,AuthenticationRequestHandler> authRequestHandlers, Set<SessionListener> sessionListeners)

Method Summary

Modifier and Type	Method	Description
void	addTerminationListener(SessionState session, io.grpc.stub.StreamObserver<TerminationNotificationResponse> responseObserver)	Add a listener who receives a single notification when this process is exiting and yet able to communicate with the observer.
void	closeAllSessions()
void	closeSession(SessionState session)	Reduces the liveness of the session.
@NotNull SessionState	getCurrentSession()	Lookup a session via the SessionServiceGrpcImpl.SESSION_CONTEXT_KEY.
long	getExpirationDelayMs()
@Nullable SessionState	getOptionalSession()	Lookup a session via the SessionServiceGrpcImpl.SESSION_CONTEXT_KEY.
SessionState	getSessionForAuthToken(String token)	Lookup a session by token.
SessionState	getSessionForToken(UUID token)	Lookup a session by token.
SessionState	newSession(AuthContext authContext)	Create a new session object for the provided auth context.
void	onShutdown()
SessionService.TokenExpiration	refreshToken(SessionState session)	If enough time has passed since the last token run, rotate to a new token and reset the expiration deadline.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionService

@Inject
public SessionService(Scheduler scheduler,
 SessionState.Factory sessionFactory,
 @Named("session.tokenExpireMs")
 long tokenExpireMs,
 Map<String,AuthenticationRequestHandler> authRequestHandlers,
 Set<SessionListener> sessionListeners)

Method Details

onShutdown

public void onShutdown()

addTerminationListener

public void addTerminationListener(SessionState session,
 io.grpc.stub.StreamObserver<TerminationNotificationResponse> responseObserver)

Add a listener who receives a single notification when this process is exiting and yet able to communicate with the observer.

Parameters:

session - the session the observer belongs to

responseObserver - the observer to notify

newSession

public SessionState newSession(AuthContext authContext)

Create a new session object for the provided auth context.

Parameters:

authContext - the auth context of the session

Returns:

a new session independent of all other existing sessions

refreshToken

public SessionService.TokenExpiration refreshToken(SessionState session)

If enough time has passed since the last token run, rotate to a new token and reset the expiration deadline.

Parameters:

session - the session to run

Returns:

the most recent token expiration

getExpirationDelayMs

public long getExpirationDelayMs()

Returns:

the configured token duration in milliseconds

getSessionForAuthToken

public SessionState getSessionForAuthToken(String token)
                                    throws AuthenticationException

Lookup a session by token. Creates a new session if it's a basic auth and it passes.

Parameters:

token - the Authentication header to service

Returns:

the session or null if the session is invalid

Throws:

AuthenticationException

getSessionForToken

public SessionState getSessionForToken(UUID token)

Lookup a session by token.

Parameters:

token - the session secret to look for

Returns:

the session or null if the session is invalid

getCurrentSession

@NotNull
public @NotNull SessionState getCurrentSession()

Lookup a session via the SessionServiceGrpcImpl.SESSION_CONTEXT_KEY. This method is only valid in the context of the original calling gRPC thread.

Returns:

the session attached to this gRPC request

Throws:

io.grpc.StatusRuntimeException - if thread is not attached to a session or if the session is expired/closed

getOptionalSession

@Nullable
public @Nullable SessionState getOptionalSession()

Lookup a session via the SessionServiceGrpcImpl.SESSION_CONTEXT_KEY. This method is only valid in the context of the original calling gRPC thread.

Returns:

the session attached to this gRPC request; null if no session is established

closeSession

public void closeSession(SessionState session)

Reduces the liveness of the session.

Parameters:

session - the session to close

closeAllSessions

public void closeAllSessions()