public abstract class BaseRouterFactory<Specification> extends Object implements RouterFactory<Specification>
| Modifier and Type | Field and Description |
|---|---|
static Function<RoutingContext,JsonObject> |
DEFAULT_EXTRA_OPERATION_CONTEXT_PAYLOAD_MAPPER
Default extra payload mapper for
OperationRequest. |
static Handler<RoutingContext> |
DEFAULT_NOT_IMPLEMENTED_HANDLER
Default not implemented handler.
|
static Handler<RoutingContext> |
DEFAULT_VALIDATION_FAILURE_HANDLER
Default validation failure handler.
|
protected RouterFactoryOptions |
options |
protected Specification |
spec |
protected Vertx |
vertx |
| Constructor and Description |
|---|
BaseRouterFactory(Vertx vertx,
Specification spec) |
BaseRouterFactory(Vertx vertx,
Specification spec,
RouterFactoryOptions options) |
| Modifier and Type | Method and Description |
|---|---|
RouterFactory |
addGlobalHandler(Handler<RoutingContext> globalHandler)
Add global handler to be applied prior to
Router being generated. |
protected BodyHandler |
getBodyHandler() |
protected Function<RoutingContext,JsonObject> |
getExtraOperationContextPayloadMapper() |
protected List<Handler<RoutingContext>> |
getGlobalHandlers() |
protected Handler<RoutingContext> |
getNotImplementedFailureHandler() |
RouterFactoryOptions |
getOptions()
Get options of router factory.
|
Handler<RoutingContext> |
getValidationFailureHandler() |
RouterFactory |
setBodyHandler(BodyHandler bodyHandler)
Supply your own BodyHandler if you would like to control body limit, uploads directory and deletion of uploaded files
|
RouterFactory |
setExtraOperationContextPayloadMapper(Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper)
When set, this function is called while creating the payload of
OperationRequest |
RouterFactory |
setNotImplementedFailureHandler(Handler<RoutingContext> notImplementedFailureHandler)
Set not implemented failure handler.
|
RouterFactory |
setOptions(RouterFactoryOptions options)
Set options of router factory.
|
RouterFactory |
setValidationFailureHandler(Handler<RoutingContext> validationFailureHandler)
Set default validation failure handler.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddSecurityHandler, getRouterpublic static final Handler<RoutingContext> DEFAULT_VALIDATION_FAILURE_HANDLER
public static final Handler<RoutingContext> DEFAULT_NOT_IMPLEMENTED_HANDLER
public static final Function<RoutingContext,JsonObject> DEFAULT_EXTRA_OPERATION_CONTEXT_PAYLOAD_MAPPER
OperationRequest. By default, no mapper is specifiedprotected Vertx vertx
protected Specification spec
protected RouterFactoryOptions options
public BaseRouterFactory(Vertx vertx, Specification spec, RouterFactoryOptions options)
public BaseRouterFactory(Vertx vertx, Specification spec)
public RouterFactory setOptions(RouterFactoryOptions options)
RouterFactoryRouterFactoryOptionssetOptions in interface RouterFactory<Specification>public RouterFactoryOptions getOptions()
RouterFactoryRouterFactoryOptionsgetOptions in interface RouterFactory<Specification>public Handler<RoutingContext> getValidationFailureHandler()
getValidationFailureHandler in interface RouterFactory<Specification>public RouterFactory setValidationFailureHandler(Handler<RoutingContext> validationFailureHandler)
RouterFactoryRouterFactoryOptions.setMountValidationFailureHandler(boolean)setValidationFailureHandler in interface RouterFactory<Specification>protected Handler<RoutingContext> getNotImplementedFailureHandler()
public RouterFactory setNotImplementedFailureHandler(Handler<RoutingContext> notImplementedFailureHandler)
RouterFactoryRouterFactoryOptions.setMountNotImplementedHandler(boolean)setNotImplementedFailureHandler in interface RouterFactory<Specification>protected BodyHandler getBodyHandler()
public RouterFactory setBodyHandler(BodyHandler bodyHandler)
RouterFactorysetBodyHandler in interface RouterFactory<Specification>protected List<Handler<RoutingContext>> getGlobalHandlers()
public RouterFactory addGlobalHandler(Handler<RoutingContext> globalHandler)
RouterFactoryRouter being generated. RouterFactory.setBodyHandler(BodyHandler)addGlobalHandler in interface RouterFactory<Specification>protected Function<RoutingContext,JsonObject> getExtraOperationContextPayloadMapper()
public RouterFactory setExtraOperationContextPayloadMapper(Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper)
RouterFactoryOperationRequestsetExtraOperationContextPayloadMapper in interface RouterFactory<Specification>Copyright © 2020. All rights reserved.