public class SimpleAuthenticationHandler extends Object implements AuthenticationHandler, Handler<RoutingContext>
An auth handler allows your application to provide authentication support. The handler is not fully functional
without a authentication function. This function takes the as input and returns a .
The future should return a non null
user object. In the authenticate(java.util.function.Function<io.vertx.rxjava.ext.web.RoutingContext, io.vertx.core.Future<io.vertx.rxjava.ext.auth.User>>)
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
.
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<SimpleAuthenticationHandler> |
__TYPE_ARG |
Constructor and Description |
---|
SimpleAuthenticationHandler(Object delegate) |
SimpleAuthenticationHandler(SimpleAuthenticationHandler delegate) |
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.
|
boolean |
equals(Object o) |
SimpleAuthenticationHandler |
getDelegate() |
void |
handle(RoutingContext event)
Something has happened, so handle it.
|
int |
hashCode() |
static SimpleAuthenticationHandler |
newInstance(SimpleAuthenticationHandler arg) |
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
newInstance
public static final io.vertx.lang.rx.TypeArg<SimpleAuthenticationHandler> __TYPE_ARG
public SimpleAuthenticationHandler(SimpleAuthenticationHandler delegate)
public SimpleAuthenticationHandler(Object delegate)
public SimpleAuthenticationHandler getDelegate()
getDelegate
in interface AuthenticationHandler
public void handle(RoutingContext event)
handle
in interface Handler<RoutingContext>
handle
in interface AuthenticationHandler
event
- the event to handlepublic static SimpleAuthenticationHandler create()
public SimpleAuthenticationHandler authenticate(java.util.function.Function<RoutingContext,Future<User>> authenticationFunction)
null
object is enough to allow the handler to continue.
In order to signal errors, you should not call or .
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.public static SimpleAuthenticationHandler newInstance(SimpleAuthenticationHandler arg)
Copyright © 2023 Eclipse. All rights reserved.