| Modifier and Type | Method and Description |
|---|---|
void |
HystrixMetricEventStream.handle(RoutingContext rc) |
| Modifier and Type | Method and Description |
|---|---|
void |
HealthCheckHandlerImpl.handle(RoutingContext rc) |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
RoutingContext.addCookie(Cookie cookie)
Add a cookie.
|
default RoutingContext |
RoutingContext.attachment(String filename)
Set Content-Disposition get to "attachment" with optional
filename mime type. |
default RoutingContext |
RoutingContext.end(Buffer buffer,
Handler<AsyncResult<Void>> handler)
See
end(Buffer) |
default RoutingContext |
RoutingContext.end(Handler<AsyncResult<Void>> handler)
See
end() |
default RoutingContext |
RoutingContext.end(String chunk,
Handler<AsyncResult<Void>> handler)
See
end(String) |
default RoutingContext |
RoutingContext.etag(String etag)
Set the ETag of a response.
|
default RoutingContext |
RoutingContext.json(Object json,
Handler<AsyncResult<Void>> handler)
See
json(Object). |
default RoutingContext |
RoutingContext.lastModified(Instant instant)
Set the Last-Modified date using a Instant.
|
default RoutingContext |
RoutingContext.lastModified(String instant)
Set the Last-Modified date using a String.
|
RoutingContext |
RoutingContext.put(String key,
Object obj)
Put some arbitrary data in the context.
|
default RoutingContext |
RoutingContext.redirect(String url,
Handler<AsyncResult<Void>> handler)
See
redirect(String). |
| Modifier and Type | Method and Description |
|---|---|
void |
Router.handleContext(RoutingContext context)
Used to route a context to the router.
|
void |
Router.handleFailure(RoutingContext context)
Used to route a failure to the router.
|
| Modifier and Type | Method and Description |
|---|---|
Route |
Route.blockingHandler(Handler<RoutingContext> requestHandler)
Like
Route.blockingHandler(Handler, boolean) called with ordered = true |
Route |
Route.blockingHandler(Handler<RoutingContext> requestHandler,
boolean ordered)
Specify a blocking request handler for the route.
|
Router |
Router.errorHandler(int statusCode,
Handler<RoutingContext> errorHandler)
Specify an handler to handle an error for a particular status code.
|
Route |
Route.failureHandler(Handler<RoutingContext> failureHandler)
Append a failure handler to the route failure handlers list.
|
Route |
Route.handler(Handler<RoutingContext> requestHandler)
Append a request handler to the route handlers list.
|
default <T> Route |
Route.respond(Function<RoutingContext,Future<T>> function)
Append a function request handler to the route handlers list.
|
| Modifier and Type | Method and Description |
|---|---|
Handler<RoutingContext> |
RouterFactory.getValidationFailureHandler()
Deprecated.
Router Factory won't manage the validation errors anymore. You must use
Router.errorHandler(int, Handler) with 400 error |
| Modifier and Type | Method and Description |
|---|---|
RouterFactory |
RouterFactory.addGlobalHandler(Handler<RoutingContext> globalHandler)
Deprecated.
Add global handler to be applied prior to
Router being generated. |
RouterFactory |
RouterFactory.addSecurityHandler(String securitySchemaName,
Handler<RoutingContext> handler)
Deprecated.
Mount to paths that have to follow a security schema a security handler
|
RouterFactory |
RouterFactory.setExtraOperationContextPayloadMapper(Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper)
Deprecated.
When set, this function is called while creating the payload of
OperationRequest |
RouterFactory |
RouterFactory.setNotImplementedFailureHandler(Handler<RoutingContext> notImplementedFailureHandler)
Deprecated.
You must use
Router.errorHandler(int, Handler) with 501 error |
RouterFactory |
RouterFactory.setValidationFailureHandler(Handler<RoutingContext> validationFailureHandler)
Deprecated.
Router Factory won't manage the validation errors anymore. You must use
Router.errorHandler(int, Handler) with 400 error |
| Modifier and Type | Field and Description |
|---|---|
static Function<RoutingContext,JsonObject> |
BaseRouterFactory.DEFAULT_EXTRA_OPERATION_CONTEXT_PAYLOAD_MAPPER
Default extra payload mapper for
OperationRequest. |
static Handler<RoutingContext> |
BaseRouterFactory.DEFAULT_NOT_IMPLEMENTED_HANDLER
Default not implemented handler.
|
static Handler<RoutingContext> |
BaseRouterFactory.DEFAULT_VALIDATION_FAILURE_HANDLER
Default validation failure handler.
|
| Modifier and Type | Method and Description |
|---|---|
protected Function<RoutingContext,JsonObject> |
BaseRouterFactory.getExtraOperationContextPayloadMapper() |
protected List<Handler<RoutingContext>> |
BaseRouterFactory.getGlobalHandlers() |
protected Handler<RoutingContext> |
BaseRouterFactory.getNotImplementedFailureHandler() |
Handler<RoutingContext> |
BaseRouterFactory.getValidationFailureHandler() |
| Modifier and Type | Method and Description |
|---|---|
void |
RouteToEBServiceHandler.handle(RoutingContext routingContext) |
| Modifier and Type | Method and Description |
|---|---|
RouterFactory |
BaseRouterFactory.addGlobalHandler(Handler<RoutingContext> globalHandler) |
static RouteToEBServiceHandler |
RouteToEBServiceHandler.build(EventBus eventBus,
String address,
String actionName,
Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper) |
static RouteToEBServiceHandler |
RouteToEBServiceHandler.build(EventBus eventBus,
String address,
String actionName,
JsonObject deliveryOptions,
Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper) |
RouterFactory |
BaseRouterFactory.setExtraOperationContextPayloadMapper(Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper) |
RouterFactory |
BaseRouterFactory.setNotImplementedFailureHandler(Handler<RoutingContext> notImplementedFailureHandler) |
RouterFactory |
BaseRouterFactory.setValidationFailureHandler(Handler<RoutingContext> validationFailureHandler) |
| Constructor and Description |
|---|
RouteToEBServiceHandler(EventBus eventBus,
String address,
DeliveryOptions deliveryOptions,
Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper) |
| Modifier and Type | Method and Description |
|---|---|
OpenAPI3RouterFactory |
OpenAPI3RouterFactory.addFailureHandlerByOperationId(String operationId,
Handler<RoutingContext> failureHandler)
Deprecated.
Add a failure handler by operation_id field in Operation object
|
OpenAPI3RouterFactory |
OpenAPI3RouterFactory.addHandlerByOperationId(String operationId,
Handler<RoutingContext> handler)
Deprecated.
Add an handler by operation_id field in Operation object
|
OpenAPI3RouterFactory |
OpenAPI3RouterFactory.addSecuritySchemaScopeValidator(String securitySchemaName,
String scopeName,
Handler<RoutingContext> handler)
Deprecated.
Add a particular scope validator.
|
| Modifier and Type | Method and Description |
|---|---|
OpenAPI3RouterFactory |
OpenAPI3RouterFactoryImpl.addFailureHandlerByOperationId(String operationId,
Handler<RoutingContext> failureHandler) |
OpenAPI3RouterFactory |
OpenAPI3RouterFactoryImpl.addHandlerByOperationId(String operationId,
Handler<RoutingContext> handler) |
| Modifier and Type | Method and Description |
|---|---|
RouteToEBServiceHandler |
RouteToEBServiceHandler.extraPayloadMapper(Function<RoutingContext,JsonObject> extraPayloadMapper)
When
extraPayloadMapper is configured, this handler puts the evaluation result into ServiceRequest.getExtra() |
| Modifier and Type | Method and Description |
|---|---|
void |
RouteToEBServiceHandlerImpl.handle(RoutingContext routingContext) |
| Modifier and Type | Method and Description |
|---|---|
RouteToEBServiceHandlerImpl |
RouteToEBServiceHandlerImpl.extraPayloadMapper(Function<RoutingContext,JsonObject> extraPayloadMapper) |
| Modifier and Type | Method and Description |
|---|---|
void |
CustomValidator.validate(RoutingContext routingContext)
Deprecated.
This function have to be synchronous.
|
| Modifier and Type | Method and Description |
|---|---|
void |
BaseValidationHandler.handle(RoutingContext routingContext) |
| Modifier and Type | Method and Description |
|---|---|
default String |
AuthenticationHandler.authenticateHeader(RoutingContext context)
Returns
|
default Future<Void> |
SessionHandler.flush(RoutingContext ctx)
Promisified flush.
|
default Future<Void> |
SessionHandler.flush(RoutingContext ctx,
boolean ignoreStatus)
Promisified flush.
|
SessionHandler |
SessionHandler.flush(RoutingContext ctx,
boolean ignoreStatus,
Handler<AsyncResult<Void>> handler)
Flush a context session earlier to the store, this will allow the end user to have full control on the event of
a failure at the store level.
|
SessionHandler |
SessionHandler.flush(RoutingContext ctx,
Handler<AsyncResult<Void>> handler)
Flush a context session earlier to the store, this will allow the end user to have full control on the event of
a failure at the store level.
|
Session |
SessionHandler.newSession(RoutingContext context)
Create a new session
|
default Future<Credentials> |
AuthenticationHandler.parseCredentials(RoutingContext context) |
void |
AuthenticationHandler.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler)
Parses the credentials from the request into a JsonObject.
|
default void |
AuthenticationHandler.postAuthentication(RoutingContext ctx)
This method is called to perform any post authentication tasks, such as redirects.
|
Future<Void> |
SessionHandler.setUser(RoutingContext context,
User user)
Set the user for the session
|
default SessionHandler |
SessionHandler.setUser(RoutingContext context,
User user,
Handler<AsyncResult<Void>> handler)
Set the user for the session
|
| Modifier and Type | Method and Description |
|---|---|
MultiTenantHandler |
MultiTenantHandler.addDefaultHandler(Handler<RoutingContext> handler)
Add a default handler for the case when no tenant was matched.
|
MultiTenantHandler |
MultiTenantHandler.addTenantHandler(String tenant,
Handler<RoutingContext> handler)
Add a handler for a given tenant to this handler.
|
static MultiTenantHandler |
MultiTenantHandler.create(Function<RoutingContext,String> tenantExtractor)
Create a MultiTenant handler using a custom tenant extraction function.
|
static MultiTenantHandler |
MultiTenantHandler.create(Function<RoutingContext,String> tenantExtractor,
String contextKey)
Create a MultiTenant handler using a custom tenant extraction function.
|
AuthorizationHandler |
AuthorizationHandler.variableConsumer(BiConsumer<RoutingContext,AuthorizationContext> handler)
Provide a simple handler to extract needed variables.
|
| Modifier and Type | Method and Description |
|---|---|
GraphQLHandler |
GraphQLHandler.dataLoaderRegistry(Function<RoutingContext,org.dataloader.DataLoaderRegistry> factory)
Customize the
DataLoaderRegistry. |
GraphiQLHandler |
GraphiQLHandler.graphiQLRequestHeaders(Function<RoutingContext,MultiMap> factory)
Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface.
|
GraphQLHandler |
GraphQLHandler.locale(Function<RoutingContext,Locale> factory)
Customize the
Locale passed to the GraphQL execution engine. |
GraphQLHandler |
GraphQLHandler.queryContext(Function<RoutingContext,Object> factory)
Customize the query context object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
GraphiQLHandlerImpl.handle(RoutingContext rc) |
void |
GraphQLHandlerImpl.handle(RoutingContext rc) |
void |
ApolloWSHandlerImpl.handle(RoutingContext routingContext) |
| Modifier and Type | Method and Description |
|---|---|
GraphQLHandler |
GraphQLHandlerImpl.dataLoaderRegistry(Function<RoutingContext,org.dataloader.DataLoaderRegistry> factory) |
GraphiQLHandler |
GraphiQLHandlerImpl.graphiQLRequestHeaders(Function<RoutingContext,MultiMap> factory) |
GraphQLHandler |
GraphQLHandlerImpl.locale(Function<RoutingContext,Locale> factory) |
GraphQLHandler |
GraphQLHandlerImpl.queryContext(Function<RoutingContext,Object> factory) |
| Modifier and Type | Method and Description |
|---|---|
String |
HTTPAuthorizationHandler.authenticateHeader(RoutingContext context)
Returns
|
String |
DigestAuthHandlerImpl.authenticateHeader(RoutingContext context) |
String |
ChainAuthHandlerImpl.authenticateHeader(RoutingContext ctx) |
SessionHandler |
SessionHandlerImpl.flush(RoutingContext context,
boolean ignoreStatus,
Handler<AsyncResult<Void>> handler) |
SessionHandler |
SessionHandlerImpl.flush(RoutingContext context,
Handler<AsyncResult<Void>> handler) |
protected AuthenticationProvider |
AuthenticationHandlerImpl.getAuthProvider(RoutingContext ctx) |
void |
SessionHandlerImpl.handle(RoutingContext context) |
void |
ResponseTimeHandlerImpl.handle(RoutingContext ctx) |
void |
ResponseContentTypeHandlerImpl.handle(RoutingContext rc) |
void |
MultiTenantHandlerImpl.handle(RoutingContext ctx) |
void |
MethodOverrideHandlerImpl.handle(RoutingContext context) |
void |
FaviconHandlerImpl.handle(RoutingContext ctx) |
void |
ErrorHandlerImpl.handle(RoutingContext context) |
void |
CorsHandlerImpl.handle(RoutingContext context) |
void |
CSRFHandlerImpl.handle(RoutingContext ctx) |
void |
CSPHandlerImpl.handle(RoutingContext ctx) |
void |
BodyHandlerImpl.handle(RoutingContext context) |
void |
AuthorizationHandlerImpl.handle(RoutingContext routingContext) |
void |
AuthenticationHandlerImpl.handle(RoutingContext ctx) |
void |
AuthHandlerImpl.handle(RoutingContext ctx)
Deprecated.
|
void |
WebAuthnHandlerImpl.handle(RoutingContext ctx) |
void |
TimeoutHandlerImpl.handle(RoutingContext ctx) |
void |
LoggerHandlerImpl.handle(RoutingContext context) |
void |
TemplateHandlerImpl.handle(RoutingContext context) |
void |
StaticHandlerImpl.handle(RoutingContext context) |
Session |
SessionHandlerImpl.newSession(RoutingContext context) |
protected void |
HTTPAuthorizationHandler.parseAuthorization(RoutingContext ctx,
boolean optional,
Handler<AsyncResult<String>> handler) |
void |
RedirectAuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
OAuth2AuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
JWTAuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
FormLoginHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
DigestAuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
ChainAuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
BasicAuthHandlerImpl.parseCredentials(RoutingContext context,
Handler<AsyncResult<Credentials>> handler) |
void |
FormLoginHandlerImpl.postAuthentication(RoutingContext ctx) |
protected void |
AuthenticationHandlerImpl.processException(RoutingContext ctx,
Throwable exception)
This method is protected so custom auth handlers can override the default
error handling
|
protected void |
AuthHandlerImpl.processException(RoutingContext ctx,
Throwable exception)
Deprecated.
This method is protected so custom auth handlers can override the default
error handling
|
void |
UserHolder.refresh(RoutingContext context) |
Future<Void> |
SessionHandlerImpl.setUser(RoutingContext context,
User user) |
| Modifier and Type | Method and Description |
|---|---|
MultiTenantHandler |
MultiTenantHandlerImpl.addDefaultHandler(Handler<RoutingContext> handler) |
MultiTenantHandler |
MultiTenantHandlerImpl.addTenantHandler(String tenant,
Handler<RoutingContext> handler) |
AuthorizationHandler |
AuthorizationHandlerImpl.variableConsumer(BiConsumer<RoutingContext,AuthorizationContext> handler) |
| Constructor and Description |
|---|
UserHolder(RoutingContext context) |
| Constructor and Description |
|---|
MultiTenantHandlerImpl(Function<RoutingContext,String> tenantExtractor,
String contextKey) |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
SockJSSocket.routingContext() |
| Modifier and Type | Method and Description |
|---|---|
void |
SockJSHandler.handle(RoutingContext routingContext)
Deprecated.
mount the router as a sub-router instead. This method will not properly handle errors.
|
| Modifier and Type | Field and Description |
|---|---|
protected RoutingContext |
SockJSSocketBase.routingContext |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
SockJSSocketBase.routingContext() |
| Modifier and Type | Method and Description |
|---|---|
void |
SockJSHandlerImpl.handle(RoutingContext context)
Deprecated.
|
| Constructor and Description |
|---|
SockJSSocketBase(Vertx vertx,
RoutingContext rc,
SockJSHandlerOptions options) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
RoutingContextInternal
Internal methods that are not expected or prime to be in the public API
|
| Modifier and Type | Class and Description |
|---|---|
class |
RoutingContextDecorator
Decorate a
RoutingContext and simply delegate all method calls to the decorated handler |
class |
RoutingContextImpl |
class |
RoutingContextImplBase |
class |
RoutingContextWrapper |
| Modifier and Type | Field and Description |
|---|---|
protected RoutingContext |
RoutingContextWrapper.inner |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
RoutingContextWrapper.addCookie(Cookie cookie) |
RoutingContext |
RoutingContextImpl.addCookie(Cookie cookie) |
RoutingContext |
RoutingContextDecorator.addCookie(Cookie cookie) |
RoutingContext |
RoutingContextWrapper.put(String key,
Object obj) |
RoutingContext |
RoutingContextImpl.put(String key,
Object obj) |
RoutingContext |
RoutingContextDecorator.put(String key,
Object obj) |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
Utils.fresh(RoutingContext ctx) |
static boolean |
Utils.fresh(RoutingContext ctx,
long lastModified) |
void |
BlockingHandlerDecorator.handle(RoutingContext context) |
void |
RouterImpl.handleContext(RoutingContext ctx) |
void |
RouterImpl.handleFailure(RoutingContext ctx) |
static String |
Utils.pathOffset(String path,
RoutingContext context) |
| Modifier and Type | Method and Description |
|---|---|
Route |
RouteImpl.blockingHandler(Handler<RoutingContext> contextHandler) |
Route |
RouteImpl.blockingHandler(Handler<RoutingContext> contextHandler,
boolean ordered) |
Router |
RouterImpl.errorHandler(int statusCode,
Handler<RoutingContext> errorHandler) |
Route |
RouteImpl.failureHandler(Handler<RoutingContext> exceptionHandler) |
Route |
RouteImpl.handler(Handler<RoutingContext> contextHandler) |
| Constructor and Description |
|---|
RoutingContextDecorator(Route currentRoute,
RoutingContext decoratedContext) |
RoutingContextWrapper(String mountPoint,
Set<RouteImpl> iter,
RoutingContext inner) |
| Constructor and Description |
|---|
BlockingHandlerDecorator(Handler<RoutingContext> decoratedHandler,
boolean ordered) |
| Modifier and Type | Method and Description |
|---|---|
Operation |
Operation.failureHandler(Handler<RoutingContext> handler)
Mount a failure handler for this operation
|
Operation |
Operation.handler(Handler<RoutingContext> handler)
Mount an handler for this operation
|
RouterBuilder |
RouterBuilder.rootHandler(Handler<RoutingContext> rootHandler)
Add global handler to be applied prior to
Router being generated. |
RouterBuilder |
RouterBuilder.serviceExtraPayloadMapper(Function<RoutingContext,JsonObject> serviceExtraPayloadMapper)
When set, this function is called while creating the payload of
ServiceRequest |
| Modifier and Type | Method and Description |
|---|---|
protected List<Handler<RoutingContext>> |
OperationImpl.getUserFailureHandlers() |
protected List<Handler<RoutingContext>> |
OperationImpl.getUserHandlers() |
| Modifier and Type | Method and Description |
|---|---|
void |
ContractEndpointHandler.handle(RoutingContext context) |
boolean |
ContractEndpointHandler.responseAsJson(RoutingContext context) |
| Modifier and Type | Method and Description |
|---|---|
void |
GeneratorContext.addPredicate(Function<RoutingContext,RequestPredicateResult> predicate) |
Operation |
OperationImpl.failureHandler(Handler<RoutingContext> handler) |
Operation |
OperationImpl.handler(Handler<RoutingContext> handler) |
RouterBuilder |
OpenAPI3RouterBuilderImpl.rootHandler(Handler<RoutingContext> rootHandler) |
RouterBuilder |
OpenAPI3RouterBuilderImpl.serviceExtraPayloadMapper(Function<RoutingContext,JsonObject> serviceExtraPayloadMapper) |
| Modifier and Type | Method and Description |
|---|---|
void |
ValidationHandlerImpl.handle(RoutingContext routingContext) |
| Constructor and Description |
|---|
ValidationHandlerImpl(Map<ParameterLocation,List<ParameterProcessor>> parameterProcessors,
List<BodyProcessor> bodyProcessors,
List<Function<RoutingContext,RequestPredicateResult>> predicates) |
| Modifier and Type | Method and Description |
|---|---|
Future<RequestParameter> |
TextPlainBodyProcessorImpl.process(RoutingContext requestContext) |
Future<RequestParameter> |
JsonBodyProcessorImpl.process(RoutingContext requestContext) |
Future<RequestParameter> |
FormBodyProcessorImpl.process(RoutingContext requestContext) |
Future<RequestParameter> |
BodyProcessor.process(RoutingContext requestContext) |
| Modifier and Type | Method and Description |
|---|---|
static Handler<RoutingContext> |
PrometheusScrapingHandler.create()
Creates a Vert.x Web
Route handler for Prometheus metrics scraping. |
static Handler<RoutingContext> |
PrometheusScrapingHandler.create(String registryName)
Creates a Vert.x Web
Route handler for Prometheus metrics scraping. |
| Modifier and Type | Method and Description |
|---|---|
void |
PrometheusScrapingHandlerImpl.handle(RoutingContext rc) |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
RoutingContext.getDelegate() |
| Modifier and Type | Method and Description |
|---|---|
static RoutingContext |
RoutingContext.newInstance(RoutingContext arg) |
| Constructor and Description |
|---|
RoutingContext(RoutingContext delegate) |
| Modifier and Type | Method and Description |
|---|---|
RoutingContext |
RoutingContext.getDelegate() |
| Modifier and Type | Method and Description |
|---|---|
static RoutingContext |
RoutingContext.newInstance(RoutingContext arg) |
| Constructor and Description |
|---|
RoutingContext(RoutingContext delegate) |
Copyright © 2021. All rights reserved.