Package io.deephaven.enterprise.dnd.authentication

Class DheAuthenticationHandler

java.lang.Object

io.deephaven.enterprise.dnd.authentication.DheAuthenticationHandler

All Implemented Interfaces:

AuthenticationRequestHandler

public class DheAuthenticationHandler
extends Object
implements AuthenticationRequestHandler

The authentication hook for enterprise clients to DnD workers.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.auth.AuthenticationRequestHandler

AuthenticationRequestHandler.HandshakeResponseListener, AuthenticationRequestHandler.MetadataResponseListener

Constructor Summary

Constructors

Constructor	Description
DheAuthenticationHandler()	Create a new auth handler.

Method Summary

Modifier and Type	Method	Description
static @Nullable DheAuthContext	fetchDheAuthContext()	Fetch an Enterprise DheAuthContext from the current ExecutionContext.
String	getAuthType()
static io.deephaven.enterprise.auth.UserContext	getOwnerCredentials()
void	initialize(@NotNull String targetUrl)
static boolean	isAdmin(@NotNull io.deephaven.enterprise.auth.UserContext userContext)	Check if the specified user is an administrator of this worker.
static boolean	isViewer(@NotNull io.deephaven.enterprise.auth.UserContext userContext)	Check if the specified user is a viewer of this worker.
Optional<AuthContext>	login(long protocolVersionUnused, ByteBuffer payload, AuthenticationRequestHandler.HandshakeResponseListener listenerUnused)
Optional<AuthContext>	login(String payload, AuthenticationRequestHandler.MetadataResponseListener listener)
static void	setAdminGroups(@NotNull Set<String> adminGroups)
static void	setGroupProvider(@NotNull GroupProvider groupProvider)
static void	setOwnerCredentials(@NotNull io.deephaven.enterprise.auth.UserContext userContext)
static void	setViewerGroups(@NotNull Set<String> viewerGroups)

Methods inherited from class java.lang.Object

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

Constructor Details

DheAuthenticationHandler

public DheAuthenticationHandler()

Create a new auth handler.

Method Details

setOwnerCredentials

public static void setOwnerCredentials(@NotNull
 @NotNull io.deephaven.enterprise.auth.UserContext userContext)

getOwnerCredentials

public static io.deephaven.enterprise.auth.UserContext getOwnerCredentials()

setAdminGroups

public static void setAdminGroups(@NotNull
 @NotNull Set<String> adminGroups)

setViewerGroups

public static void setViewerGroups(@NotNull
 @NotNull Set<String> viewerGroups)

setGroupProvider

public static void setGroupProvider(@NotNull
 @NotNull GroupProvider groupProvider)

isAdmin

public static boolean isAdmin(@NotNull
 @NotNull io.deephaven.enterprise.auth.UserContext userContext)

Check if the specified user is an administrator of this worker.

Parameters:

userContext - the user

Returns:

true if the user is an administrator.

isViewer

public static boolean isViewer(@NotNull
 @NotNull io.deephaven.enterprise.auth.UserContext userContext)

Check if the specified user is a viewer of this worker.

Parameters:

userContext - the user

Returns:

true if the user is a viewer

fetchDheAuthContext

@Nullable
public static @Nullable DheAuthContext fetchDheAuthContext()

Fetch an Enterprise DheAuthContext from the current ExecutionContext. If one is not provided, or of the wrong type, return null.

Returns:

the current DheAuthContext or null of one was not present.

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface AuthenticationRequestHandler

login

public Optional<AuthContext> login(long protocolVersionUnused,
 ByteBuffer payload,
 AuthenticationRequestHandler.HandshakeResponseListener listenerUnused)
                            throws AuthenticationException

Specified by:

login in interface AuthenticationRequestHandler

Throws:

AuthenticationException

login

public Optional<AuthContext> login(String payload,
 AuthenticationRequestHandler.MetadataResponseListener listener)
                            throws AuthenticationException

Specified by:

login in interface AuthenticationRequestHandler

Throws:

AuthenticationException

initialize

public void initialize(@NotNull
 @NotNull String targetUrl)

Specified by:

initialize in interface AuthenticationRequestHandler