io.knotx.server.configuration

Class KnotxServerOptions

java.lang.Object

io.knotx.server.configuration.KnotxServerOptions

public class KnotxServerOptions
extends java.lang.Object

Describes a Knot.x HTTP Server configuration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DropRequestOptions	getDropRequestOptions()
java.util.List<RoutingHandlerOptions>	getGlobalHandlers()
HystrixMetricsOptions	getHystrixMetricsOptions()
java.util.List<RoutingOperationOptions>	getRoutingOperations() List of RoutingOperationOptions containing handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and joined with Open API operations based on operationId.
java.lang.String	getRoutingSpecificationLocation()
java.util.List<AuthHandlerOptions>	getSecurityHandlers() List of AuthHandlerOptions containing auth handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and joined with Open API security schemas based on AuthHandlerOptions schema name.
io.vertx.core.http.HttpServerOptions	getServerOptions()
boolean	isDisplayExceptionDetails()
KnotxServerOptions	setDisplayExceptionDetails(boolean displayExceptionDetails) Set whether to display or not the exception on error pages
KnotxServerOptions	setDropRequestOptions(DropRequestOptions dropRequestOptions) Set the drop request options (see DropRequestOptions)
KnotxServerOptions	setGlobalHandlers(java.util.List<RoutingHandlerOptions> globalHandlers) List of RoutingHandlerOptions containing handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and applied to each route.
KnotxServerOptions	setHystrixMetricsOptions(HystrixMetricsOptions hystrixMetricsOptions) Set the Hystrix Metrics options (see HystrixMetricsOptions).
KnotxServerOptions	setRoutingOperations(java.util.List<RoutingOperationOptions> routingOperations) Set list of RoutingOperationOptions.
KnotxServerOptions	setRoutingSpecificationLocation(java.lang.String routingSpecificationLocation) Location of your spec.
KnotxServerOptions	setSecurityHandlers(java.util.List<AuthHandlerOptions> securityHandlers) Set list of AuthHandlerOptions.
KnotxServerOptions	setServerOptions(io.vertx.core.http.HttpServerOptions serverOptions) Set the HTTP Server options
io.vertx.core.json.JsonObject	toJson() Convert to JSON
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KnotxServerOptions

public KnotxServerOptions()

Default constructor

KnotxServerOptions

public KnotxServerOptions(KnotxServerOptions other)

Copy constructor

Parameters:

other - the instance to copy

KnotxServerOptions

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

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

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

Convert to JSON

Returns:

the JSON

isDisplayExceptionDetails

public boolean isDisplayExceptionDetails()

Returns:

whether to display or not exceptions on error pages

setDisplayExceptionDetails

public KnotxServerOptions setDisplayExceptionDetails(boolean displayExceptionDetails)

Set whether to display or not the exception on error pages

Parameters:

displayExceptionDetails - displays exceptions on error pages if true

Returns:

reference to this, so the API can be used fluently

getServerOptions

public io.vertx.core.http.HttpServerOptions getServerOptions()

Returns:

io.vertx.core.http.HttpServerOptions

setServerOptions

public KnotxServerOptions setServerOptions(io.vertx.core.http.HttpServerOptions serverOptions)

Set the HTTP Server options

Parameters:

serverOptions - io.vertx.core.http.HttpServerOptions object

Returns:

reference to this, so the API can be used fluently

getRoutingSpecificationLocation

public java.lang.String getRoutingSpecificationLocation()

Returns:

location of your spec. It can be an absolute path, a local path or remote url (with HTTP protocol)

setRoutingSpecificationLocation

public KnotxServerOptions setRoutingSpecificationLocation(java.lang.String routingSpecificationLocation)

Location of your spec. It can be an absolute path, a local path or remote url (with HTTP protocol).

Parameters:

routingSpecificationLocation - routing specification location

Returns:

reference to this, so the API can be used fluently

See Also:

OpenAPI3RouterFactory.rxCreate(Vertx, String)

getGlobalHandlers

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

Returns:

list of global routing operations options

setGlobalHandlers

public KnotxServerOptions setGlobalHandlers(java.util.List<RoutingHandlerOptions> globalHandlers)

List of RoutingHandlerOptions containing handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and applied to each route.

Parameters:

globalHandlers - global routing operations

Returns:

reference to this, so the API can be used fluently

getSecurityHandlers

public java.util.List<AuthHandlerOptions> getSecurityHandlers()

List of AuthHandlerOptions containing auth handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and joined with Open API security schemas based on AuthHandlerOptions schema name.

Returns:

list of auth handlers options

setSecurityHandlers

public KnotxServerOptions setSecurityHandlers(java.util.List<AuthHandlerOptions> securityHandlers)

Set list of AuthHandlerOptions.

Parameters:

securityHandlers - auth handlers options

Returns:

reference to this, so the API can be used fluently

getRoutingOperations

public java.util.List<RoutingOperationOptions> getRoutingOperations()

List of RoutingOperationOptions containing handlers configurations which are initiated (loaded from classpath via java.util.ServiceLoader) during server setup and joined with Open API operations based on operationId.

Returns:

list of routing operations options

setRoutingOperations

public KnotxServerOptions setRoutingOperations(java.util.List<RoutingOperationOptions> routingOperations)

Set list of RoutingOperationOptions.

Parameters:

routingOperations - routing operations options

Returns:

reference to this, so the API can be used fluently

getDropRequestOptions

public DropRequestOptions getDropRequestOptions()

Returns:

a DropRequestOptions configuration

setDropRequestOptions

public KnotxServerOptions setDropRequestOptions(DropRequestOptions dropRequestOptions)

Set the drop request options (see DropRequestOptions)

Parameters:

dropRequestOptions - a DropRequestOptions configuration

Returns:

reference to this, so the API can be used fluently

getHystrixMetricsOptions

public HystrixMetricsOptions getHystrixMetricsOptions()

setHystrixMetricsOptions

public KnotxServerOptions setHystrixMetricsOptions(HystrixMetricsOptions hystrixMetricsOptions)

Set the Hystrix Metrics options (see HystrixMetricsOptions).

Parameters:

hystrixMetricsOptions - a HystrixMetricsOptions configuration

Returns:

to this, so the API can be used fluently

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object