Package 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	Description
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder	basic()
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.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

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

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

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

lazyStartProducer, lazyStartProducer

Method Detail

basic

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder basic()

Specified by:

basic in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

basic 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: <code>java.lang.Integer</code> type. Default: 8192 Group: advanced

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

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 <code>java.lang.Integer</code> type. Default: 8192 Group: advanced

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

bufferSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Default: 300000 Group: advanced

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

maxIdleTime - the value to set

Returns:

the dsl builder

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 <code>java.lang.Integer</code> type. Default: 300000 Group: advanced

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxIdleTime in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

maxIdleTime - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Group: advanced

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

maxTextMessageSize - the value to set

Returns:

the dsl builder

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 <code>java.lang.Integer</code> type. Group: advanced

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

maxTextMessageSize in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

maxTextMessageSize - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Default: 13 Group: advanced

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

minVersion - the value to set

Returns:

the dsl builder

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 <code>java.lang.Integer</code> type. Default: 13 Group: advanced

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

Specified by:

minVersion in interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder

Parameters:

minVersion - the value to set

Returns:

the dsl builder