HTTPS (Secure)

Send requests to external HTTP servers using Apache HTTP Client 5.x.

Metadata

Property	Value
Scheme	`https`
Support Level	Stable
Labels	http
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-http</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`httpUri`	string	✓		The url of the HTTP endpoint to call.
`disableStreamCache`	boolean		`false`	Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) 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 (the stream can only be read once) as the message body.
`headerFilterStrategy`	object			To use a custom HeaderFilterStrategy to filter header to and from Camel message.
`bridgeEndpoint`	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.
`connectionClose`	boolean		`false`	Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
`httpMethod`	object			Configure the HTTP method to use. The HttpMethod header cannot override this option if set.
`logHttpActivity`	boolean		`false`	To enable logging HTTP request and response. You can use a custom LoggingHttpActivityListener as httpActivityListener to control logging options.
`skipRequestHeaders`	boolean		`false`	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 overhead with many object allocations for the JVM garbage collector.
`skipResponseHeaders`	boolean		`false`	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 for the JVM garbage collector.
`throwExceptionOnFailure`	boolean		`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.
`clearExpiredCookies`	boolean		`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. If the component has disabled cookie management then this option is disabled too.
`cookieHandler`	object			Configure a cookie handler to maintain a HTTP session
`cookieStore`	object			To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler.
`copyHeaders`	boolean		`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).
`customHostHeader`	string			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`	boolean		`false`	Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body.
`followRedirects`	boolean		`false`	Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects
`getWithBody`	boolean		`false`	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.
`httpActivityListener`	object			To use a custom activity listener
`ignoreResponseBody`	boolean		`false`	If this option is true, The http producer won't read response body and cache the input stream
`lazyStartProducer`	boolean		`false`	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.
`okStatusCodeRange`	string		`200-299`	The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included.
`preserveHostHeader`	boolean		`false`	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
`userAgent`	string			To set a custom HTTP User-Agent request header
`clientBuilder`	object			Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
`clientConnectionManager`	object			To use a custom HttpClientConnectionManager to manage connections
`connectionsPerRoute`	integer		`20`	The maximum number of connections per route.
`httpClient`	object			Sets a custom HttpClient to be used by the producer
`httpClientConfigurer`	object			Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc.
`httpClientOptions`	object			To configure the HttpClient using the key/values from the Map.
`httpConnectionOptions`	object			To configure the connection and the socket using the key/values from the Map.
`httpContext`	object			To use a custom HttpContext instance
`maxTotalConnections`	integer		`200`	The maximum number of connections.
`useSystemProperties`	boolean		`false`	To use System Properties as fallback for configuration for configuring HTTP Client
`proxyAuthDomain`	string			Proxy authentication domain to use with NTML
`proxyAuthHost`	string			Proxy authentication host
`proxyAuthMethod`	string			Proxy authentication method to use
`proxyAuthNtHost`	string			Proxy authentication domain (workstation name) to use with NTML
`proxyAuthPassword`	string			Proxy authentication password
`proxyAuthPort`	integer			Proxy authentication port
`proxyAuthScheme`	string			Proxy authentication scheme to use
`proxyAuthUsername`	string			Proxy authentication username
`proxyHost`	string			Proxy hostname to use
`proxyPort`	integer			Proxy port to use
`authDomain`	string			Authentication domain to use with NTML
`authenticationPreemptive`	boolean		`false`	If this option is true, camel-http sends preemptive basic authentication to the server.
`authHost`	string			Authentication host to use with NTML
`authMethod`	string			Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM.
`authMethodPriority`	string			Which authentication method to prioritize to use, either as Basic, Digest or NTLM.
`authPassword`	string			Authentication password
`authUsername`	string			Authentication username
`oauth2CachedTokensDefaultExpirySeconds`	integer		`3600`	Default expiration time for cached OAuth2 tokens, in seconds. Used if token response does not contain 'expires_in' field.
`oauth2CachedTokensExpirationMarginSeconds`	integer		`5`	Amount of time which is deducted from OAuth2 tokens expiry time to compensate for the time it takes OAuth2 Token Endpoint to send the token over http, in seconds. Set this parameter to high value if you OAuth2 Token Endpoint answers slowly or you tokens expire quickly. If you set this parameter to too small value, you can get 4xx http errors because camel will think that the received token is still valid, while in reality the token is expired for the Authentication server.
`oauth2CacheTokens`	boolean		`false`	Whether to cache OAuth2 client tokens.
`oauth2ClientId`	string			OAuth2 client id
`oauth2ClientSecret`	string			OAuth2 client secret
`oauth2Scope`	string			OAuth2 scope
`oauth2TokenEndpoint`	string			OAuth2 Token endpoint
`sslContextParameters`	object			To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need.
`x509HostnameVerifier`	object			To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier