Package io.vertx.mutiny.ext.web.openapi.router

Class RequestExtractor

java.lang.Object

io.vertx.mutiny.ext.web.openapi.router.RequestExtractor

All Implemented Interfaces:

MutinyDelegate

public class RequestExtractor
extends Object
implements MutinyDelegate

Field Summary

Fields

Modifier and Type	Field	Description
static final TypeArg<RequestExtractor>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
RequestExtractor(io.vertx.ext.web.openapi.router.RequestExtractor delegate)
RequestExtractor(Object delegate)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
io.smallrye.mutiny.Uni<ValidatableRequest>	extractValidatableRequest(RoutingContext routingContext, Operation operation)	Extracts and transforms the parameters and the body of an incoming request into a that can be validated by the RequestValidator.
ValidatableRequest	extractValidatableRequestAndAwait(RoutingContext routingContext, Operation operation)	Blocking variant of extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation).
void	extractValidatableRequestAndForget(RoutingContext routingContext, Operation operation)	Variant of extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation) that ignores the result of the operation.
io.vertx.ext.web.openapi.router.RequestExtractor	getDelegate()
int	hashCode()
static RequestExtractor	newInstance(io.vertx.ext.web.openapi.router.RequestExtractor arg)
String	toString()
static RequestExtractor	withBodyHandler()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

__TYPE_ARG

public static final TypeArg<RequestExtractor> __TYPE_ARG

Constructor Details

RequestExtractor

public RequestExtractor(io.vertx.ext.web.openapi.router.RequestExtractor delegate)

RequestExtractor

public RequestExtractor(Object delegate)

Method Details

getDelegate

public io.vertx.ext.web.openapi.router.RequestExtractor getDelegate()

Specified by:

getDelegate in interface MutinyDelegate

Returns:

the delegate used by this Mutiny object of generated type

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

extractValidatableRequest

@CheckReturnValue
public io.smallrye.mutiny.Uni<ValidatableRequest> extractValidatableRequest(RoutingContext routingContext,
 Operation operation)

Extracts and transforms the parameters and the body of an incoming request into a that can be validated by the RequestValidator.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

routingContext - The routing context of the incoming request.

operation - The operation of the related request.

Returns:

the uni firing the result of the operation when completed, or a failure if the operation failed.

extractValidatableRequestAndAwait

public ValidatableRequest extractValidatableRequestAndAwait(RoutingContext routingContext,
 Operation operation)

Blocking variant of extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

routingContext - The routing context of the incoming request.

operation - The operation of the related request.

Returns:

the ValidatableRequest instance produced by the operation.

extractValidatableRequestAndForget

public void extractValidatableRequestAndForget(RoutingContext routingContext,
 Operation operation)

Variant of extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation) that ignores the result of the operation.

This method subscribes on the result of extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from extractValidatableRequest(io.vertx.mutiny.ext.web.RoutingContext,io.vertx.mutiny.openapi.contract.Operation) but you don't need to compose it with other operations.

Parameters:

routingContext - The routing context of the incoming request.

operation - The operation of the related request.

withBodyHandler

public static RequestExtractor withBodyHandler()

Returns:

a RequestExtractor that works in case that a BodyHandler was applied to the related route.

newInstance

public static RequestExtractor newInstance(io.vertx.ext.web.openapi.router.RequestExtractor arg)