org.apache.camel.builder.endpoint.dsl

Interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder

Enclosing interface:

WebsocketEndpointBuilderFactory

public static interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the Jetty Websocket component.

Method Summary

Modifier and Type	Method and Description
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder	basic()
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	bufferSize(Integer bufferSize) Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	bufferSize(String bufferSize) Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	maxIdleTime(Integer maxIdleTime) Set the time in ms that the websocket created by the websocketServlet may be idle before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	maxIdleTime(String maxIdleTime) Set the time in ms that the websocket created by the websocketServlet may be idle before closing.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	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.AdvancedWebsocketEndpointConsumerBuilder	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.AdvancedWebsocketEndpointConsumerBuilder	minVersion(Integer minVersion) Can be used to set the minimum protocol version accepted for the websocketServlet.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	minVersion(String minVersion) Can be used to set the minimum protocol version accepted for the websocketServlet.
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder	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.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder basic()

exceptionHandler

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

bufferSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

maxIdleTime

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

maxIdleTime - the value to set

Returns:

the dsl builder

maxIdleTime

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

maxIdleTime - the value to set

Returns:

the dsl builder

maxTextMessageSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

maxTextMessageSize - the value to set

Returns:

the dsl builder

maxTextMessageSize

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

maxTextMessageSize - the value to set

Returns:

the dsl builder

minVersion

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

minVersion - the value to set

Returns:

the dsl builder

minVersion

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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

Parameters:

minVersion - the value to set

Returns:

the dsl builder

synchronous

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder