Vert.x WebSocket
Expose WebSocket endpoints and connect to remote WebSocket servers using Vert.x
What’s inside
-
Vert.x WebSocket component, URI syntax:
vertx-websocket:host:port/path
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-vertx-websocket-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 12 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.vertx-websocket.allow-origin-header | Whether the WebSocket client should add the Origin header to the WebSocket handshake request. | true | Boolean |
camel.component.vertx-websocket.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
camel.component.vertx-websocket.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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. | false | Boolean |
camel.component.vertx-websocket.default-host | Default value for host name that the WebSocket should bind to | 0.0.0.0 | String |
camel.component.vertx-websocket.default-port | Default value for the port that the WebSocket should bind to | 0 | Integer |
camel.component.vertx-websocket.enabled | Whether to enable auto configuration of the vertx-websocket component. This is enabled by default. | Boolean | |
camel.component.vertx-websocket.lazy-start-producer | 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. | false | Boolean |
camel.component.vertx-websocket.origin-header-url | The value of the Origin header that the WebSocket client should use on the WebSocket handshake request. When not specified, the WebSocket client will automatically determine the value for the Origin from the request URL. | String | |
camel.component.vertx-websocket.router | To provide a custom vertx router to use on the WebSocket server. The option is a io.vertx.ext.web.Router type. | Router | |
camel.component.vertx-websocket.use-global-ssl-context-parameters | Enable usage of global SSL context parameters. | false | Boolean |
camel.component.vertx-websocket.vertx | To use an existing vertx instead of creating a new instance. The option is a io.vertx.core.Vertx type. | Vertx | |
camel.component.vertx-websocket.vertx-options | To provide a custom set of vertx options for configuring vertx. The option is a io.vertx.core.VertxOptions type. | VertxOptions |