Interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder
- Enclosing interface:
- WebsocketEndpointBuilderFactory
public static interface WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Jetty Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
basic()
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
bufferSize(Integer bufferSize)
Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
bufferSize(String bufferSize)
Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192).default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
maxIdleTime(Integer maxIdleTime)
Set the time in ms that the websocket created by the websocketServlet may be idle before closing.default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
maxIdleTime(String maxIdleTime)
Set the time in ms that the websocket created by the websocketServlet may be idle before closing.default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
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.AdvancedWebsocketEndpointProducerBuilder
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.AdvancedWebsocketEndpointProducerBuilder
minVersion(Integer minVersion)
Can be used to set the minimum protocol version accepted for the websocketServlet.default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder
minVersion(String minVersion)
Can be used to set the minimum protocol version accepted for the websocketServlet.
-
-
-
Method Detail
-
basic
default WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder basic()
-
lazyStartProducer
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
bufferSize
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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.AdvancedWebsocketEndpointProducerBuilder 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
-
-