...
HTTP
...
Component
...
The
...
http:
...
component
...
provides
...
HTTP
...
based
...
...
for
...
consuming
...
external
...
HTTP
...
resources
...
(as
...
a
...
client
...
to
...
call
...
external
...
servers
...
using
...
HTTP).
...
Maven
...
users
...
will
...
need
...
to
...
add
...
the
...
following
...
dependency
...
to
...
their
...
pom.xml
...
for
...
this
...
component:
...
...
URI Format
...
Will
...
by
...
default
...
use
...
port 80
...
for
...
HTTP
...
and 443
...
for
...
HTTPS.
...
...
You
...
can
...
only
...
produce
...
to
...
endpoints
...
generated
...
by
...
the
...
HTTP
...
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,
...
you
...
can
...
use
...
the
...
...
...
or
...
the
...
...
Examples
Call the URL with the body using POST
and return response as the OUT
message. If body is null
call URL using GET
and return response as OUT
message:
Java DSL | Spring DSL |
---|---|
...
...
xml |
...
...
...
You can override the HTTP endpoint URI by adding a header. Camel will call the http://newhost
...
.
...
This
...
is
...
very
...
handy
...
for
...
e.g.
...
REST URLs:
Java DSL |
---|
java |
...
...
...
...
URI parameters can either be set directly on the endpoint URI or as a header:
Java DSL |
---|
java |
...
...
...
...
...
...
Set the HTTP request method to POST
:
Java DSL | Spring DSL |
---|---|
...
...
...
...
xml |
...
...
...
...
...
...
...
...
...
HttpEndpoint
Options
...
Name | Default Value | Description |
---|---|---|
|
| Option to disable throwing the |
|
| If the option is From Camel 2.3: when |
|
| When When From Camel 2.17: this options is now also support by the producer to allow using the response stream directly instead of stream caching as by default. |
|
|
|
...
|
...
|
...
...
| ||
|
| From Camel 2.3: reference to a |
...
in |
...
the |
...
...
. | ||
|
|
|
...
|
...
|
...
| ||
|
| From Camel 2.3: reference to a |
...
in |
...
the |
...
...
. |
|
...
| Use this to option to configure the underlying HttpClientParams. Example: |
...
will |
...
set |
...
the |
...
|
...
to |
...
5 |
...
seconds. |
...
|
| To use a custom |
...
. | ||
|
| From Camel 2.6: |
...
If |
...
enabled |
...
and |
...
an |
...
...
failed |
...
processing |
...
on |
...
the |
...
consumer |
...
side, |
...
and |
...
if |
...
the |
...
caused |
...
|
...
was |
...
send |
...
back |
...
serialized |
...
in |
...
the |
...
response |
...
as |
...
a |
...
|
...
content |
...
type |
...
(for |
...
example |
...
using |
...
...
or SERVLET Camel components). |
...
On |
...
the |
...
producer |
...
side |
...
the |
...
exception |
...
will |
...
be |
...
deserialized |
...
and |
...
thrown |
...
as |
...
is, |
...
instead |
...
of |
...
the |
...
|
...
. |
...
The |
...
caused |
...
exception will be serialized. | ||
|
| From Camel 2.11: reference to a instance of |
...
in |
...
the |
...
...
. |
...
It |
...
will |
...
be |
...
used |
...
to |
...
apply |
...
the |
...
custom |
...
on |
...
the |
...
new |
...
create |
...
|
...
|
| From Camel 2.11: |
...
Producer |
...
only |
...
! Refers |
...
to |
...
a |
...
custom |
...
|
...
which |
...
allows |
...
you |
...
to |
...
rewrite |
...
URLs when |
...
you |
...
bridge/proxy |
...
endpoints. |
...
See |
...
more |
...
details |
...
at |
...
...
and |
...
...
...
...
...
...
...
...
...
...
...
...
...
|
| From Camel 2.15.3/2.16: Consumer only! Whether to eager check whether the HTTP requests has content when This option should be set to |
|
| From Camel 2.16: if this option is true then Setting this to |
|
| From Camel 2.16: the range of HTTP status codes for which a response is considered a success. The values are inclusive. The range must be in the form |
|
| From Camel 2.16: when |
|
| From Camel: 2.19: configure a cookie handler to maintain a HTTP session |
Authentication and Proxy
The following authentication options can also be set on the HttpEndpoint
:
...
Name | Default Value | Description |
---|---|---|
|
| Authentication method, either as |
|
| Priority of authentication methods. Is a list separated with comma. For example: |
|
| Username for authentication. |
|
| Password for authentication. |
|
| Domain for |
|
| Optional host for |
|
| The proxy host name. |
|
| The proxy port number. |
|
| Authentication method for proxy, either as |
|
| Username for proxy authentication. |
|
| Password for proxy authentication. |
|
| Domain for proxy |
|
| Optional host for proxy |
When using authentication you must provide the choice of method for the authMethod
or authProxyMethod
options. You can configure the proxy and authentication details on either the HttpComponent
or the HttpEndoint
. Values provided on the HttpEndpoint
will take precedence over HttpComponent
. Its most likely best to configure this on the HttpComponent
which allows you to do this once.
The HTTP component uses convention over configuration which means that if you have not explicit set a authMethodPriority
then it will fallback and use the select(ed) authMethod
as priority as well. So if you use authMethod.Basic
then the auhtMethodPriority
will be Basic
only.
...
Note: camel-http
is based on HttpClient v3.x and as such has only limited support for what is known as NTLMv1, the early version of the NTLM protocol. It does not support NTLMv2 at all. camel-http4
has support for NTLMv2.
HttpComponent
Options
...
Name | Default Value | Description |
---|---|---|
|
| To use a custom |
...
. | ||
|
| To use a custom |
...
. | ||
|
| To use a custom |
...
. | ||
|
| To use a custom |
|
| Camel 2.16.1/2.15.5: Whether to allow java serialization when a request uses If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. |
HttpConfiguration
contains all the options listed in the table above under the section HttpConfiguration - Setting Authentication and Proxy.
Message Headers
...
Name | Type | Description |
---|---|---|
|
| URI to call. Will override existing URI set directly on the endpoint. This URI is the URI of the HTTP server to call. Its not the same as the Camel endpoint URI, where you can configure endpoint options such as security etc. This header does not support that, its only the URI of the HTTP server. |
|
| HTTP method/verb to use. Can be one of:
|
|
| The request URI's path. The header will be used to build the request URI with the From Camel 2.3.0: if the path starts with a |
...
header |
...
or |
...
the |
...
|
...
. |
|
...
| URI parameters. |
...
Will |
...
override |
...
existing |
...
URI |
...
parameters |
...
set |
...
directly |
...
on |
...
the |
...
endpoint. |
...
|
...
| The HTTP response code from the external server. Is | |
|
...
| Character encoding. | |
|
...
| The HTTP content type. Is set on both the | |
|
...
| The HTTP content encoding. Is set on both the | |
|
...
| The | |
|
...
| The | |
|
...
| From Camel 2.5: |
...
You |
...
can |
...
set |
...
the |
...
HTTP protocol |
...
version |
...
with |
...
this |
...
header, |
...
e.g., |
...
. |
...
If |
...
the |
...
header is not present the |
...
Note: The header names above are constants. For the spring DSL you have to use the value of the constant instead of the name.
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 aHttpOperationFailedException
with the information. Response code is
throwExceptionOnFailure400+
, Camel regards it as an external server failure and will throw aHttpOperationFailedException
with the information.The option,
throwExceptionOnFailure
, can be set tofalse
to prevent theHttpOperationFailedException
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 if either GET
or POST
HTTP method should be used:
- Use method provided in header.
GET
if query string is provided in header.GET
if endpoint is configured with a query string.POST
if there is data to send (body is not null).GET
otherwise.
How To Access The HttpServletRequest
and HttpServletResponse
You can get access to these two using the Camel type converter system using:
...
Using Client Timeout - SO_TIMEOUT
...
See
...
the
...
unit
...
test
...
in
...
...
More Examples
Configuring a Proxy
Java DSL |
---|
...
...
There is also support for proxy authentication via the proxyUsername
and proxyPassword
options.
Using Proxy Settings Outside of the URI
Java DSL | Spring DSL |
---|---|
...
...
...
...
...
...
...
...
...
...
...
Options on Endpoint
will override options on the context.
Configuring charset
If you are using POST
to send data you can configure the charset
:
...
Sample with Scheduled Poll
The sample polls the Google homepage every 10 seconds and write the page to the file message.html
:
...
Getting the Response Code
You can get the HTTP response code from the HTTP component by getting the value from the OUT
message header with Exchange.HTTP_RESPONSE_CODE
...
:
...
Using throwExceptionOnFailure=false
To Obtain All Server Responses
In the route below we want to route a message that we enrich with data returned from a remote HTTP call. As we want all responses from the remote server, we set the throwExceptionOnFailure=false
so we get any response in the AggregationStrategy
. As the code is based on a unit test that simulates a HTTP status code 404, there is some assertion code etc.
...
...
Disabling
...
Cookies
...
To
...
disable
...
cookies
...
you
...
can
...
set
...
the
...
HTTP
...
Client
...
to
...
ignore
...
cookies
...
by
...
adding
...
this
...
URI
...
option:
...
httpClient.cookiePolicy=ignoreCookies
...
Advanced Usage
If you need more control over the HTTP producer you should use the HttpComponent
where you can set various classes to give you custom behavior.
Setting MaxConnectionsPerHost
The HTTP Component has a org.apache.commons.httpclient.HttpConnectionManager
...
where
...
you
...
can
...
configure
...
various
...
global
...
configuration
...
for
...
the
...
given
...
component.
...
By
...
global,
...
we
...
mean
...
that
...
any
...
endpoint
...
the
...
component
...
creates
...
has
...
the
...
same
...
shared
...
HttpConnectionManager
...
.
...
So,
...
if
...
we
...
want
...
to
...
set
...
a
...
different
...
value
...
for
...
the
...
max
...
connection
...
per
...
host,
...
we
...
need
...
to
...
define
...
it
...
on
...
the
...
HTTP
...
component
...
and
...
not
...
on
...
the
...
endpoint
...
URI
...
that
...
we
...
usually
...
use.
...
So
...
here
...
comes:
...
First,
...
we
...
define
...
the
...
http
...
component
...
in
...
Spring
...
XML.
...
Yes,
...
we
...
use
...
the
...
same
...
scheme
...
name,
...
http
...
,
...
because
...
otherwise
...
Camel
...
will
...
auto-discover
...
and
...
create
...
the
...
component
...
with
...
default
...
settings.
...
What
...
we
...
need
...
is
...
to
...
overrule
...
this
...
so
...
we
...
can
...
set
...
our
...
options.
...
In
...
the
...
sample
...
below
...
we
...
set
...
the
...
max
...
connection
...
to
...
5
...
instead
...
of
...
the
...
default
...
of
...
2.
...
...
And
...
then
...
we
...
can
...
just
...
use
...
it
...
as
...
we
...
normally
...
do
...
in
...
our
...
routes:
...
...
Using Pre-Emptive Authentication
If an HTTP server should fail to respond correctly with an expected 401 Authorization Required
response for a failed authentication attempt a client can instead use preemptive authentication by specifying the URI option: httpClient.authenticationPreemptive=true
.
Accepting Self-Signed Certificates From Remote Server
See this link from a mailing list discussion with some code to outline how to do this with the Apache Commons HTTP API.
Setting up SSL for HTTP Client
Using the JSSE Configuration Utility
From Camel 2.8: the HTTP4
component supports SSL/TLS configuration through the Camel JSSE Configuration Utility. This utility greatly decreases the amount of component specific code you need to write and is configurable at the endpoint and component levels. The following examples demonstrate how to use the utility with the HTTP4
component.
The version of the Apache HTTP client used in this component resolves SSL/TLS information from a global "protocol" registry. This component provides an implementation, org.apache.camel.component.http.SSLContextParametersSecureProtocolSocketFactory
...
,
...
of
...
the
...
HTTP
...
client's
...
protocol
...
socket
...
factory
...
in
...
order
...
to
...
support
...
the
...
use
...
of
...
the
...
Camel
...
JSSE
...
Configuration
...
utility.
...
The
...
following
...
example
...
demonstrates
...
how
...
to
...
configure
...
the
...
protocol
...
registry
...
and
...
use
...
the
...
registered
...
protocol
...
information
...
in
...
a
...
route.
...
...
Configuring Apache HTTP Client Directly
Basically camel-http
...
component
...
is
...
built
...
on
...
the
...
top
...
of
...
Apache
...
HTTP
...
client,
...
and
...
you
...
can
...
implement
...
a
...
custom
...
org.apache.camel.component.http.HttpClientConfigurer
...
to
...
do
...
some
...
configuration
...
on
...
the
...
HTTP client
...
if
...
you
...
need
...
full
...
control
...
of
...
it.
...
However
...
, if
...
you
...
just
...
want
...
to
...
specify
...
the keystore
and truststore
you can do this with Apache HTTP HttpClientConfigurer
, for example:
...
And then you need to create a class that implements HttpClientConfigurer
, and registers HTTPS protocol providing a keystore
or truststore
per example above. Then, from your Camel RouteBuilder class you can hook it up like so:
...
If you are doing this using the Spring DSL, you can specify your HttpClientConfigurer
using the URI. For example:
...
As long as you implement the HttpClientConfigurer
and configure your keystore
and truststore
as described above, it will work fine.