SpincastUndertowConfigDefault (org.spincast:spincast-framework 0.9.28 API)

java.lang.Object
- org.spincast.plugins.undertow.config.SpincastUndertowConfigDefault

All Implemented Interfaces:

ISpincastUndertowConfig
```
public class SpincastUndertowConfigDefault
extends Object
implements ISpincastUndertowConfig
```
Default configuration for Spincast Undertow plugin.

Constructor Summary

Constructors
Constructor and Description

SpincastUndertowConfigDefault()

Constructors
Constructor and Description
`SpincastUndertowConfigDefault()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getHtmlFormEncoding()` The encoding the use to parse the data from HTML forms.
`int`	`getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()` The number of milliseconds to sleep between two validations that all endpoints are closed properly before calling the killing server.stop() method.
`int`	`getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()` The number of seconds max to wait for all endpoints to be closed properly before calling the killing server.stop() method.
`int`	`getWebsocketAutomaticPingIntervalSeconds()` When the automatic WebSocket pings are enabled, this is the interval (in seconds) between two pings.
`int`	`getWebsocketDefaultClosingCode()` The default code to use when sending a "closing Websocket connection" event to a peer.
`String`	`getWebsocketDefaultClosingReason()` The default reason to use when sending a "closing Websocket connection" event to a peer.
`String`	`getWebsocketPingMessageString()` The ping text to use.
`ThreadFactory`	`getWebsocketThreadExecutorForAppEventsThreadFactory()` The `ThreadFactory` to use to create threads when sending WebSocket events to the application.
`int`	`getWebsocketThreadExecutorForAppEventsThreadNumber()` The maximum number of concurrent threads used when sending WebSocket events to the application.
`int`	`getWebsocketThreadExecutorForAppEventsTimeoutAmount()` The timeout `amount` before cancelling a task when sending WebSocket events to the application.
`TimeUnit`	`getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit()` The timeout `TimeUnit` before cancelling a task when sending WebSocket events to the application.
`boolean`	`isWebsocketAutomaticPing()` If `true`, pings will automatically be sent to peers of a WebSocket endpoint as an heartbeat.

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

- Constructor Detail
  - SpincastUndertowConfigDefault
```
public SpincastUndertowConfigDefault()
```
- Method Detail
  - getWebsocketPingMessageString
```
public String getWebsocketPingMessageString()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The ping text to use. Must be < 125 characters. Defaults to "__ping"
    
    Specified by:
    
    getWebsocketPingMessageString in interface ISpincastUndertowConfig
  - isWebsocketAutomaticPing
```
public boolean isWebsocketAutomaticPing()
```
    Description copied from interface: ISpincastUndertowConfig
    
    If true, pings will automatically be sent to peers of a WebSocket endpoint as an heartbeat. Enabled by default.
    
    Specified by:
    
    isWebsocketAutomaticPing in interface ISpincastUndertowConfig
  - getWebsocketAutomaticPingIntervalSeconds
```
public int getWebsocketAutomaticPingIntervalSeconds()
```
    Description copied from interface: ISpincastUndertowConfig
    
    When the automatic WebSocket pings are enabled, this is the interval (in seconds) between two pings. Defaults to 20 seconds.
    
    Specified by:
    
    getWebsocketAutomaticPingIntervalSeconds in interface ISpincastUndertowConfig
  - getWebsocketDefaultClosingCode
```
public int getWebsocketDefaultClosingCode()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The default code to use when sending a "closing Websocket connection" event to a peer. Valid codes can be found here Defaults to 1000, a normal closure.
    
    Specified by:
    
    getWebsocketDefaultClosingCode in interface ISpincastUndertowConfig
  - getWebsocketDefaultClosingReason
```
public String getWebsocketDefaultClosingReason()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The default reason to use when sending a "closing Websocket connection" event to a peer. Defaults to an empty message.
    
    Specified by:
    
    getWebsocketDefaultClosingReason in interface ISpincastUndertowConfig
  - getWebsocketThreadExecutorForAppEventsThreadNumber
```
public int getWebsocketThreadExecutorForAppEventsThreadNumber()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The maximum number of concurrent threads used when sending WebSocket events to the application. Defaults to 100.
    
    Specified by:
    
    getWebsocketThreadExecutorForAppEventsThreadNumber in interface ISpincastUndertowConfig
  - getWebsocketThreadExecutorForAppEventsTimeoutAmount
```
public int getWebsocketThreadExecutorForAppEventsTimeoutAmount()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The timeout amount before cancelling a task when sending WebSocket events to the application. Defaults to 60.
    
    Specified by:
    
    getWebsocketThreadExecutorForAppEventsTimeoutAmount in interface ISpincastUndertowConfig
  - getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit
```
public TimeUnit getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The timeout TimeUnit before cancelling a task when sending WebSocket events to the application. Defaults to SECONDS.
    
    Specified by:
    
    getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit in interface ISpincastUndertowConfig
  - getWebsocketThreadExecutorForAppEventsThreadFactory
```
public ThreadFactory getWebsocketThreadExecutorForAppEventsThreadFactory()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The ThreadFactory to use to create threads when sending WebSocket events to the application. Defaults to null.
    
    Specified by:
    
    getWebsocketThreadExecutorForAppEventsThreadFactory in interface ISpincastUndertowConfig
  - getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer
```
public int getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The number of seconds max to wait for all endpoints to be closed properly before calling the killing server.stop() method.
    
    Specified by:
    
    getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer in interface ISpincastUndertowConfig
  - getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer
```
public int getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The number of milliseconds to sleep between two validations that all endpoints are closed properly before calling the killing server.stop() method.
    
    Specified by:
    
    getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer in interface ISpincastUndertowConfig
  - getHtmlFormEncoding
```
public String getHtmlFormEncoding()
```
    Description copied from interface: ISpincastUndertowConfig
    
    The encoding the use to parse the data from HTML forms. Default to UTF-8.
    
    Specified by:
    
    getHtmlFormEncoding in interface ISpincastUndertowConfig

Class SpincastUndertowConfigDefault

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpincastUndertowConfigDefault

Method Detail

getWebsocketPingMessageString

isWebsocketAutomaticPing

getWebsocketAutomaticPingIntervalSeconds

getWebsocketDefaultClosingCode

getWebsocketDefaultClosingReason

getWebsocketThreadExecutorForAppEventsThreadNumber

getWebsocketThreadExecutorForAppEventsTimeoutAmount

getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit

getWebsocketThreadExecutorForAppEventsThreadFactory

getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

getHtmlFormEncoding