Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder
- Enclosing interface:
- VertxWebsocketEndpointBuilderFactory
public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Vert.x WebSocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointConsumerBuilder
advanced()
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
allowedOriginPattern(String allowedOriginPattern)
Regex pattern to match the origin header sent by WebSocket clients.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
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 VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
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 VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
router(Object router)
To use an existing vertx router for the HTTP server.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
router(String router)
To use an existing vertx router for the HTTP server.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
serverOptions(Object serverOptions)
Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
serverOptions(String serverOptions)
Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters.default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters.
-
-
-
Method Detail
-
advanced
default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointConsumerBuilder advanced()
-
allowedOriginPattern
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder allowedOriginPattern(String allowedOriginPattern)
Regex pattern to match the origin header sent by WebSocket clients. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
allowedOriginPattern
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder 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 a <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
router
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(Object router)
To use an existing vertx router for the HTTP server. The option is a: <code>io.vertx.ext.web.Router</code> type. Group: consumer- Parameters:
router
- the value to set- Returns:
- the dsl builder
-
router
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(String router)
To use an existing vertx router for the HTTP server. The option will be converted to a <code>io.vertx.ext.web.Router</code> type. Group: consumer- Parameters:
router
- the value to set- Returns:
- the dsl builder
-
serverOptions
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(Object serverOptions)
Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option is a: <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer- Parameters:
serverOptions
- the value to set- Returns:
- the dsl builder
-
serverOptions
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(String serverOptions)
Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option will be converted to a <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer- Parameters:
serverOptions
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
-