This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 27fd30638fb camel-http - Better label on options
27fd30638fb is described below
commit 27fd30638fbde9efb9fb736c708929e5f004ab5e
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Thu Dec 29 07:49:26 2022 +0100
camel-http - Better label on options
---
.../org/apache/camel/catalog/components/http.json | 22 +-
.../org/apache/camel/catalog/components/https.json | 22 +-
.../camel/http/common/HttpCommonEndpoint.java | 11 +-
.../org/apache/camel/component/http/http.json | 22 +-
.../org/apache/camel/component/http/https.json | 22 +-
.../apache/camel/component/http/HttpComponent.java | 8 +-
.../apache/camel/component/http/HttpEndpoint.java | 6 +-
.../component/dsl/HttpComponentBuilderFactory.java | 88 ++---
.../dsl/HttpsComponentBuilderFactory.java | 90 ++---
.../endpoint/dsl/HttpEndpointBuilderFactory.java | 417 +++++++++++----------
10 files changed, 355 insertions(+), 353 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/http.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/http.json
index f189a68c9b5..d1c67f7b41a 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/http.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/http.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.http.client.CookieStore", "deprecated": false,
"autowired": false, "secret": false, "description": "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 f [...]
- "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 heade [...]
+ "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
- "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer", "label":
"producer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 8192,
"description": "This threshold in bytes controls whether the response payload
should be stored in memory as a byte array or be streaming based. Set this to
-1 to always use streaming mode." },
- "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
+ "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 t [...]
+ "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer (advanced)",
"label": "producer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 8192, "description": "This threshold in bytes controls whether
the response payload should be stored in memory as a byte array or be streaming
based. Set this to -1 to always use st [...]
"skipRequestHeaders": { "kind": "property", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing over [...]
"skipResponseHeaders": { "kind": "property", "displayName": "Skip Response
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the HTTP response headers to Camel
headers. If there are no data needed from HTTP headers then this can avoid
parsing overhead with many object allocations [...]
"allowJavaSerializedObject": { "kind": "property", "displayName": "Allow
Java Serialized Object", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 des [...]
@@ -84,23 +84,23 @@
"properties": {
"httpUri": { "kind": "path", "displayName": "Http Uri", "group": "common",
"label": "common", "required": true, "type": "string", "javaType":
"java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The url of the HTTP endpoint to call." },
"disableStreamCache": { "kind": "parameter", "displayName": "Disable
Stream Cache", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 inpu [...]
- "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom HeaderFilterStrategy to filter header to and from Camel message."
},
+ "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common (advanced)", "label": "common,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter header to and from Camel message." },
"bridgeEndpoint": { "kind": "parameter", "displayName": "Bridge Endpoint",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "description": "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 al [...]
- "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": true, "description": "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. If the component [...]
"connectionClose": { "kind": "parameter", "displayName": "Connection
Close", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Specifies whether a
Connection Close header must be added to HTTP Request. By default
connectionClose is false." },
- "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 head [...]
- "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To use custom host header for producer.
When not set in query will be ignored. When set will override host header
derived from url." },
+ "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"httpMethod": { "kind": "parameter", "displayName": "Http Method",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.http.common.HttpMethods", "enum": [ "GET",
"POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE", "PATCH" ], "deprecated":
false, "autowired": false, "secret": false, "description": "Configure the HTTP
method to use. The HttpMethod header cannot override this option if set." },
- "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "If this option
is true, The http producer won't read response body and cache the input stream"
},
- "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 [...]
"throwExceptionOnFailure": { "kind": "parameter", "displayName": "Throw
Exception On Failure", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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." },
+ "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "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 expir [...]
"cookieHandler": { "kind": "parameter", "displayName": "Cookie Handler",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.http.base.cookie.CookieHandler", "deprecated": false,
"autowired": false, "secret": false, "description": "Configure a cookie handler
to maintain a HTTP session" },
"cookieStore": { "kind": "parameter", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 stor [...]
+ "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use custom host header for producer. When not set in query will be ignored.
When set will override host header derived from url." },
"deleteWithBody": { "kind": "parameter", "displayName": "Delete With
Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 [...]
- "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
"getWithBody": { "kind": "parameter", "displayName": "Get With Body",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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." },
+ "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "If this option is true, The http producer won't read response
body and cache the input stream" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 other [...]
"okStatusCodeRange": { "kind": "parameter", "displayName": "Ok Status Code
Range", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"200-299", "description": "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 [...]
+ "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 he [...]
"skipRequestHeaders": { "kind": "parameter", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing ove [...]
"skipResponseHeaders": { "kind": "parameter", "displayName": "Skip
Response Headers", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether to skip mapping all the HTTP
response headers to Camel headers. If there are no data needed from HTTP
headers then this can avoid parsing overhead with many object allocation [...]
"userAgent": { "kind": "parameter", "displayName": "User Agent", "group":
"producer (advanced)", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To set a custom HTTP User-Agent request
header" },
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/https.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/https.json
index 4401c4bfbf0..08de0c72539 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/https.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/https.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.http.client.CookieStore", "deprecated": false,
"autowired": false, "secret": false, "description": "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 f [...]
- "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 heade [...]
+ "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
- "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer", "label":
"producer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 8192,
"description": "This threshold in bytes controls whether the response payload
should be stored in memory as a byte array or be streaming based. Set this to
-1 to always use streaming mode." },
- "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
+ "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 t [...]
+ "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer (advanced)",
"label": "producer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 8192, "description": "This threshold in bytes controls whether
the response payload should be stored in memory as a byte array or be streaming
based. Set this to -1 to always use st [...]
"skipRequestHeaders": { "kind": "property", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing over [...]
"skipResponseHeaders": { "kind": "property", "displayName": "Skip Response
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the HTTP response headers to Camel
headers. If there are no data needed from HTTP headers then this can avoid
parsing overhead with many object allocations [...]
"allowJavaSerializedObject": { "kind": "property", "displayName": "Allow
Java Serialized Object", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 des [...]
@@ -84,23 +84,23 @@
"properties": {
"httpUri": { "kind": "path", "displayName": "Http Uri", "group": "common",
"label": "common", "required": true, "type": "string", "javaType":
"java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The url of the HTTP endpoint to call." },
"disableStreamCache": { "kind": "parameter", "displayName": "Disable
Stream Cache", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 inpu [...]
- "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom HeaderFilterStrategy to filter header to and from Camel message."
},
+ "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common (advanced)", "label": "common,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter header to and from Camel message." },
"bridgeEndpoint": { "kind": "parameter", "displayName": "Bridge Endpoint",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "description": "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 al [...]
- "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": true, "description": "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. If the component [...]
"connectionClose": { "kind": "parameter", "displayName": "Connection
Close", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Specifies whether a
Connection Close header must be added to HTTP Request. By default
connectionClose is false." },
- "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 head [...]
- "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To use custom host header for producer.
When not set in query will be ignored. When set will override host header
derived from url." },
+ "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"httpMethod": { "kind": "parameter", "displayName": "Http Method",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.http.common.HttpMethods", "enum": [ "GET",
"POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE", "PATCH" ], "deprecated":
false, "autowired": false, "secret": false, "description": "Configure the HTTP
method to use. The HttpMethod header cannot override this option if set." },
- "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "If this option
is true, The http producer won't read response body and cache the input stream"
},
- "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 [...]
"throwExceptionOnFailure": { "kind": "parameter", "displayName": "Throw
Exception On Failure", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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." },
+ "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "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 expir [...]
"cookieHandler": { "kind": "parameter", "displayName": "Cookie Handler",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.http.base.cookie.CookieHandler", "deprecated": false,
"autowired": false, "secret": false, "description": "Configure a cookie handler
to maintain a HTTP session" },
"cookieStore": { "kind": "parameter", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 stor [...]
+ "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use custom host header for producer. When not set in query will be ignored.
When set will override host header derived from url." },
"deleteWithBody": { "kind": "parameter", "displayName": "Delete With
Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 [...]
- "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
"getWithBody": { "kind": "parameter", "displayName": "Get With Body",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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." },
+ "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "If this option is true, The http producer won't read response
body and cache the input stream" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 other [...]
"okStatusCodeRange": { "kind": "parameter", "displayName": "Ok Status Code
Range", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"200-299", "description": "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 [...]
+ "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 he [...]
"skipRequestHeaders": { "kind": "parameter", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing ove [...]
"skipResponseHeaders": { "kind": "parameter", "displayName": "Skip
Response Headers", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether to skip mapping all the HTTP
response headers to Camel headers. If there are no data needed from HTTP
headers then this can avoid parsing overhead with many object allocation [...]
"userAgent": { "kind": "parameter", "displayName": "User Agent", "group":
"producer (advanced)", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To set a custom HTTP User-Agent request
header" },
diff --git
a/components/camel-http-common/src/main/java/org/apache/camel/http/common/HttpCommonEndpoint.java
b/components/camel-http-common/src/main/java/org/apache/camel/http/common/HttpCommonEndpoint.java
index 506ef8d288e..72c7431133c 100644
---
a/components/camel-http-common/src/main/java/org/apache/camel/http/common/HttpCommonEndpoint.java
+++
b/components/camel-http-common/src/main/java/org/apache/camel/http/common/HttpCommonEndpoint.java
@@ -39,7 +39,7 @@ public abstract class HttpCommonEndpoint extends
DefaultEndpoint implements Head
@UriPath(label = "common", description = "The url of the HTTP endpoint to
call.")
@Metadata(required = true)
URI httpUri;
- @UriParam(label = "common",
+ @UriParam(label = "common,advanced",
description = "To use a custom HeaderFilterStrategy to filter
header to and from Camel message.")
HeaderFilterStrategy headerFilterStrategy = new HttpHeaderFilterStrategy();
@UriParam(label = "common,advanced",
@@ -53,7 +53,7 @@ public abstract class HttpCommonEndpoint extends
DefaultEndpoint implements Head
description = "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.")
boolean bridgeEndpoint;
- @UriParam(label = "producer",
+ @UriParam(label = "producer,advanced",
description = "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")
@@ -77,7 +77,8 @@ public abstract class HttpCommonEndpoint extends
DefaultEndpoint implements Head
+ " 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.")
boolean disableStreamCache;
- @UriParam(description = "If enabled and an Exchange failed processing on
the consumer side, and if the caused Exception was send back serialized"
+ @UriParam(label = "common",
+ description = "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."
@@ -102,10 +103,10 @@ public abstract class HttpCommonEndpoint extends
DefaultEndpoint implements Head
@UriParam(label = "consumer",
description = "To use a custom buffer size on the
javax.servlet.ServletResponse.")
Integer responseBufferSize;
- @UriParam(label = "producer",
+ @UriParam(label = "producer,advanced",
description = "If this option is true, The http producer won't
read response body and cache the input stream")
boolean ignoreResponseBody;
- @UriParam(label = "producer", defaultValue = "true",
+ @UriParam(label = "producer,advanced", defaultValue = "true",
description = "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).")
boolean copyHeaders = true;
diff --git
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
index f189a68c9b5..d1c67f7b41a 100644
---
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
+++
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.http.client.CookieStore", "deprecated": false,
"autowired": false, "secret": false, "description": "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 f [...]
- "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 heade [...]
+ "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
- "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer", "label":
"producer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 8192,
"description": "This threshold in bytes controls whether the response payload
should be stored in memory as a byte array or be streaming based. Set this to
-1 to always use streaming mode." },
- "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
+ "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 t [...]
+ "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer (advanced)",
"label": "producer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 8192, "description": "This threshold in bytes controls whether
the response payload should be stored in memory as a byte array or be streaming
based. Set this to -1 to always use st [...]
"skipRequestHeaders": { "kind": "property", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing over [...]
"skipResponseHeaders": { "kind": "property", "displayName": "Skip Response
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the HTTP response headers to Camel
headers. If there are no data needed from HTTP headers then this can avoid
parsing overhead with many object allocations [...]
"allowJavaSerializedObject": { "kind": "property", "displayName": "Allow
Java Serialized Object", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 des [...]
@@ -84,23 +84,23 @@
"properties": {
"httpUri": { "kind": "path", "displayName": "Http Uri", "group": "common",
"label": "common", "required": true, "type": "string", "javaType":
"java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The url of the HTTP endpoint to call." },
"disableStreamCache": { "kind": "parameter", "displayName": "Disable
Stream Cache", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 inpu [...]
- "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom HeaderFilterStrategy to filter header to and from Camel message."
},
+ "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common (advanced)", "label": "common,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter header to and from Camel message." },
"bridgeEndpoint": { "kind": "parameter", "displayName": "Bridge Endpoint",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "description": "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 al [...]
- "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": true, "description": "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. If the component [...]
"connectionClose": { "kind": "parameter", "displayName": "Connection
Close", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Specifies whether a
Connection Close header must be added to HTTP Request. By default
connectionClose is false." },
- "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 head [...]
- "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To use custom host header for producer.
When not set in query will be ignored. When set will override host header
derived from url." },
+ "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"httpMethod": { "kind": "parameter", "displayName": "Http Method",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.http.common.HttpMethods", "enum": [ "GET",
"POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE", "PATCH" ], "deprecated":
false, "autowired": false, "secret": false, "description": "Configure the HTTP
method to use. The HttpMethod header cannot override this option if set." },
- "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "If this option
is true, The http producer won't read response body and cache the input stream"
},
- "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 [...]
"throwExceptionOnFailure": { "kind": "parameter", "displayName": "Throw
Exception On Failure", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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." },
+ "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "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 expir [...]
"cookieHandler": { "kind": "parameter", "displayName": "Cookie Handler",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.http.base.cookie.CookieHandler", "deprecated": false,
"autowired": false, "secret": false, "description": "Configure a cookie handler
to maintain a HTTP session" },
"cookieStore": { "kind": "parameter", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 stor [...]
+ "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use custom host header for producer. When not set in query will be ignored.
When set will override host header derived from url." },
"deleteWithBody": { "kind": "parameter", "displayName": "Delete With
Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 [...]
- "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
"getWithBody": { "kind": "parameter", "displayName": "Get With Body",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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." },
+ "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "If this option is true, The http producer won't read response
body and cache the input stream" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 other [...]
"okStatusCodeRange": { "kind": "parameter", "displayName": "Ok Status Code
Range", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"200-299", "description": "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 [...]
+ "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 he [...]
"skipRequestHeaders": { "kind": "parameter", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing ove [...]
"skipResponseHeaders": { "kind": "parameter", "displayName": "Skip
Response Headers", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether to skip mapping all the HTTP
response headers to Camel headers. If there are no data needed from HTTP
headers then this can avoid parsing overhead with many object allocation [...]
"userAgent": { "kind": "parameter", "displayName": "User Agent", "group":
"producer (advanced)", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To set a custom HTTP User-Agent request
header" },
diff --git
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/https.json
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/https.json
index 4401c4bfbf0..08de0c72539 100644
---
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/https.json
+++
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/https.json
@@ -25,11 +25,11 @@
"verifiers": "parameters,connectivity"
},
"componentProperties": {
- "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.http.client.CookieStore", "deprecated": false,
"autowired": false, "secret": false, "description": "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 f [...]
- "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 heade [...]
+ "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
- "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer", "label":
"producer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 8192,
"description": "This threshold in bytes controls whether the response payload
should be stored in memory as a byte array or be streaming based. Set this to
-1 to always use streaming mode." },
- "followRedirects": { "kind": "property", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
+ "cookieStore": { "kind": "property", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 t [...]
+ "copyHeaders": { "kind": "property", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "responsePayloadStreamingThreshold": { "kind": "property", "displayName":
"Response Payload Streaming Threshold", "group": "producer (advanced)",
"label": "producer,advanced", "required": false, "type": "integer", "javaType":
"int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 8192, "description": "This threshold in bytes controls whether
the response payload should be stored in memory as a byte array or be streaming
based. Set this to -1 to always use st [...]
"skipRequestHeaders": { "kind": "property", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing over [...]
"skipResponseHeaders": { "kind": "property", "displayName": "Skip Response
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the HTTP response headers to Camel
headers. If there are no data needed from HTTP headers then this can avoid
parsing overhead with many object allocations [...]
"allowJavaSerializedObject": { "kind": "property", "displayName": "Allow
Java Serialized Object", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 des [...]
@@ -84,23 +84,23 @@
"properties": {
"httpUri": { "kind": "path", "displayName": "Http Uri", "group": "common",
"label": "common", "required": true, "type": "string", "javaType":
"java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The url of the HTTP endpoint to call." },
"disableStreamCache": { "kind": "parameter", "displayName": "Disable
Stream Cache", "group": "common", "label": "common", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 inpu [...]
- "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "org.apache.camel.spi.HeaderFilterStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom HeaderFilterStrategy to filter header to and from Camel message."
},
+ "headerFilterStrategy": { "kind": "parameter", "displayName": "Header
Filter Strategy", "group": "common (advanced)", "label": "common,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.HeaderFilterStrategy", "deprecated": false, "autowired":
false, "secret": false, "description": "To use a custom HeaderFilterStrategy to
filter header to and from Camel message." },
"bridgeEndpoint": { "kind": "parameter", "displayName": "Bridge Endpoint",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "description": "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 al [...]
- "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": true, "description": "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. If the component [...]
"connectionClose": { "kind": "parameter", "displayName": "Connection
Close", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Specifies whether a
Connection Close header must be added to HTTP Request. By default
connectionClose is false." },
- "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer", "label": "producer", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "description": "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 head [...]
- "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To use custom host header for producer.
When not set in query will be ignored. When set will override host header
derived from url." },
+ "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether to the
HTTP request should follow redirects. By default the HTTP request does not
follow redirects" },
"httpMethod": { "kind": "parameter", "displayName": "Http Method",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "org.apache.camel.http.common.HttpMethods", "enum": [ "GET",
"POST", "PUT", "DELETE", "HEAD", "OPTIONS", "TRACE", "PATCH" ], "deprecated":
false, "autowired": false, "secret": false, "description": "Configure the HTTP
method to use. The HttpMethod header cannot override this option if set." },
- "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer", "label": "producer", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "If this option
is true, The http producer won't read response body and cache the input stream"
},
- "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 [...]
"throwExceptionOnFailure": { "kind": "parameter", "displayName": "Throw
Exception On Failure", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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." },
+ "clearExpiredCookies": { "kind": "parameter", "displayName": "Clear
Expired Cookies", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "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 expir [...]
"cookieHandler": { "kind": "parameter", "displayName": "Cookie Handler",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType":
"org.apache.camel.http.base.cookie.CookieHandler", "deprecated": false,
"autowired": false, "secret": false, "description": "Configure a cookie handler
to maintain a HTTP session" },
"cookieStore": { "kind": "parameter", "displayName": "Cookie Store",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "object", "javaType": "org.apache.http.client.CookieStore",
"deprecated": false, "autowired": false, "secret": false, "description": "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 stor [...]
+ "copyHeaders": { "kind": "parameter", "displayName": "Copy Headers",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description": "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 [...]
+ "customHostHeader": { "kind": "parameter", "displayName": "Custom Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use custom host header for producer. When not set in query will be ignored.
When set will override host header derived from url." },
"deleteWithBody": { "kind": "parameter", "displayName": "Delete With
Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 [...]
- "followRedirects": { "kind": "parameter", "displayName": "Follow
Redirects", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to the HTTP request should follow redirects. By default
the HTTP request does not follow redirects" },
"getWithBody": { "kind": "parameter", "displayName": "Get With Body",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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." },
+ "ignoreResponseBody": { "kind": "parameter", "displayName": "Ignore
Response Body", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "If this option is true, The http producer won't read response
body and cache the input stream" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start
Producer", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 other [...]
"okStatusCodeRange": { "kind": "parameter", "displayName": "Ok Status Code
Range", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"200-299", "description": "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 [...]
+ "preserveHostHeader": { "kind": "parameter", "displayName": "Preserve Host
Header", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "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 he [...]
"skipRequestHeaders": { "kind": "parameter", "displayName": "Skip Request
Headers", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Whether to skip mapping all the Camel headers as HTTP request
headers. If there are no data from Camel headers needed to be included in the
HTTP request then this can avoid parsing ove [...]
"skipResponseHeaders": { "kind": "parameter", "displayName": "Skip
Response Headers", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether to skip mapping all the HTTP
response headers to Camel headers. If there are no data needed from HTTP
headers then this can avoid parsing overhead with many object allocation [...]
"userAgent": { "kind": "parameter", "displayName": "User Agent", "group":
"producer (advanced)", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "To set a custom HTTP User-Agent request
header" },
diff --git
a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpComponent.java
b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpComponent.java
index a727bdb8423..dd3e2123285 100644
---
a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpComponent.java
+++
b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpComponent.java
@@ -96,7 +96,7 @@ public class HttpComponent extends HttpCommonComponent
implements RestProducerFa
@Metadata(label = "security",
description = "To use a custom X509HostnameVerifier such as
DefaultHostnameVerifier or NoopHostnameVerifier.")
protected HostnameVerifier x509HostnameVerifier = new
DefaultHostnameVerifier();
- @Metadata(label = "producer", description = "To use a custom
org.apache.http.client.CookieStore."
+ @Metadata(label = "producer,advanced", description = "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).")
@@ -151,7 +151,7 @@ public class HttpComponent extends HttpCommonComponent
implements RestProducerFa
protected long connectionTimeToLive = -1;
@Metadata(label = "security", defaultValue = "false", description =
"Enable usage of global SSL context parameters.")
protected boolean useGlobalSslContextParameters;
- @Metadata(label = "producer", defaultValue = "8192",
+ @Metadata(label = "producer,advanced", defaultValue = "8192",
description = "This threshold in bytes controls whether the
response payload"
+ " should be stored in memory as a byte array or
be streaming based. Set this to -1 to always use streaming mode.")
protected int responsePayloadStreamingThreshold = 8192;
@@ -170,7 +170,7 @@ public class HttpComponent extends HttpCommonComponent
implements RestProducerFa
@Metadata(label = "advanced",
description = "Disables the default user agent set by this
builder if none has been provided by the user")
protected boolean defaultUserAgentDisabled;
- @Metadata(label = "producer",
+ @Metadata(label = "producer,advanced",
defaultValue = "true",
description = "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).")
@@ -186,7 +186,7 @@ public class HttpComponent extends HttpCommonComponent
implements RestProducerFa
+ " with many object allocations for the JVM
garbage collector.")
protected boolean skipResponseHeaders;
- @Metadata(label = "producer,advanced", defaultValue = "false",
+ @Metadata(label = "producer", defaultValue = "false",
description = "Whether to the HTTP request should follow
redirects."
+ " By default the HTTP request does not follow
redirects ")
protected boolean followRedirects;
diff --git
a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
index b69cb6987f0..2a457174973 100644
---
a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
+++
b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java
@@ -116,7 +116,7 @@ public class HttpEndpoint extends HttpCommonEndpoint {
+ " 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.")
private CookieStore cookieStore = new BasicCookieStore();
- @UriParam(label = "producer", defaultValue = "true",
+ @UriParam(label = "producer,advanced", defaultValue = "true",
description = "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."
+ " If the component has disabled cookie
management then this option is disabled too.")
@@ -137,7 +137,7 @@ public class HttpEndpoint extends HttpCommonEndpoint {
@UriParam(label = "security",
description = "To use a custom X509HostnameVerifier such as
DefaultHostnameVerifier or NoopHostnameVerifier")
private HostnameVerifier x509HostnameVerifier;
- @UriParam(label = "producer", description = "To use custom host header for
producer. When not set in query will "
+ @UriParam(label = "producer,advanced", description = "To use custom host
header for producer. When not set in query will "
+ "be ignored. When set will
override host header derived from url.")
private String customHostHeader;
@UriParam(label = "producer,advanced",
@@ -146,7 +146,7 @@ public class HttpEndpoint extends HttpCommonEndpoint {
+ " parsing overhead with many object allocations
for the JVM garbage collector.")
private boolean skipRequestHeaders;
- @UriParam(label = "producer,advanced", defaultValue = "false",
+ @UriParam(label = "producer", defaultValue = "false",
description = "Whether to the HTTP request should follow
redirects."
+ " By default the HTTP request does not follow
redirects ")
private boolean followRedirects;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpComponentBuilderFactory.java
index b350105110c..a1de842615e 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpComponentBuilderFactory.java
@@ -48,6 +48,45 @@ public interface HttpComponentBuilderFactory {
* Builder for the HTTP component.
*/
interface HttpComponentBuilder extends ComponentBuilder<HttpComponent> {
+ /**
+ * Whether to the HTTP request should follow redirects. By default the
+ * HTTP request does not follow redirects.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param followRedirects the value to set
+ * @return the dsl builder
+ */
+ default HttpComponentBuilder followRedirects(boolean followRedirects) {
+ doSetProperty("followRedirects", followRedirects);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param lazyStartProducer the value to set
+ * @return the dsl builder
+ */
+ default HttpComponentBuilder lazyStartProducer(boolean
lazyStartProducer) {
+ doSetProperty("lazyStartProducer", lazyStartProducer);
+ return this;
+ }
/**
* To use a custom org.apache.http.client.CookieStore. By default the
* org.apache.http.impl.client.BasicCookieStore is used which is an
@@ -58,7 +97,7 @@ public interface HttpComponentBuilderFactory {
* The option is a:
* <code>org.apache.http.client.CookieStore</code> type.
*
- * Group: producer
+ * Group: producer (advanced)
*
* @param cookieStore the value to set
* @return the dsl builder
@@ -77,7 +116,7 @@ public interface HttpComponentBuilderFactory {
* The option is a: <code>boolean</code> type.
*
* Default: true
- * Group: producer
+ * Group: producer (advanced)
*
* @param copyHeaders the value to set
* @return the dsl builder
@@ -86,29 +125,6 @@ public interface HttpComponentBuilderFactory {
doSetProperty("copyHeaders", copyHeaders);
return this;
}
- /**
- * 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.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer
- *
- * @param lazyStartProducer the value to set
- * @return the dsl builder
- */
- default HttpComponentBuilder lazyStartProducer(boolean
lazyStartProducer) {
- doSetProperty("lazyStartProducer", lazyStartProducer);
- return this;
- }
/**
* This threshold in bytes controls whether the response payload should
* be stored in memory as a byte array or be streaming based. Set this
@@ -117,7 +133,7 @@ public interface HttpComponentBuilderFactory {
* The option is a: <code>int</code> type.
*
* Default: 8192
- * Group: producer
+ * Group: producer (advanced)
*
* @param responsePayloadStreamingThreshold the value to set
* @return the dsl builder
@@ -127,22 +143,6 @@ public interface HttpComponentBuilderFactory {
doSetProperty("responsePayloadStreamingThreshold",
responsePayloadStreamingThreshold);
return this;
}
- /**
- * Whether to the HTTP request should follow redirects. By default the
- * HTTP request does not follow redirects.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer (advanced)
- *
- * @param followRedirects the value to set
- * @return the dsl builder
- */
- default HttpComponentBuilder followRedirects(boolean followRedirects) {
- doSetProperty("followRedirects", followRedirects);
- return this;
- }
/**
* Whether to skip mapping all the Camel headers as HTTP request
* headers. If there are no data from Camel headers needed to be
@@ -732,11 +732,11 @@ public interface HttpComponentBuilderFactory {
String name,
Object value) {
switch (name) {
+ case "followRedirects": ((HttpComponent)
component).setFollowRedirects((boolean) value); return true;
+ case "lazyStartProducer": ((HttpComponent)
component).setLazyStartProducer((boolean) value); return true;
case "cookieStore": ((HttpComponent)
component).setCookieStore((org.apache.http.client.CookieStore) value); return
true;
case "copyHeaders": ((HttpComponent)
component).setCopyHeaders((boolean) value); return true;
- case "lazyStartProducer": ((HttpComponent)
component).setLazyStartProducer((boolean) value); return true;
case "responsePayloadStreamingThreshold": ((HttpComponent)
component).setResponsePayloadStreamingThreshold((int) value); return true;
- case "followRedirects": ((HttpComponent)
component).setFollowRedirects((boolean) value); return true;
case "skipRequestHeaders": ((HttpComponent)
component).setSkipRequestHeaders((boolean) value); return true;
case "skipResponseHeaders": ((HttpComponent)
component).setSkipResponseHeaders((boolean) value); return true;
case "allowJavaSerializedObject": ((HttpComponent)
component).setAllowJavaSerializedObject((boolean) value); return true;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpsComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpsComponentBuilderFactory.java
index 46fb0b32f9a..6c092156463 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpsComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/HttpsComponentBuilderFactory.java
@@ -48,6 +48,46 @@ public interface HttpsComponentBuilderFactory {
* Builder for the HTTPS (Secure) component.
*/
interface HttpsComponentBuilder extends ComponentBuilder<HttpComponent> {
+ /**
+ * Whether to the HTTP request should follow redirects. By default the
+ * HTTP request does not follow redirects.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param followRedirects the value to set
+ * @return the dsl builder
+ */
+ default HttpsComponentBuilder followRedirects(boolean followRedirects)
{
+ doSetProperty("followRedirects", followRedirects);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer
+ *
+ * @param lazyStartProducer the value to set
+ * @return the dsl builder
+ */
+ default HttpsComponentBuilder lazyStartProducer(
+ boolean lazyStartProducer) {
+ doSetProperty("lazyStartProducer", lazyStartProducer);
+ return this;
+ }
/**
* To use a custom org.apache.http.client.CookieStore. By default the
* org.apache.http.impl.client.BasicCookieStore is used which is an
@@ -58,7 +98,7 @@ public interface HttpsComponentBuilderFactory {
* The option is a:
* <code>org.apache.http.client.CookieStore</code> type.
*
- * Group: producer
+ * Group: producer (advanced)
*
* @param cookieStore the value to set
* @return the dsl builder
@@ -77,7 +117,7 @@ public interface HttpsComponentBuilderFactory {
* The option is a: <code>boolean</code> type.
*
* Default: true
- * Group: producer
+ * Group: producer (advanced)
*
* @param copyHeaders the value to set
* @return the dsl builder
@@ -86,30 +126,6 @@ public interface HttpsComponentBuilderFactory {
doSetProperty("copyHeaders", copyHeaders);
return this;
}
- /**
- * 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.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer
- *
- * @param lazyStartProducer the value to set
- * @return the dsl builder
- */
- default HttpsComponentBuilder lazyStartProducer(
- boolean lazyStartProducer) {
- doSetProperty("lazyStartProducer", lazyStartProducer);
- return this;
- }
/**
* This threshold in bytes controls whether the response payload should
* be stored in memory as a byte array or be streaming based. Set this
@@ -118,7 +134,7 @@ public interface HttpsComponentBuilderFactory {
* The option is a: <code>int</code> type.
*
* Default: 8192
- * Group: producer
+ * Group: producer (advanced)
*
* @param responsePayloadStreamingThreshold the value to set
* @return the dsl builder
@@ -128,22 +144,6 @@ public interface HttpsComponentBuilderFactory {
doSetProperty("responsePayloadStreamingThreshold",
responsePayloadStreamingThreshold);
return this;
}
- /**
- * Whether to the HTTP request should follow redirects. By default the
- * HTTP request does not follow redirects.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer (advanced)
- *
- * @param followRedirects the value to set
- * @return the dsl builder
- */
- default HttpsComponentBuilder followRedirects(boolean followRedirects)
{
- doSetProperty("followRedirects", followRedirects);
- return this;
- }
/**
* Whether to skip mapping all the Camel headers as HTTP request
* headers. If there are no data from Camel headers needed to be
@@ -735,11 +735,11 @@ public interface HttpsComponentBuilderFactory {
String name,
Object value) {
switch (name) {
+ case "followRedirects": ((HttpComponent)
component).setFollowRedirects((boolean) value); return true;
+ case "lazyStartProducer": ((HttpComponent)
component).setLazyStartProducer((boolean) value); return true;
case "cookieStore": ((HttpComponent)
component).setCookieStore((org.apache.http.client.CookieStore) value); return
true;
case "copyHeaders": ((HttpComponent)
component).setCopyHeaders((boolean) value); return true;
- case "lazyStartProducer": ((HttpComponent)
component).setLazyStartProducer((boolean) value); return true;
case "responsePayloadStreamingThreshold": ((HttpComponent)
component).setResponsePayloadStreamingThreshold((int) value); return true;
- case "followRedirects": ((HttpComponent)
component).setFollowRedirects((boolean) value); return true;
case "skipRequestHeaders": ((HttpComponent)
component).setSkipRequestHeaders((boolean) value); return true;
case "skipResponseHeaders": ((HttpComponent)
component).setSkipResponseHeaders((boolean) value); return true;
case "allowJavaSerializedObject": ((HttpComponent)
component).setAllowJavaSerializedObject((boolean) value); return true;
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/HttpEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/HttpEndpointBuilderFactory.java
index 360bc02b245..6fa9bf5fdcb 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/HttpEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/HttpEndpointBuilderFactory.java
@@ -104,42 +104,6 @@ public interface HttpEndpointBuilderFactory {
doSetProperty("disableStreamCache", disableStreamCache);
return this;
}
- /**
- * To use a custom HeaderFilterStrategy to filter header to and from
- * Camel message.
- *
- * The option is a:
- * <code>org.apache.camel.spi.HeaderFilterStrategy</code>
- * type.
- *
- * Group: common
- *
- * @param headerFilterStrategy the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder headerFilterStrategy(
- org.apache.camel.spi.HeaderFilterStrategy
headerFilterStrategy) {
- doSetProperty("headerFilterStrategy", headerFilterStrategy);
- return this;
- }
- /**
- * To use a custom HeaderFilterStrategy to filter header to and from
- * Camel message.
- *
- * The option will be converted to a
- * <code>org.apache.camel.spi.HeaderFilterStrategy</code>
- * type.
- *
- * Group: common
- *
- * @param headerFilterStrategy the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder headerFilterStrategy(
- String headerFilterStrategy) {
- doSetProperty("headerFilterStrategy", headerFilterStrategy);
- return this;
- }
/**
* 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
@@ -177,47 +141,6 @@ public interface HttpEndpointBuilderFactory {
doSetProperty("bridgeEndpoint", bridgeEndpoint);
return this;
}
- /**
- * 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. If the
- * component has disabled cookie management then this option is
disabled
- * too.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: true
- * Group: producer
- *
- * @param clearExpiredCookies the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder clearExpiredCookies(
- boolean clearExpiredCookies) {
- doSetProperty("clearExpiredCookies", clearExpiredCookies);
- return this;
- }
- /**
- * 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. If the
- * component has disabled cookie management then this option is
disabled
- * too.
- *
- * The option will be converted to a <code>boolean</code>
- * type.
- *
- * Default: true
- * Group: producer
- *
- * @param clearExpiredCookies the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder clearExpiredCookies(
- String clearExpiredCookies) {
- doSetProperty("clearExpiredCookies", clearExpiredCookies);
- return this;
- }
/**
* Specifies whether a Connection Close header must be added to HTTP
* Request. By default connectionClose is false.
@@ -252,55 +175,36 @@ public interface HttpEndpointBuilderFactory {
return this;
}
/**
- * 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).
+ * Whether to the HTTP request should follow redirects. By default the
+ * HTTP request does not follow redirects.
*
* The option is a: <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: producer
*
- * @param copyHeaders the value to set
+ * @param followRedirects the value to set
* @return the dsl builder
*/
- default HttpEndpointBuilder copyHeaders(boolean copyHeaders) {
- doSetProperty("copyHeaders", copyHeaders);
+ default HttpEndpointBuilder followRedirects(boolean followRedirects) {
+ doSetProperty("followRedirects", followRedirects);
return this;
}
/**
- * 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).
+ * Whether to the HTTP request should follow redirects. By default the
+ * HTTP request does not follow redirects.
*
* The option will be converted to a <code>boolean</code>
* type.
*
- * Default: true
- * Group: producer
- *
- * @param copyHeaders the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder copyHeaders(String copyHeaders) {
- doSetProperty("copyHeaders", copyHeaders);
- return this;
- }
- /**
- * To use custom host header for producer. When not set in query will
be
- * ignored. When set will override host header derived from url.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
+ * Default: false
* Group: producer
*
- * @param customHostHeader the value to set
+ * @param followRedirects the value to set
* @return the dsl builder
*/
- default HttpEndpointBuilder customHostHeader(String customHostHeader) {
- doSetProperty("customHostHeader", customHostHeader);
+ default HttpEndpointBuilder followRedirects(String followRedirects) {
+ doSetProperty("followRedirects", followRedirects);
return this;
}
/**
@@ -338,82 +242,6 @@ public interface HttpEndpointBuilderFactory {
doSetProperty("httpMethod", httpMethod);
return this;
}
- /**
- * If this option is true, The http producer won't read response body
- * and cache the input stream.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer
- *
- * @param ignoreResponseBody the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder ignoreResponseBody(
- boolean ignoreResponseBody) {
- doSetProperty("ignoreResponseBody", ignoreResponseBody);
- return this;
- }
- /**
- * If this option is true, The http producer won't read response body
- * and cache the input stream.
- *
- * The option will be converted to a <code>boolean</code>
- * type.
- *
- * Default: false
- * Group: producer
- *
- * @param ignoreResponseBody the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder ignoreResponseBody(String
ignoreResponseBody) {
- doSetProperty("ignoreResponseBody", ignoreResponseBody);
- return this;
- }
- /**
- * 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.
- *
- * The option is a: <code>boolean</code> type.
- *
- * Default: false
- * Group: producer
- *
- * @param preserveHostHeader the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder preserveHostHeader(
- boolean preserveHostHeader) {
- doSetProperty("preserveHostHeader", preserveHostHeader);
- return this;
- }
- /**
- * 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.
- *
- * The option will be converted to a <code>boolean</code>
- * type.
- *
- * Default: false
- * Group: producer
- *
- * @param preserveHostHeader the value to set
- * @return the dsl builder
- */
- default HttpEndpointBuilder preserveHostHeader(String
preserveHostHeader) {
- doSetProperty("preserveHostHeader", preserveHostHeader);
- return this;
- }
/**
* Option to disable throwing the HttpOperationFailedException in case
* of failed responses from the remote server. This allows you to get
@@ -825,6 +653,83 @@ public interface HttpEndpointBuilderFactory {
default HttpEndpointBuilder basic() {
return (HttpEndpointBuilder) this;
}
+ /**
+ * To use a custom HeaderFilterStrategy to filter header to and from
+ * Camel message.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code>
+ * type.
+ *
+ * Group: common (advanced)
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder headerFilterStrategy(
+ org.apache.camel.spi.HeaderFilterStrategy
headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
+ /**
+ * To use a custom HeaderFilterStrategy to filter header to and from
+ * Camel message.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.HeaderFilterStrategy</code>
+ * type.
+ *
+ * Group: common (advanced)
+ *
+ * @param headerFilterStrategy the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder headerFilterStrategy(
+ String headerFilterStrategy) {
+ doSetProperty("headerFilterStrategy", headerFilterStrategy);
+ return this;
+ }
+ /**
+ * 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. If the
+ * component has disabled cookie management then this option is
disabled
+ * too.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param clearExpiredCookies the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder clearExpiredCookies(
+ boolean clearExpiredCookies) {
+ doSetProperty("clearExpiredCookies", clearExpiredCookies);
+ return this;
+ }
+ /**
+ * 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. If the
+ * component has disabled cookie management then this option is
disabled
+ * too.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param clearExpiredCookies the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder clearExpiredCookies(
+ String clearExpiredCookies) {
+ doSetProperty("clearExpiredCookies", clearExpiredCookies);
+ return this;
+ }
/**
* Configure a cookie handler to maintain a HTTP session.
*
@@ -899,6 +804,59 @@ public interface HttpEndpointBuilderFactory {
doSetProperty("cookieStore", cookieStore);
return this;
}
+ /**
+ * 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).
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param copyHeaders the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder copyHeaders(boolean copyHeaders) {
+ doSetProperty("copyHeaders", copyHeaders);
+ return this;
+ }
+ /**
+ * 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).
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: true
+ * Group: producer (advanced)
+ *
+ * @param copyHeaders the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder copyHeaders(String copyHeaders) {
+ doSetProperty("copyHeaders", copyHeaders);
+ return this;
+ }
+ /**
+ * To use custom host header for producer. When not set in query will
be
+ * ignored. When set will override host header derived from url.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: producer (advanced)
+ *
+ * @param customHostHeader the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder customHostHeader(
+ String customHostHeader) {
+ doSetProperty("customHostHeader", customHostHeader);
+ return this;
+ }
/**
* Whether the HTTP DELETE should include the message body or not. By
* default HTTP DELETE do not include any HTTP body. However in some
@@ -936,25 +894,26 @@ public interface HttpEndpointBuilderFactory {
return this;
}
/**
- * Whether to the HTTP request should follow redirects. By default the
- * HTTP request does not follow redirects.
+ * 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.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: producer (advanced)
*
- * @param followRedirects the value to set
+ * @param getWithBody the value to set
* @return the dsl builder
*/
- default AdvancedHttpEndpointBuilder followRedirects(
- boolean followRedirects) {
- doSetProperty("followRedirects", followRedirects);
+ default AdvancedHttpEndpointBuilder getWithBody(boolean getWithBody) {
+ doSetProperty("getWithBody", getWithBody);
return this;
}
/**
- * Whether to the HTTP request should follow redirects. By default the
- * HTTP request does not follow redirects.
+ * 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.
*
* The option will be converted to a <code>boolean</code>
* type.
@@ -962,35 +921,33 @@ public interface HttpEndpointBuilderFactory {
* Default: false
* Group: producer (advanced)
*
- * @param followRedirects the value to set
+ * @param getWithBody the value to set
* @return the dsl builder
*/
- default AdvancedHttpEndpointBuilder followRedirects(
- String followRedirects) {
- doSetProperty("followRedirects", followRedirects);
+ default AdvancedHttpEndpointBuilder getWithBody(String getWithBody) {
+ doSetProperty("getWithBody", getWithBody);
return this;
}
/**
- * 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.
+ * If this option is true, The http producer won't read response body
+ * and cache the input stream.
*
* The option is a: <code>boolean</code> type.
*
* Default: false
* Group: producer (advanced)
*
- * @param getWithBody the value to set
+ * @param ignoreResponseBody the value to set
* @return the dsl builder
*/
- default AdvancedHttpEndpointBuilder getWithBody(boolean getWithBody) {
- doSetProperty("getWithBody", getWithBody);
+ default AdvancedHttpEndpointBuilder ignoreResponseBody(
+ boolean ignoreResponseBody) {
+ doSetProperty("ignoreResponseBody", ignoreResponseBody);
return this;
}
/**
- * 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.
+ * If this option is true, The http producer won't read response body
+ * and cache the input stream.
*
* The option will be converted to a <code>boolean</code>
* type.
@@ -998,11 +955,12 @@ public interface HttpEndpointBuilderFactory {
* Default: false
* Group: producer (advanced)
*
- * @param getWithBody the value to set
+ * @param ignoreResponseBody the value to set
* @return the dsl builder
*/
- default AdvancedHttpEndpointBuilder getWithBody(String getWithBody) {
- doSetProperty("getWithBody", getWithBody);
+ default AdvancedHttpEndpointBuilder ignoreResponseBody(
+ String ignoreResponseBody) {
+ doSetProperty("ignoreResponseBody", ignoreResponseBody);
return this;
}
/**
@@ -1073,6 +1031,49 @@ public interface HttpEndpointBuilderFactory {
doSetProperty("okStatusCodeRange", okStatusCodeRange);
return this;
}
+ /**
+ * 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.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param preserveHostHeader the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder preserveHostHeader(
+ boolean preserveHostHeader) {
+ doSetProperty("preserveHostHeader", preserveHostHeader);
+ return this;
+ }
+ /**
+ * 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.
+ *
+ * The option will be converted to a <code>boolean</code>
+ * type.
+ *
+ * Default: false
+ * Group: producer (advanced)
+ *
+ * @param preserveHostHeader the value to set
+ * @return the dsl builder
+ */
+ default AdvancedHttpEndpointBuilder preserveHostHeader(
+ String preserveHostHeader) {
+ doSetProperty("preserveHostHeader", preserveHostHeader);
+ return this;
+ }
/**
* Whether to skip mapping all the Camel headers as HTTP request
* headers. If there are no data from Camel headers needed to be
