Class SimpleAuthenticationHandler
- java.lang.Object
-
- io.vertx.reactivex.ext.web.handler.SimpleAuthenticationHandler
-
- All Implemented Interfaces:
Handler<RoutingContext>,io.vertx.lang.rx.RxDelegate,AuthenticationHandler
public class SimpleAuthenticationHandler extends Object implements io.vertx.lang.rx.RxDelegate, AuthenticationHandler, Handler<RoutingContext>
A user customizable authentication handler.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
nulluser object. In theauthenticate(java.util.function.Function<io.vertx.reactivex.ext.web.RoutingContext, io.vertx.core.Future<io.vertx.reactivex.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 withChainAuthHandler.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<SimpleAuthenticationHandler>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description SimpleAuthenticationHandler(SimpleAuthenticationHandler delegate)SimpleAuthenticationHandler(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SimpleAuthenticationHandlerauthenticate(Function<RoutingContext,Single<User>> authenticationFunction)This function will allow you to perform authentication the way you intended to.SimpleAuthenticationHandlerauthenticate(Function<RoutingContext,Future<User>> authenticationFunction)This function will allow you to perform authentication the way you intended to.static SimpleAuthenticationHandlercreate()Creates a new instance of the simple authentication handler.booleanequals(Object o)SimpleAuthenticationHandlergetDelegate()voidhandle(RoutingContext event)Something has happened, so handle it.inthashCode()static SimpleAuthenticationHandlernewInstance(SimpleAuthenticationHandler arg)StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<SimpleAuthenticationHandler> __TYPE_ARG
-
-
Constructor Detail
-
SimpleAuthenticationHandler
public SimpleAuthenticationHandler(SimpleAuthenticationHandler delegate)
-
SimpleAuthenticationHandler
public SimpleAuthenticationHandler(Object delegate)
-
-
Method Detail
-
getDelegate
public SimpleAuthenticationHandler getDelegate()
- Specified by:
getDelegatein interfaceAuthenticationHandler- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
handle
public void handle(RoutingContext event)
Something has happened, so handle it.- Specified by:
handlein interfaceAuthenticationHandler- Specified by:
handlein interfaceHandler<RoutingContext>- Parameters:
event- the event to handle
-
create
public static SimpleAuthenticationHandler create()
Creates a new instance of the simple authentication handler.- Returns:
- a new instance.
-
authenticate
public SimpleAuthenticationHandler authenticate(Function<RoutingContext,Future<User>> authenticationFunction)
This function will allow you to perform authentication the way you intended to. The process should be self explanatory, for example if the request contains a given property completing the function with a nonnullobject is enough to allow the handler to continue. In order to signal errors, you should not call or . Errors should be signaled using theHttpExceptiontype. 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 withChainAuthHandler. By using exceptions to signal failures instead of immediately terminating the request, it allows the chain to proceed to the next handler if needed.- Parameters:
authenticationFunction- the authentication function.- Returns:
- self
-
authenticate
public SimpleAuthenticationHandler authenticate(Function<RoutingContext,Single<User>> authenticationFunction)
This function will allow you to perform authentication the way you intended to. The process should be self explanatory, for example if the request contains a given property completing the function with a nonnullobject is enough to allow the handler to continue. In order to signal errors, you should not call or . Errors should be signaled using theHttpExceptiontype. 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 withChainAuthHandler. By using exceptions to signal failures instead of immediately terminating the request, it allows the chain to proceed to the next handler if needed.- Parameters:
authenticationFunction- the authentication function.- Returns:
- self
-
newInstance
public static SimpleAuthenticationHandler newInstance(SimpleAuthenticationHandler arg)
-
-