| // kafka-connector options: START |
| [[camel-https-kafka-connector-sink]] |
| = camel-https-kafka-connector sink configuration |
| |
| When using camel-https-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-https-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-https sink connector supports 72 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.httpUri* | The url of the HTTP endpoint to call. | null | ConfigDef.Importance.HIGH |
| | *camel.sink.endpoint.disable StreamCache* | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. | false | 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.http Binding* | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.bridge Endpoint* | If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.chunked* | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.clear ExpiredCookies* | Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.connection Close* | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.copy Headers* | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.customHost Header* | To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.httpMethod* | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. One of: [GET] [POST] [PUT] [DELETE] [HEAD] [OPTIONS] [TRACE] [PATCH] | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.ignore ResponseBody* | If this option is true, The http producer won't read response body and cache the input stream | false | 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.preserve HostHeader* | If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.throw ExceptionOnFailure* | Option to disable throwing the HttpOperationFailedException 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. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. 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.cookie Handler* | Configure a cookie handler to maintain a HTTP session | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.cookie Store* | To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.deleteWith Body* | Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.getWith Body* | Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.okStatus CodeRange* | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. | "200-299" | 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.client Builder* | Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.client ConnectionManager* | To use a custom HttpClientConnectionManager to manage connections | null | ConfigDef.Importance.MEDIUM |
| | * camel.sink.endpoint.connections PerRoute* | The maximum number of connections per route. | 20 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.httpClient* | Sets a custom HttpClient to be used by the producer | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.httpClient Configurer* | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.httpClient Options* | To configure the HttpClient using the key/values from the Map. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.http Context* | To use a custom HttpContext instance | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.mapHttp MessageBody* | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.mapHttp MessageFormUrlEncodedBody* | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.mapHttp MessageHeaders* | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.maxTotal Connections* | The maximum number of connections. | 200 | 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.useSystem Properties* | To use System Properties as fallback for configuration | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Domain* | Proxy authentication domain to use with NTML | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Host* | Proxy authentication host | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Method* | Proxy authentication method to use One of: [Basic] [Digest] [NTLM] | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Password* | Proxy authentication password | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Port* | Proxy authentication port | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Scheme* | Proxy authentication scheme to use One of: [http] [https] | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyAuth Username* | Proxy authentication username | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyHost* | Proxy hostname to use | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyPort* | Proxy port to use | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.authDomain* | Authentication domain to use with NTML | null | ConfigDef.Importance.MEDIUM |
| | * camel.sink.endpoint.authentication Preemptive* | If this option is true, camel-http sends preemptive basic authentication to the server. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.authHost* | Authentication host to use with NTML | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.authMethod* | Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.authMethod Priority* | Which authentication method to prioritize to use, either as Basic, Digest or NTLM. One of: [Basic] [Digest] [NTLM] | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.auth Password* | Authentication password | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.auth Username* | Authentication username | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.sslContext Parameters* | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.x509 HostnameVerifier* | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.cookie Store* | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.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.https.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.https.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.https.client ConnectionManager* | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.https.connections PerRoute* | The maximum number of connections per route. | 20 | ConfigDef.Importance.MEDIUM |
| | * camel.component.https.connection TimeToLive* | The time for connection to live, the time unit is millisecond, the default value is always keep alive. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.http Binding* | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.http ClientConfigurer* | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.http Configuration* | To use the shared HttpConfiguration as base configuration. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.http Context* | To use a custom org.apache.http.protocol.HttpContext when executing requests. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.maxTotal Connections* | The maximum number of connections. | 200 | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.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.https.ssl ContextParameters* | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.use GlobalSslContextParameters* | Enable usage of global SSL context parameters. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.x509 HostnameVerifier* | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.https.connection RequestTimeout* | The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.connect Timeout* | Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.component.https.socket Timeout* | Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
