blob: 357b3ebaa76f852672900d85b38e8875555d6bad [file] [log] [blame]
// kafka-connector options: START
[[camel-ahc-ws-kafka-connector-sink]]
= camel-ahc-ws-kafka-connector sink configuration
When using camel-ahc-ws-kafka-connector as sink 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-ahc-ws-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-ahc-ws sink connector supports 26 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.httpUri* | The URI to use such as \http://hostname:port/path | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.bridge Endpoint* | 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.bufferSize* | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | 4096 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.header FilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.throw ExceptionOnFailure* | 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.transfer Exception* | 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.connection Close* | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.cookie Handler* | Configure a cookie handler to maintain a HTTP session | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.lazyStart 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 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.use Streaming* | To enable streaming to send data as multiple text fragments. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.binding* | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.client Config* | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.client ConfigOptions* | To configure the AsyncHttpClientConfig using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.client ConfigRealmOptions* | To configure the AsyncHttpClientConfig Realm using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.sslContext Parameters* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.allow JavaSerializedObject* | 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 | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.binding* | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.client* | To use a custom AsyncHttpClient | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.client Config* | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.header FilterStrategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.ssl ContextParameters* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ahc-ws.use GlobalSslContextParameters* | Enable usage of global SSL context parameters. | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END