org.apache.camel.builder.endpoint.dsl

Interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder, WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Enclosing interface:

WebsocketEndpointBuilderFactory

public static interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder
extends WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder, WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Advanced builder for endpoint for the Jetty Websocket component.

Method Summary

Modifier and Type	Method and Description
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder	basic()
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	basicPropertyBinding(boolean basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	basicPropertyBinding(String basicPropertyBinding) Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	bufferSize(Integer bufferSize) Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	bufferSize(String bufferSize) Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	maxIdleTime(Integer maxIdleTime) Set the time in ms that the websocket created by the websocketServlet may be idle before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	maxIdleTime(String maxIdleTime) Set the time in ms that the websocket created by the websocketServlet may be idle before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	maxTextMessageSize(Integer maxTextMessageSize) Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	maxTextMessageSize(String maxTextMessageSize) Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	minVersion(Integer minVersion) Can be used to set the minimum protocol version accepted for the websocketServlet.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	minVersion(String minVersion) Can be used to set the minimum protocol version accepted for the websocketServlet.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder basic()

Specified by:

basic in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

basic in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

basicPropertyBinding

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder basicPropertyBinding(boolean basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

Specified by:

basicPropertyBinding in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

basicPropertyBinding in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

basicPropertyBinding

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder basicPropertyBinding(String basicPropertyBinding)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced

Specified by:

basicPropertyBinding in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

basicPropertyBinding in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

bufferSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder bufferSize(Integer bufferSize)

Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192). The option is a: java.lang.Integer type. Default: 8192 Group: advanced

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

bufferSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder bufferSize(String bufferSize)

Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192). The option will be converted to a java.lang.Integer type. Default: 8192 Group: advanced

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

maxIdleTime

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder maxIdleTime(Integer maxIdleTime)

Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000). The option is a: java.lang.Integer type. Default: 300000 Group: advanced

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

maxIdleTime

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder maxIdleTime(String maxIdleTime)

Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000). The option will be converted to a java.lang.Integer type. Default: 300000 Group: advanced

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

maxTextMessageSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder maxTextMessageSize(Integer maxTextMessageSize)

Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing. The option is a: java.lang.Integer type. Group: advanced

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

maxTextMessageSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder maxTextMessageSize(String maxTextMessageSize)

Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing. The option will be converted to a java.lang.Integer type. Group: advanced

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

minVersion

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder minVersion(Integer minVersion)

Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version). The option is a: java.lang.Integer type. Default: 13 Group: advanced

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

minVersion

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder minVersion(String minVersion)

Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version). The option will be converted to a java.lang.Integer type. Default: 13 Group: advanced

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

synchronous

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: boolean type. Default: false Group: advanced

Specified by:

synchronous in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

synchronous in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

synchronous

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a boolean type. Default: false Group: advanced

Specified by:

synchronous in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

synchronous in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder