HttpEndpoint Options - 6.3

Talend ESB Mediation Developer Guide

EnrichVersion
6.3
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend ESB

Table 11. 

Name

Default Value

Description

throwExceptionOnFailure

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

false

If true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for requests. You may also set the throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. Also if set to true HttpProducer and CamelServlet will skip the gzip processing if the content-encoding is "gzip".

clearExpiredCookies

true

Camel 2.11.2/2.12.0: 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.

cookieStore

null

Camel 2.11.2/2.12.0: 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 cookies shouldn't be stored as we are just bridging (eg acting as a proxy).

disableStreamCache

false

DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support multiple reads, otherwise DefaultHttpBinding will set the request input stream directly in the message body.

headerFilterStrategy

null

Reference to a instance of org.apache.camel.spi.

HeaderFilterStrategy in the Registry. It will be used to apply the custom headerFilterStrategy on the new create HttpEndpoint.

httpBindingRef

null

Deprecated and will be removed in Camel 3.0: Reference to a org.apache.camel.component.

http.HttpClientConfigurer

in the Registry. Use the httpClientConfigurer option instead.

httpBinding

null

To use a custom org.apache.camel.

component.http.HttpBinding.

httpClientConfigurerRef

null

Deprecated and will be removed in Camel 3.0: Reference to a

org.apache.camel.component.

http.HttpClientConfigurer in the Registry. Use the httpClientConfigurer option instead.

httpClientConfigurer

null

Reference to a org.apache.camel.component.

http.HttpClientConfigurer in the Registry.

httpContextRef

null

Deprecated and will be removed in Camel 3.0:Camel 2.9.2: Reference to a custom org.apache.http.

protocol.HttpContext in the Registry. Use the httpContext instead.

httpContext

null

Camel 2.9.2: To use a custom org.apache.http.

protocol.HttpContext when executing requests.

httpClient.XXX

null

Setting options on the BasicHttpParams. For instance httpClient.soTimeout=5000 will set the SO_TIMEOUT to 5 seconds. Look on the setter methods of the following parameter beans for a complete reference: AuthParamBean, ClientParamBean, ConnConnectionParamBean, ConnRouteParamBean, CookieSpecParamBean, HttpConnectionParamBean and HttpProtocolParamBean

Since Camel 2.13.0: httpClient is changed to configure the HttpClientBuilder and RequestConfig.Builder, please check out API document for a complete reference.

clientConnectionManager

null

To use a custom org.apache.http.

conn.ClientConnectionManager.

transferException

false

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Camel Component: Jetty or Camel Component: Servlet Camel components). 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.

sslContextParametersRef

null

Deprecated and will be removed in Camel 3.0:Camel 2.8: Reference to a org.apache.camel.util.

jsse.SSLContextParameters

in the Registry. 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. See further below for more details. See Using the JSSE Configuration Utility. Use the sslContextParameters option instead.

sslContextParameters

null

Camel 2.11.1: Reference to a org.apache.camel.util.jsse.

SSLContextParameters in the Registry. 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. See further below for more details. See Using the JSSE Configuration Utility.

x509HostnameVerifier

BrowserCompatHost

nameVerifier

Camel 2.7: You can refer to a different org.apache.http.conn.ssl.

X509HostnameVerifier instance in the Registry such as org.apache.http.conn.ssl.

StrictHostnameVerifier or org.apache.http.conn.ssl.

AllowAllHostnameVerifier.

urlRewrite

null

Camel 2.11:Producer only Refers to a custom org.apache.camel.component.

http4.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at UrlRewrite and How to use Camel as a HTTP proxy between a client and server.

maxTotalConnections

null

Camel 2.14: The maximum number of total connections that the connection manager has. If this option is not set, camel will use the component's setting instead.

connectionsPerRoute

null

Camel 2.14: The maximum number of connections per route. If this option is not set, camel will use the component's setting instead.


The following authentication options can also be set on the HttpEndpoint:

Setting Basic Authentication and Proxy

Before Camel 2.8.0

Name

Default Value

Description

authUsername

null

Username for authentication.

authPassword

null

Password for authentication.

authDomain

null

The domain name for authentication.

authHost

null

The host name authentication.

proxyAuthHost

null

The proxy host name

proxyAuthPort

null

The proxy port number

proxyAuthScheme

null

The proxy scheme, will fallback and use the scheme from the endpoint if not configured.

proxyAuthUsername

null

Username for proxy authentication

proxyAuthPassword

null

Password for proxy authentication

proxyAuthDomain

null

The proxy domain name

proxyAuthNtHost

null

The proxy Nt host name

Since Camel 2.8.0

Name

Default Value

Description

username

null

Username for authentication.

password

null

Password for authentication.

domain

null

The domain name for authentication.

host

null

The host name authentication.

proxyHost

null

The proxy host name

proxyPort

null

The proxy port number

proxyUsername

null

Username for proxy authentication

proxyPassword

null

Password for proxy authentication

proxyDomain

null

The proxy domain name

proxyNtHost

null

The proxy Nt host name