// kafka-connector options: START
[[camel-vertx-websocket-kafka-connector-source]]
= camel-vertx-websocket-kafka-connector source configuration

Connector description: Expose WebSocket endpoints and connect to remote WebSocket servers using Vert.x

When using camel-vertx-websocket-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-vertx-websocket-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>
----

To use this Source connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.vertxwebsocket.CamelVertxwebsocketSourceConnector
----


The camel-vertx-websocket source connector supports 16 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.source.path.host* | The host that the consumer should bind to or the host of the remote websocket destination that the producer should connect to | "0.0.0.0" | false | MEDIUM
| *camel.source.path.port* | The port that the consumer should bind to or port of the remote websocket destination that the producer should connect to | 0 | false | MEDIUM
| *camel.source.path.path* | The path that the consumer should bind to or path of the remote websocket destination that the producer should connect to | "/" | true | HIGH
| *camel.source.endpoint.allowedOriginPattern* | Regex pattern to match the origin header sent by WebSocket clients | null | false | MEDIUM
| *camel.source.endpoint.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. | false | false | MEDIUM
| *camel.source.endpoint.router* | To use an existing vertx router for the HTTP server | null | false | MEDIUM
| *camel.source.endpoint.serverOptions* | Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer | null | false | MEDIUM
| *camel.source.endpoint.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. | null | false | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | false | MEDIUM
| *camel.source.endpoint.sslContextParameters* | To configure security using SSLContextParameters | null | false | MEDIUM
| *camel.component.vertx-websocket.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. | false | false | MEDIUM
| *camel.component.vertx-websocket.autowiredEnabled* | 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 | false | MEDIUM
| *camel.component.vertx-websocket.router* | To provide a custom vertx router to use on the WebSocket server | null | false | MEDIUM
| *camel.component.vertx-websocket.vertx* | To use an existing vertx instead of creating a new instance | null | false | MEDIUM
| *camel.component.vertx-websocket.vertxOptions* | To provide a custom set of vertx options for configuring vertx | null | false | MEDIUM
| *camel.component.vertx-websocket.useGlobalSsl ContextParameters* | Enable usage of global SSL context parameters. | false | false | MEDIUM
|===



The camel-vertx-websocket source connector has no converters out of the box.





The camel-vertx-websocket source connector has no transforms out of the box.





The camel-vertx-websocket source connector has no aggregation strategies out of the box.




// kafka-connector options: END
