Package io.deephaven.auth

Interface BasicAuthMarshaller.Handler

All Known Implementing Classes:

BasicSqlAuthenticationHandler

Enclosing class:

BasicAuthMarshaller

public static interface BasicAuthMarshaller.Handler

Handler for "Basic" auth types. Note that only one can be configured at a time, unlike other handler types - to support more than one username/password strategy, the implementation of this interface will need to handle that behavior, perhaps by delegating to more than one sub-handler.

Method Summary

Modifier and Type	Method	Description
Optional<AuthContext>	login(String username, String password)	Like AuthenticationRequestHandler.login(long, ByteBuffer, HandshakeResponseListener), takes the client's identity assertion and tries to validate it.

Method Details

login

Optional<AuthContext> login(String username,
 String password)
                     throws AuthenticationException

Like AuthenticationRequestHandler.login(long, ByteBuffer, HandshakeResponseListener), takes the client's identity assertion and tries to validate it. As with those methods, returns an auth context to signal success, and can return empty to signal failure as well as throwing an exception.

Parameters:

username - the specified username to authenticate as

password - the password to verify the user's identity

Returns:

AuthContext for this user if applicable else Empty

Throws:

AuthenticationException