; Thu, 13 Aug 2015 11:19:35 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r961710 [5/6] - in /websites/production/camel/content: book-component-appendix.html book-in-one-page.html cache/main.pageCache camel-2160-release.html http.html http4.html jetty.html Date: Thu, 13 Aug 2015 11:19:34 -0000 To: commits@camel.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150813111935.22C74AC1AA5@hades.apache.org> Modified: websites/production/camel/content/http4.html ============================================================================== --- websites/production/camel/content/http4.html (original) +++ websites/production/camel/content/http4.html Thu Aug 13 11:19:33 2015 @@ -96,7 +96,7 @@

camel-http4 vs camel-http

Camel-http4 uses Apache HttpClient 4.x while camel-http uses Apache HttpClient 3.x.

URI format

Will by default use port 80 for HTTP and 443 for HTTPS.

You can append query options to the URI in the following format, ?option=value&option=value&...

camel-http4 vs camel-jetty

You can only produce to endpoints generated by the HTTP4 component. Therefore it should never be used as input into your Camel Routes. To bind/expose an HTTP endpoint via a HTTP server as input to a Camel route, use the Jetty Component instead.

HttpComponent Options

Name	Default Value	Description
`maxTotalConnections`	`200`	The maximum number of connections.
`connectionsPerRoute`	`20`	The maximum number of connections per route.
`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).
`httpClientConfigurer`	`null`	Reference to a `org.apache.camel.component.http.HttpClientConfigurer` in the Registry.
`clientConnectionManager`	`null`	To use a custom `org.apache.http.conn.ClientConnectionManager.`
`httpBinding`	`null`	To use a custom `org.apache.camel.component.http.HttpBinding`.
`httpContext`	`null`	Camel 2.9.2: To use a custom `org.apache.http.protocol.HttpContext` when executing requests.
`sslContextParameters`	`null`	Camel 2.8: To use a custom `org.apache.camel.util.jsse.SSLContextParam eters`. See Using the JSSE Configuration Utility. 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.
`x509HostnameVerifier`	`BrowserCompatHostnameVerifier`	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`.< /p>
`connectionTimeToLive`	`-1`	Camel 2.11.0: The time for connection to live, the time unit is millisecond, the default value is always keep alive.

HttpEndpoint Options

Name	Default Value	Description
`throwExceptionOnFailure`	`true`	Opt ion 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 request. You may also set the throwExcpetionOnFailure to be false to let the HttpProducer send all fault responses 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 the 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`	Camel 2.10.4: 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.HttpBinding` in the Registry. Use the `httpBinding` 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 `o rg.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` option 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 para meter 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.
`clientConn ectionManager`	`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 Jetty or SERVLET Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the `HttpOperationFailedException`. T he 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`	`BrowserCompatHostnameVerifier`	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.
`authenticationPreemptive`	`false`	Camel 2.11.3/2.12.2: If this option is true, camel-http4 sends preemptive basic authentication to the server.
`eagerCheckContentAvailable`	`false`	Camel 2.16: Consumer only 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.
`copyHeaders`	`true`	Camel 2.16: 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 following authentication options can also be set on the HttpEndpoint:

Setting Basic Authentication and Proxy

Before 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

Since 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

Message Headers

Name	Type	Desc ription
`Exchange.HTTP_URI`	`String`	URI to call. Will override existing URI set directly on the endpoint.
`Exchange.HTTP_PATH`	`String`	Request URI's path, the header will be used to build the request URI with the HTTP_URI.
`Exchange.HTTP_QUERY`	`String`	URI parameters. Will override existing URI parameters set directly on the endpoint.
`Exchange.HTTP_RESPONSE_CODE`	`int`	The HTTP response code from the external server. Is 200 for OK.
`Exchange.HTTP_CHARACTER_ENCODING`	`String`	Character encoding.
`Exchange.CONTENT_TYPE`	`String`	The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as `text/html`.
Exchange.CONTENT_ENCODING	`String`	The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as `gzip`.

Message Body

Camel will store the HTTP response from the external server on the OUT body. All headers from the IN message will be copied to the OUT message, so headers are preserved during routing. Additionally Camel will add the HTTP response headers as well to the OUT message headers.

Response code

Camel will handle according to the HTTP response code:

Response code is in the range 100..299, Camel regards it as a success response.
Response code is in the range 300..399, Camel regards it as a redirection response and will throw a HttpOperat ionFailedException with the information.
Response code is 400+, Camel regards it as an external server failure and will throw a HttpOperationFailedException with the information.
throwExceptionOnFailure
The option, throwExceptionOnFailure, can be set to false to prevent the HttpOperationFailedException from being thrown for failed response codes. This allows you to get any response from the remote server.
There is a sample below demonstrating this.

HttpOperationFailedException

This exception contains the following information:

The HTTP status code
The HTTP status line (text of the status code)
Redirect location, if server returned a redirect
Response body as a java.lang.String, if server provided a body as response

Calling using GET or POST

The following algorithm is used to determine whether the GET or POST HTTP method should be used:
1. Use method provided in header.
2. GET if query string is provided in header.
3. GET if endpoint is configured with a query string.
4. POST if there is data to send (body is not null).
5. GET otherwise.

How to get access to HttpServletRequest and HttpServletResponse

You can get access to these two using the Camel type converter system using
N OTE You can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint.

Will by default use port 80 for HTTP and 443 for HTTPS.

You can append query options to the URI in the following format, ?option=value&option=value&...

camel-http4 vs camel-jetty

HttpComponent Options

Name	Default Value	Description
`maxTotalConnections`	`200`	The maximum number of connections.
`connectionsPerRoute`	`20`	The maximum number of connections per route.
`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).
`httpClientConfigurer`	`null`	Reference to a `org.apache.camel.component.http.HttpClientConfigurer` in the Registry.
`clientConnectionManager`	`null`	To use a custom `org.apache.http.conn.ClientConnectionManager.`
`httpBinding`	`null`	To use a custom `org.apache.camel.component.http.HttpBinding`.
`httpContext`	`null`	Camel 2.9.2: To use a custom `org.apache.http.protocol.HttpContext` when executing requests.
`sslContextParameters`	`null`	Camel 2.8: To use a custom `org.apache.camel.util.jsse.SSLContextParam eters`. See Using the JSSE Configuration Utility. 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.
`x509HostnameVerifier`	`BrowserCompatHostnameVerifier`	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`.< /p>
`connectionTimeToLive`	`-1`	Camel 2.11.0: The time for connection to live, the time unit is millisecond, the default value is always keep alive.

HttpEndpoint Options

Name	Default Value	Description
`throwExceptionOnFailure`	`true`	Opt ion 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 request. You may also set the throwExcpetionOnFailure to be false to let the HttpProducer send all fault responses 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 the 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`	Camel 2.10.4: 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.HttpBinding` in the Registry. Use the `httpBinding` 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 `o rg.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` option 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 para meter 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.
`clientConn ectionManager`	`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 Jetty or SERVLET Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the `HttpOperationFailedException`. T he 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`	`BrowserCompatHostnameVerifier`	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.
`authenticationPreemptive`	`false`	Camel 2.11.3/2.12.2: If this option is true, camel-http4 sends preemptive basic authentication to the server.
`eagerCheckContentAvailable`	`false`	Camel 2.16: Consumer only 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.
`copyHeaders`	`true`	Camel 2.16: 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).
`okStatusCodeRange`	`200-299`	Camel 2.16: 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.

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

Setting Basic Authentication and Proxy

Before Camel 2.8.0

< tr>

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

Since 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

Message Headers

Name	Type	Description
`Exchange.HTTP_URI`	`String`	URI to call. Will override existing URI set directly on the endpoint.
`Exchange.HTTP_PATH`	`String`	Request URI's path, the header will be u sed to build the request URI with the HTTP_URI.
`Exchange.HTTP_QUERY`	`String`	URI parameters. Will override existing URI parameters set directly on the endpoint.
`Exchange.HTTP_RESPONSE_CODE`	`int`	The HTTP response code from the external server. Is 200 for OK.
`Exchange.HTTP_CHARACTER_ENCODING`	`String`	Character encoding.
`Exchange.CONTENT_TYPE`	`String`	The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as `text/html`.
`Exchange.CONTENT_ENCODING`	`String`	The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as `gzip`.

Message Body

Response code

Camel will handle according to the HTTP response code:

Response code is in the range 100..299, Camel regards it as a success response.
Response code is in the range 300..399, Camel regards it as a redirection response and will throw a HttpOperationFailedException with the information.
Response code is 400+, Camel regards it as an external server failure and will throw a HttpOperationFailedException with the information.
throwExceptionOnFailure
The option, throwExceptionOnFailure, can be set to false to prevent the HttpOperation FailedException from being thrown for failed response codes. This allows you to get any response from the remote server.
There is a sample below demonstrating this.

HttpOperationFailedException

This exception contains the following information:

The HTTP status code
The HTTP status line (text of the status code)
Redirect location, if server returned a redirect
Response body as a java.lang.String, if server provided a body as response

Calling using GET or POST

The following algorithm is used to determine whether the GET or POST HTTP method should be used:
1. Use method provided in header.
2. GET if query string is provided in header.
3. GET if endpoint is configured wi th a query string.
4. POST if there is data to send (body is not null).
5. GET otherwise.

How to get access to HttpServletRequest and HttpServletResponse

You can get access to these two using the Camel type converter system using
NOTE You can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint.