Interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
- Enclosing interface:
- WebsocketEndpointBuilderFactory
public static interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Jetty Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder
advanced()
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
allowedOrigins(String allowedOrigins)
The CORS allowed origins.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
bridgeErrorHandler(String bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
enableJmx(String enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
filterPath(String filterPath)
Context path for filtering CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
maxBinaryMessageSize(Integer maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
maxBinaryMessageSize(String maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sessionSupport(boolean sessionSupport)
Whether to enable session support which enables HttpSession for each http request.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sessionSupport(String sessionSupport)
Whether to enable session support which enables HttpSession for each http request.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
staticResources(String staticResources)
Set a resource path for static resources (such as .html files etc).
-
-
-
Method Detail
-
advanced
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder advanced()
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder maxBinaryMessageSize(Integer maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited). The option is a:java.lang.Integer
type. Default: -1 Group: common
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder maxBinaryMessageSize(String maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited). The option will be converted to ajava.lang.Integer
type. Default: -1 Group: common
-
bridgeErrorHandler
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to aboolean
type. Default: false Group: consumer
-
sessionSupport
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sessionSupport(boolean sessionSupport)
Whether to enable session support which enables HttpSession for each http request. The option is a:boolean
type. Default: false Group: consumer
-
sessionSupport
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sessionSupport(String sessionSupport)
Whether to enable session support which enables HttpSession for each http request. The option will be converted to aboolean
type. Default: false Group: consumer
-
staticResources
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder staticResources(String staticResources)
Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. The option is a:java.lang.String
type. Group: consumer
-
allowedOrigins
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder allowedOrigins(String allowedOrigins)
The CORS allowed origins. Use to allow all. The option is a:java.lang.String
type. Group: cors
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS. The option is a:boolean
type. Default: false Group: cors
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS. The option will be converted to aboolean
type. Default: false Group: cors
-
filterPath
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder filterPath(String filterPath)
Context path for filtering CORS. The option is a:java.lang.String
type. Group: cors
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option is a:boolean
type. Default: false Group: monitoring
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder enableJmx(String enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option will be converted to aboolean
type. Default: false Group: monitoring
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters. The option is a:org.apache.camel.support.jsse.SSLContextParameters
type. Group: security
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters. The option will be converted to aorg.apache.camel.support.jsse.SSLContextParameters
type. Group: security
-
-