io.knotx.server.configuration

Class RoutingOperationOptions

java.lang.Object

io.knotx.server.configuration.RoutingOperationOptions

public class RoutingOperationOptions
extends java.lang.Object

Routing operation settings that define handlers / error handlers taking part in HTTP request processing. KnotxServerVerticle loads KnotxServerOptions.getRoutingSpecificationLocation() containing Open API specification which describes all endpoints with request / response schemas. Each endpoint defines operationId used in getOperationId().

Constructor Summary

Constructors

Constructor and Description
RoutingOperationOptions(io.vertx.core.json.JsonObject json) Create settings from JSON
RoutingOperationOptions(RoutingOperationOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
java.util.List<RoutingHandlerOptions>	getFailureHandlers()
java.util.List<RoutingHandlerOptions>	getHandlers()
java.lang.String	getOperationId()
RoutingOperationOptions	setFailureHandlers(java.util.List<RoutingHandlerOptions> failureHandlers) Sets list of error handlers definitions for particular operationId.
RoutingOperationOptions	setHandlers(java.util.List<RoutingHandlerOptions> handlers) Sets list of handlers definitions for particular operationId.
RoutingOperationOptions	setOperationId(java.lang.String operationId) Sets operationId name.
io.vertx.core.json.JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoutingOperationOptions

public RoutingOperationOptions(io.vertx.core.json.JsonObject json)

Create settings from JSON

Parameters:

json - the JSON

RoutingOperationOptions

public RoutingOperationOptions(RoutingOperationOptions other)

Copy constructor

Parameters:

other - the instance to copy

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

getOperationId

public java.lang.String getOperationId()

Returns:

operationId name

setOperationId

public RoutingOperationOptions setOperationId(java.lang.String operationId)

Sets operationId name.

Parameters:

operationId - operation identifier

Returns:

reference to this, so the API can be used fluently

getHandlers

public java.util.List<RoutingHandlerOptions> getHandlers()

Returns:

list of handlers definitions used during HTTP request processing

See Also:

OpenAPI3RouterFactory.addHandlerByOperationId(String, Handler)

setHandlers

public RoutingOperationOptions setHandlers(java.util.List<RoutingHandlerOptions> handlers)

Sets list of handlers definitions for particular operationId.

Parameters:

handlers - request handlers

Returns:

reference to this, so the API can be used fluently

See Also:

OpenAPI3RouterFactory.addHandlerByOperationId(String, Handler)

getFailureHandlers

public java.util.List<RoutingHandlerOptions> getFailureHandlers()

Returns:

list of failure handlers definitions used during HTTP request processing

See Also:

OpenAPI3RouterFactory.addFailureHandlerByOperationId(String, Handler)

setFailureHandlers

public RoutingOperationOptions setFailureHandlers(java.util.List<RoutingHandlerOptions> failureHandlers)

Sets list of error handlers definitions for particular operationId.

Parameters:

failureHandlers - request failure handlers

Returns:

reference to this, so the API can be used fluently

See Also:

OpenAPI3RouterFactory.addFailureHandlerByOperationId(String, Handler)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object