camel-ahc-wss-kafka-connector source configuration

Connector Description: Exchange data with external Websocket servers using Async Http Client.

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

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-ahc-wss-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

connector.class=org.apache.camel.kafkaconnector.ahcwss.CamelAhcwssSourceConnector

The camel-ahc-wss source connector supports 24 options, which are listed below.

Name Description Default Priority

camel.source.path.httpUri

Required The URI to use such as http://hostname:port/path.

HIGH

camel.source.endpoint.bridgeEndpoint

If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint’s URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back.

false

MEDIUM

camel.source.endpoint.bufferSize

The initial in-memory buffer size used when transferring data between Camel and AHC Client.

4096

MEDIUM

camel.source.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

MEDIUM

camel.source.endpoint.throwExceptionOnFailure

Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.

true

MEDIUM

camel.source.endpoint.transferException

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

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

MEDIUM

camel.source.endpoint.sendMessageOnError

Whether to send an message if the web-socket listener received an error.

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.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.binding

To use a custom AhcBinding which allows to control how to bind between AHC and Camel.

MEDIUM

camel.source.endpoint.clientConfig

To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.

MEDIUM

camel.source.endpoint.clientConfigOptions

To configure the AsyncHttpClientConfig using the key/values from the Map.

MEDIUM

camel.source.endpoint.clientConfigRealmOptions

To configure the AsyncHttpClientConfig Realm using the key/values from the Map.

MEDIUM

camel.source.endpoint.sslContextParameters

Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.

MEDIUM

camel.component.ahc-wss.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

MEDIUM

camel.component.ahc-wss.allowJavaSerializedObject

Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

false

MEDIUM

camel.component.ahc-wss.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

MEDIUM

camel.component.ahc-wss.binding

To use a custom AhcBinding which allows to control how to bind between AHC and Camel.

MEDIUM

camel.component.ahc-wss.client

To use a custom AsyncHttpClient.

MEDIUM

camel.component.ahc-wss.clientConfig

To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.

MEDIUM

camel.component.ahc-wss.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

MEDIUM

camel.component.ahc-wss.sslContextParameters

Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.

MEDIUM

camel.component.ahc-wss.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

MEDIUM

The camel-ahc-wss source connector has no converters out of the box.

The camel-ahc-wss source connector has no transforms out of the box.

The camel-ahc-wss source connector has no aggregation strategies out of the box.

Back to top