public interface SimpleAuthenticationHandler extends AuthenticationHandler
An auth handler allows your application to provide authentication support. The handler is not fully functional
without a authentication function. This function takes the RoutingContext
as input and returns a Future
.
The future should return a non null
user object. In the authenticate(Function)
you have full control
on the request, so all operations like redirect, next, fail are allowed. There are some rules that need to be followed
in order to allow this handler to properly interop with ChainAuthHandler
.
Modifier and Type | Method and Description |
---|---|
SimpleAuthenticationHandler |
authenticate(java.util.function.Function<RoutingContext,Future<User>> authenticationFunction)
This function will allow you to perform authentication the way you intended to.
|
static SimpleAuthenticationHandler |
create()
Creates a new instance of the simple authentication handler.
|
static SimpleAuthenticationHandler create()
SimpleAuthenticationHandler authenticate(java.util.function.Function<RoutingContext,Future<User>> authenticationFunction)
null
User
object is enough to allow the handler to continue.
In order to signal errors, you should not call RoutingContext.fail(int)
or RoutingContext.fail(Throwable)
.
Errors should be signaled using the HttpException
type. Any other kind of errors will be wrapped as a 401
error. For example forbidden access should be signaled with: new HttpException(403)
. This is required when
working with ChainAuthHandler
. By using exceptions to signal failures instead of immediately terminating
the request, it allows the chain to proceed to the next handler if needed.authenticationFunction
- the authentication function.Copyright © 2023 Eclipse. All rights reserved.