SimpleAuthenticationHandler (SmallRye Mutiny - Client APIs 2.18.1 API)

java.lang.Object
- io.vertx.mutiny.ext.web.handler.SimpleAuthenticationHandler

All Implemented Interfaces:

io.vertx.core.Handler<RoutingContext>, AuthenticationHandler, Consumer<RoutingContext>
```
public class SimpleAuthenticationHandler
extends Object
implements AuthenticationHandler, io.vertx.core.Handler<RoutingContext>, Consumer<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 null user object. In the authenticate(java.util.function.Function<io.vertx.mutiny.ext.web.RoutingContext, io.smallrye.mutiny.Uni<io.vertx.mutiny.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.
NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field Description

static TypeArg<SimpleAuthenticationHandler> __TYPE_ARG

Constructor Summary

Constructors
Constructor Description

SimpleAuthenticationHandler(io.vertx.ext.web.handler.SimpleAuthenticationHandler delegate)

SimpleAuthenticationHandler(Object delegate)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(RoutingContext item)`
`SimpleAuthenticationHandler`	`authenticate(Function<RoutingContext,io.smallrye.mutiny.Uni<User>> authenticationFunction)`
`static SimpleAuthenticationHandler`	`create()`
`boolean`	`equals(Object o)`
`io.vertx.ext.web.handler.SimpleAuthenticationHandler`	`getDelegate()`
`void`	`handle(RoutingContext arg0)`
`int`	`hashCode()`
`static SimpleAuthenticationHandler`	`newInstance(io.vertx.ext.web.handler.SimpleAuthenticationHandler arg)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Consumer
andThen

Field Detail

__TYPE_ARG

public static final TypeArg<SimpleAuthenticationHandler> __TYPE_ARG

Constructor Detail

SimpleAuthenticationHandler

public SimpleAuthenticationHandler(io.vertx.ext.web.handler.SimpleAuthenticationHandler delegate)

SimpleAuthenticationHandler

public SimpleAuthenticationHandler(Object delegate)

Method Detail

getDelegate

public io.vertx.ext.web.handler.SimpleAuthenticationHandler getDelegate()

Specified by:: getDelegate in interface AuthenticationHandler

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

handle
```
public void handle(RoutingContext arg0)
```
Specified by:

handle in interface AuthenticationHandler

Specified by:

handle in interface io.vertx.core.Handler<RoutingContext>

create

public static SimpleAuthenticationHandler create()

Returns:: a new instance.

authenticate

public SimpleAuthenticationHandler authenticate(Function<RoutingContext,io.smallrye.mutiny.Uni<User>> authenticationFunction)

Parameters:: authenticationFunction - the authentication function.
Returns:: self

accept
```
public void accept(RoutingContext item)
```
Specified by:

accept in interface AuthenticationHandler

Specified by:

accept in interface Consumer<RoutingContext>

newInstance

public static SimpleAuthenticationHandler newInstance(io.vertx.ext.web.handler.SimpleAuthenticationHandler arg)