Represents a HTTP endpoint
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
httpUri | path | java.net.URI | true | false | The url of the HTTP endpoint to call. | ||
cookieStore | parameter | org.apache.http.client.CookieStore | false | 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). | |||
authenticationPreemptive | parameter | boolean | false | If this option is true, camel-http4 sends preemptive basic authentication to the server. | |||
clearExpiredCookies | parameter | boolean | false | true | 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. | ||
headerFilterStrategy | parameter | org.apache.camel.spi.HeaderFilterStrategy | false | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | |||
binding | parameter | org.apache.camel.http.common.HttpBinding | false | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | |||
throwExceptionOnFailure | parameter | boolean | false | true | 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. | ||
bridgeEndpoint | parameter | boolean | false | 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. | |||
matchOnUriPrefix | parameter | boolean | false | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | |||
chunked | parameter | boolean | false | true | If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response | ||
disableStreamCache | parameter | boolean | false | Determines whether or not the raw input stream from Jetty 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 Jetty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Jetty to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. | |||
proxyHost | parameter | java.lang.String | false | The proxy host name | |||
proxyPort | parameter | int | false | The proxy port number | |||
authMethodPriority | parameter | java.lang.String | false | Basic Digest NTLM |
Authentication method for proxy, either as Basic, Digest or NTLM. | ||
transferException | parameter | boolean | false | 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. | |||
traceEnabled | parameter | boolean | false | Specifies whether to enable HTTP TRACE for this Jetty consumer. By default TRACE is turned off. | |||
httpMethodRestrict | parameter | java.lang.String | false | Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | |||
responseBufferSize | parameter | java.lang.Integer | false | To use a custom buffer size on the javax.servlet.ServletResponse. | |||
ignoreResponseBody | parameter | boolean | false | If this option is true, The http producer won't read response body and cache the input stream | |||
copyHeaders | parameter | boolean | false | true | 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). | ||
eagerCheckContentAvailable | parameter | boolean | false | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. | |||
okStatusCodeRange | parameter | java.lang.String | false | 200-299 | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | ||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |