KnotxServerOptions (Knot.x Core 1.6.0 API)

java.lang.Object
- io.knotx.server.configuration.KnotxServerOptions

public class KnotxServerOptions
extends Object

Describes a Knot.x HTTP Server configuration

Field Summary

Fields
Modifier and Type Field and Description

static long DEFAULT_UPLOAD_LIMIT
Default File Upload Limit = -1 (unlimited)

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_UPLOAD_LIMIT` Default File Upload Limit = -1 (unlimited)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessLogOptions`	`getAccessLog()`
`Set<String>`	`getAllowedResponseHeaders()`
`long`	`getBackpressureBufferCapacity()`
`io.reactivex.BackpressureOverflowStrategy`	`getBackpressureStrategy()`
`KnotxCSRFOptions`	`getCsrfConfig()`
`KnotxFlowSettings`	`getCustomFlow()`
`CustomHttpHeader`	`getCustomResponseHeader()`
`KnotxFlowSettings`	`getDefaultFlow()`
`io.vertx.core.eventbus.DeliveryOptions`	`getDeliveryOptions()`
`int`	`getDropRequestResponseCode()`
`String`	`getFileUploadDirectory()`
`Long`	`getFileUploadLimit()`
`io.vertx.core.http.HttpServerOptions`	`getServerOptions()`
`boolean`	`isDisplayExceptionDetails()`
`boolean`	`isDropRequests()`
`KnotxServerOptions`	`setAccessLog(AccessLogOptions accessLog)` Set the access log options
`KnotxServerOptions`	`setAllowedResponseHeaders(Set<String> allowedResponseHeaders)` Set the set of response headers that can be returned by the Knot.x server
`KnotxServerOptions`	`setBackpressureBufferCapacity(long backpressureBufferCapacity)` Sets the backpressure buffer capacity.
`KnotxServerOptions`	`setBackpressureStrategy(io.reactivex.BackpressureOverflowStrategy backpressureStrategy)` Sets the strategy how to deal with backpressure buffer overflow.
`KnotxServerOptions`	`setCsrfConfig(KnotxCSRFOptions csrfConfig)` Set the CSRF configuration of the Knot.x server
`KnotxServerOptions`	`setCustomFlow(KnotxFlowSettings customFlow)` Set the Custom Flow configuration
`KnotxServerOptions`	`setCustomResponseHeader(CustomHttpHeader customResponseHeader)` Set the custom response header returned by the Knot.x
`KnotxServerOptions`	`setDefaultFlow(KnotxFlowSettings defaultFlow)` Set the Default flow configuration
`KnotxServerOptions`	`setDeliveryOptions(io.vertx.core.eventbus.DeliveryOptions deliveryOptions)` Set the Event Bus Delivery options used to communicate with Knot's
`KnotxServerOptions`	`setDisplayExceptionDetails(boolean displayExceptionDetails)` Set whether to display or not the exception on error pages
`KnotxServerOptions`	`setDropRequestResponseCode(int dropRequestResponseCode)` Sets the HTTP response code returned wheb request is dropped.
`KnotxServerOptions`	`setDropRequests(boolean dropRequests)` Enabled/disables request dropping (backpressure) on heavy load.
`KnotxServerOptions`	`setFileUploadDirectory(String fileUploadDirectory)` Set the location on Knot.x environment when uploaded files will be stored.
`KnotxServerOptions`	`setFileUploadLimit(Long fileUploadLimit)` Set the file upload limit in bytes
`KnotxServerOptions`	`setServerOptions(io.vertx.core.http.HttpServerOptions serverOptions)` Set the HTTP Server options
`io.vertx.core.json.JsonObject`	`toJson()` Convert to JSON

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_UPLOAD_LIMIT
```
public static final long DEFAULT_UPLOAD_LIMIT
```
    Default File Upload Limit = -1 (unlimited)
    
    See Also:
    
    Constant Field Values
- 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
  - getFileUploadLimit
```
public Long getFileUploadLimit()
```
    Returns:
    
    limit of the file size when uploading
  - setFileUploadLimit
```
public KnotxServerOptions setFileUploadLimit(Long fileUploadLimit)
```
    Set the file upload limit in bytes
    
    Parameters:
    
    fileUploadLimit - size limit in bytes
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getFileUploadDirectory
```
public String getFileUploadDirectory()
```
    Returns:
    
    file upload directory
  - setFileUploadDirectory
```
public KnotxServerOptions setFileUploadDirectory(String fileUploadDirectory)
```
    Set the location on Knot.x environment when uploaded files will be stored. These must be an absolute path.
    
    Parameters:
    
    fileUploadDirectory - file upload directory
    
    Returns:
    
    reference to this, so the API can be used fluently
  - 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:
    
    HttpServerOptions
  - setServerOptions
```
public KnotxServerOptions setServerOptions(io.vertx.core.http.HttpServerOptions serverOptions)
```
    Set the HTTP Server options
    
    Parameters:
    
    serverOptions - HttpServerOptions object
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getDeliveryOptions
```
public io.vertx.core.eventbus.DeliveryOptions getDeliveryOptions()
```
    Returns:
    
    a DeliveryOptions
  - setDeliveryOptions
```
public KnotxServerOptions setDeliveryOptions(io.vertx.core.eventbus.DeliveryOptions deliveryOptions)
```
    Set the Event Bus Delivery options used to communicate with Knot's
    
    Parameters:
    
    deliveryOptions - DeliveryOptions object
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getCsrfConfig
```
public KnotxCSRFOptions getCsrfConfig()
```
    Returns:
    
    KnotxCSRFOptions
  - setCsrfConfig
```
public KnotxServerOptions setCsrfConfig(KnotxCSRFOptions csrfConfig)
```
    Set the CSRF configuration of the Knot.x server
    
    Parameters:
    
    csrfConfig - KnotxCSRFOptions object
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getDefaultFlow
```
public KnotxFlowSettings getDefaultFlow()
```
    Returns:
    
    a KnotxFlowSettings for a default flow
  - setDefaultFlow
```
public KnotxServerOptions setDefaultFlow(KnotxFlowSettings defaultFlow)
```
    Set the Default flow configuration
    
    Parameters:
    
    defaultFlow - a configuration of default flow
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getCustomFlow
```
public KnotxFlowSettings getCustomFlow()
```
    Returns:
    
    KnotxFlowSettings of the custom flow
  - setCustomFlow
```
public KnotxServerOptions setCustomFlow(KnotxFlowSettings customFlow)
```
    Set the Custom Flow configuration
    
    Parameters:
    
    customFlow - a configuration og the custom flow
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getAllowedResponseHeaders
```
public Set<String> getAllowedResponseHeaders()
```
    Returns:
    
    Set of response headers that Knot.x can return
  - setAllowedResponseHeaders
```
public KnotxServerOptions setAllowedResponseHeaders(Set<String> allowedResponseHeaders)
```
    Set the set of response headers that can be returned by the Knot.x server
    
    Parameters:
    
    allowedResponseHeaders - a set of response headers
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getCustomResponseHeader
```
public CustomHttpHeader getCustomResponseHeader()
```
    Returns:
    
    a configuration of custom response header returned by the Knot.x server
  - setCustomResponseHeader
```
public KnotxServerOptions setCustomResponseHeader(CustomHttpHeader customResponseHeader)
```
    Set the custom response header returned by the Knot.x
    
    Parameters:
    
    customResponseHeader - a KnotxServerOptions object
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getAccessLog
```
public AccessLogOptions getAccessLog()
```
    Returns:
    
    access log configuration options
  - setAccessLog
```
public KnotxServerOptions setAccessLog(AccessLogOptions accessLog)
```
    Set the access log options
    
    Parameters:
    
    accessLog - a AccessLogOptions object
    
    Returns:
    
    reference to this, so the API can be used fluently
  - isDropRequests
```
public boolean isDropRequests()
```
    Returns:
    
    if request dropping (backpressure) is enabled
  - setDropRequests
```
public KnotxServerOptions setDropRequests(boolean dropRequests)
```
    Enabled/disables request dropping (backpressure) on heavy load. Default is false - disabled.
    
    Parameters:
    
    dropRequests - true - request drop enabled, false if disabled
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getDropRequestResponseCode
```
public int getDropRequestResponseCode()
```
    Returns:
    
    HTTP response code used when request dropped
  - setDropRequestResponseCode
```
public KnotxServerOptions setDropRequestResponseCode(int dropRequestResponseCode)
```
    Sets the HTTP response code returned wheb request is dropped. Default is TOO_MANY_REQUESTS(429)
    
    Parameters:
    
    dropRequestResponseCode - status code integer
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getBackpressureBufferCapacity
```
public long getBackpressureBufferCapacity()
```
    Returns:
    
    Capacity of the backpressure buffer
  - setBackpressureBufferCapacity
```
public KnotxServerOptions setBackpressureBufferCapacity(long backpressureBufferCapacity)
```
    Sets the backpressure buffer capacity. Default value = 1000
    
    Parameters:
    
    backpressureBufferCapacity - long - capacity of the buffer
    
    Returns:
    
    reference to this, so the API can be used fluently
  - getBackpressureStrategy
```
public io.reactivex.BackpressureOverflowStrategy getBackpressureStrategy()
```
    Returns:
    
    a backpressure overflow strategy.
  - setBackpressureStrategy
```
public KnotxServerOptions setBackpressureStrategy(io.reactivex.BackpressureOverflowStrategy backpressureStrategy)
```
    Sets the strategy how to deal with backpressure buffer overflow. Default is DROP_LATEST. Available values:
    - ERROR - terminates the whole sequence
    - DROP_OLDEST - drops the oldest value from the buffer
    - DROP_LATEST - drops the latest value from the buffer
    Parameters:
    
    backpressureStrategy - a BackpressureOverflowStrategy value
    
    Returns:
    
    reference to this, so the API can be used fluently

Class KnotxServerOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_UPLOAD_LIMIT

Constructor Detail

KnotxServerOptions

KnotxServerOptions

KnotxServerOptions

Method Detail

toJson

getFileUploadLimit

setFileUploadLimit

getFileUploadDirectory

setFileUploadDirectory

isDisplayExceptionDetails

setDisplayExceptionDetails

getServerOptions

setServerOptions

getDeliveryOptions

setDeliveryOptions

getCsrfConfig

setCsrfConfig

getDefaultFlow

setDefaultFlow

getCustomFlow

setCustomFlow

getAllowedResponseHeaders

setAllowedResponseHeaders

getCustomResponseHeader

setCustomResponseHeader

getAccessLog

setAccessLog

isDropRequests

setDropRequests

getDropRequestResponseCode

setDropRequestResponseCode

getBackpressureBufferCapacity

setBackpressureBufferCapacity

getBackpressureStrategy

setBackpressureStrategy