Class OpenAPIRoute
- java.lang.Object
-
- io.vertx.rxjava3.ext.web.openapi.router.OpenAPIRoute
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class OpenAPIRoute extends Object implements io.vertx.lang.rx.RxDelegate
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<OpenAPIRoute>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description OpenAPIRoute(OpenAPIRoute delegate)OpenAPIRoute(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenAPIRouteaddFailureHandler(Handler<RoutingContext> handler)Adds a failure handler for this routeOpenAPIRouteaddHandler(Handler<RoutingContext> handler)Adds a handler for this route which is executed after the security and validation handlers defined in the contractbooleandoSecurity()booleandoValidation()booleanequals(Object o)OpenAPIRoutegetDelegate()OperationgetOperation()inthashCode()static OpenAPIRoutenewInstance(OpenAPIRoute arg)OpenAPIRoutesetDoSecurity(boolean doSecurity)Sets the security flag for incoming requests.OpenAPIRoutesetDoValidation(boolean doValidation)Sets the validation flag for incoming requests.StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<OpenAPIRoute> __TYPE_ARG
-
-
Constructor Detail
-
OpenAPIRoute
public OpenAPIRoute(OpenAPIRoute delegate)
-
OpenAPIRoute
public OpenAPIRoute(Object delegate)
-
-
Method Detail
-
getDelegate
public OpenAPIRoute getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
addHandler
public OpenAPIRoute addHandler(Handler<RoutingContext> handler)
Adds a handler for this route which is executed after the security and validation handlers defined in the contract- Parameters:
handler- The handler to add- Returns:
- the route
-
addFailureHandler
public OpenAPIRoute addFailureHandler(Handler<RoutingContext> handler)
Adds a failure handler for this route- Parameters:
handler- The failure handler to add- Returns:
- the route
-
getOperation
public Operation getOperation()
- Returns:
- the related operation of this route
-
doValidation
public boolean doValidation()
- Returns:
- true if validation based on the OpenAPI contract is active for this route. By default, it is active.
-
setDoValidation
public OpenAPIRoute setDoValidation(boolean doValidation)
Sets the validation flag for incoming requests.- Parameters:
doValidation- The validation flag.- Returns:
- the route
-
doSecurity
public boolean doSecurity()
- Returns:
- true if security checks based on the OpenAPI contract are active for this route. By default, it is active.
-
setDoSecurity
public OpenAPIRoute setDoSecurity(boolean doSecurity)
Sets the security flag for incoming requests.- Parameters:
doSecurity- The security flag.- Returns:
- the route
-
newInstance
public static OpenAPIRoute newInstance(OpenAPIRoute arg)
-
-