You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/08/16 08:03:42 UTC
[18/51] [partial] camel git commit: CAMEL-9541: Use -component as
suffix for component docs.
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-hipchat/src/main/docs/hipchat-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hipchat/src/main/docs/hipchat-component.adoc b/components/camel-hipchat/src/main/docs/hipchat-component.adoc
new file mode 100644
index 0000000..d7eabbe
--- /dev/null
+++ b/components/camel-hipchat/src/main/docs/hipchat-component.adoc
@@ -0,0 +1,204 @@
+[[Hipchat-HipchatComponent]]
+Hipchat Component
+~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.15.0*
+
+The Hipchat component supports producing and consuming messages from/to
+https://www.hipchat.com[Hipchat]�service.
+
+*Prerequisites*
+
+You must have a valid Hipchat user account and get a
+https://www.hipchat.com/account/api[personal access token] that you can
+use to produce/consume messages.
+
+
+[[Hipchat-URIFormat]]
+URI Format
+^^^^^^^^^^
+
+[source,java]
+-------------------------------
+hipchat://[host][:port]?options
+-------------------------------
+
+You can append query options to the URI in the following format,
+?options=value&option2=value&...
+
+[[Hipchat-URIOptions]]
+URI Options
+^^^^^^^^^^^
+
+
+// component options: START
+The Hipchat component has no options.
+// component options: END
+
+
+
+
+
+
+// endpoint options: START
+The Hipchat component supports 24 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| protocol | common | | String | *Required* The protocol for the hipchat server such as http.
+| host | common | | String | *Required* The host for the hipchat server such as api.hipchat.com
+| port | common | 80 | Integer | The port for the hipchat server. Is by default 80.
+| authToken | common | | String | OAuth 2 auth token
+| consumeUsers | common | | String | Username(s) when consuming messages from the hiptchat server. Multiple user names can be separated by comma.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
+| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
+| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
+| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
+| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
+| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
+| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
+| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
+| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
+| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
+| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+
+
+
+
+[[Hipchat-ScheduledPollConsumer]]
+Scheduled Poll Consumer
+^^^^^^^^^^^^^^^^^^^^^^^
+
+This component implements the
+link:polling-consumer.html[ScheduledPollConsumer]. Only the last message
+from the provided 'consumeUsers' are retrieved and sent as Exchange
+body. If you do not want the same message to be retrieved again when
+there are no new messages on next poll then you can add the
+link:idempotent-consumer.html[idempotent consumer] as shown below. All
+the options on the�link:polling-consumer.html[ScheduledPollConsumer]�can
+also be used for more control on the consumer.
+
+[source,java]
+---------------------------------------------------------------------------------
+@Override
+public void configure() throws Exception {
+ String hipchatEndpointUri = "hipchat://?authToken=XXXX&consumeUsers=@Joe,@John";
+ from(hipchatEndpointUri)
+ .idempotentConsumer(
+ simple("${in.header.HipchatMessageDate} ${in.header.HipchatFromUser}"),
+ MemoryIdempotentRepository.memoryIdempotentRepository(200)
+ )
+ .to("mock:result");
+}
+---------------------------------------------------------------------------------
+
+[[Hipchat-MessageheaderssetbytheHipchatconsumer]]
+Message headers set by the Hipchat consumer
++++++++++++++++++++++++++++++++++++++++++++
+
+[width="100%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+
+|*Header* |*Constant* |*Type* |*Description*
+
+|HipchatFromUser |HipchatConstants.FROM_USER |_String_ |The body has the message that was sent from this user to the owner of
+authToken
+
+|HipchatMessageDate |HipchatConstants.MESSAGE_DATE |_String_ |The date message was sent. The format is ISO-8601 as present in the
+Hipchat https://www.hipchat.com/docs/apiv2/method/view_recent_privatechat_history[response].
+
+|HipchatFromUserResponseStatus |HipchatConstants.FROM_USER_RESPONSE_STATUS� |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_
+The status of the API response received.
+|=======================================================================
+
+[[Hipchat-HipchatProducer]]
+Hipchat Producer
+^^^^^^^^^^^^^^^^
+
+Producer can send messages to both Room's and User's simultaneously. The
+body of the exchange is sent as message. Sample usage is shown below.
+Appropriate headers needs to be set.
+
+[source,java]
+----------------------------------------------------------
+@Override
+ public void configure() throws Exception {
+ String hipchatEndpointUri = "hipchat://?authToken=XXXX";
+ from("direct:start")
+ .to(hipchatEndpointUri)
+ .to("mock:result");
+ }
+----------------------------------------------------------
+
+[[Hipchat-MessageheadersevaluatedbytheHipchatproducer]]
+Message headers evaluated by the Hipchat producer
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+[width="100%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+
+|*Header* |*Constant* |*Type* |*Description*
+
+|HipchatToUser |HipchatConstants.TO_USER |_String_ |The Hipchat user to which the message needs to be sent.
+
+|HipchatToRoom |HipchatConstants.TO_ROOM |_String_ |The Hipchat room to which the message needs to be sent.
+
+|HipchatMessageFormat |HipchatConstants.MESSAGE_FORMAT |String |Valid formats are 'text' or 'html'. *Default: 'text'*
+
+|HipchatMessageBackgroundColor |HipchatConstants.MESSAGE_BACKGROUND_COLOR |_String_ |Valid color values are 'yellow', 'green', 'red', 'purple', 'gray',
+'random'. *Default: 'yellow' (Room Only)*�
+
+|HipchatTriggerNotification |HipchatConstants.TRIGGER_NOTIFY |_String_ |Valid values are 'true' or 'false'. Whether this message should trigger
+a user notification (change the tab color, play a sound, notify mobile
+phones, etc). *Default: 'false' (Room Only)*
+|=======================================================================
+
+[[Hipchat-MessageheaderssetbytheHipchatproducer]]
+Message headers set by the Hipchat producer
++++++++++++++++++++++++++++++++++++++++++++
+
+[width="100%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+
+|*Header* |*Constant* |*Type* |*Description*
+
+|HipchatToUserResponseStatus |HipchatConstants.TO_USER_RESPONSE_STATUS |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_
+The status of the API response received when message sent to the user.
+
+|HipchatFromUserResponseStatus |HipchatConstants.TO_ROOM_RESPONSE_STATUS |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_ |The status of the API response received when message sent to the room.
+|=======================================================================
+
+[[Hipchat-Dependencies]]
+Dependencies
+++++++++++++
+
+Maven users will need to add the following dependency to their pom.xml.
+
+*pom.xml*
+
+[source,xml]
+------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-hipchat</artifactId>
+ <version>${camel-version}</version>
+</dependency>
+------------------------------------------
+
+where�`${camel-version}` must be replaced by the actual version of Camel
+(2.15.0 or higher)
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-hipchat/src/main/docs/hipchat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hipchat/src/main/docs/hipchat.adoc b/components/camel-hipchat/src/main/docs/hipchat.adoc
deleted file mode 100644
index d7eabbe..0000000
--- a/components/camel-hipchat/src/main/docs/hipchat.adoc
+++ /dev/null
@@ -1,204 +0,0 @@
-[[Hipchat-HipchatComponent]]
-Hipchat Component
-~~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.15.0*
-
-The Hipchat component supports producing and consuming messages from/to
-https://www.hipchat.com[Hipchat]�service.
-
-*Prerequisites*
-
-You must have a valid Hipchat user account and get a
-https://www.hipchat.com/account/api[personal access token] that you can
-use to produce/consume messages.
-
-
-[[Hipchat-URIFormat]]
-URI Format
-^^^^^^^^^^
-
-[source,java]
--------------------------------
-hipchat://[host][:port]?options
--------------------------------
-
-You can append query options to the URI in the following format,
-?options=value&option2=value&...
-
-[[Hipchat-URIOptions]]
-URI Options
-^^^^^^^^^^^
-
-
-// component options: START
-The Hipchat component has no options.
-// component options: END
-
-
-
-
-
-
-// endpoint options: START
-The Hipchat component supports 24 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| protocol | common | | String | *Required* The protocol for the hipchat server such as http.
-| host | common | | String | *Required* The host for the hipchat server such as api.hipchat.com
-| port | common | 80 | Integer | The port for the hipchat server. Is by default 80.
-| authToken | common | | String | OAuth 2 auth token
-| consumeUsers | common | | String | Username(s) when consuming messages from the hiptchat server. Multiple user names can be separated by comma.
-| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
-| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
-| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
-|=======================================================================
-{% endraw %}
-// endpoint options: END
-
-
-
-
-
-
-[[Hipchat-ScheduledPollConsumer]]
-Scheduled Poll Consumer
-^^^^^^^^^^^^^^^^^^^^^^^
-
-This component implements the
-link:polling-consumer.html[ScheduledPollConsumer]. Only the last message
-from the provided 'consumeUsers' are retrieved and sent as Exchange
-body. If you do not want the same message to be retrieved again when
-there are no new messages on next poll then you can add the
-link:idempotent-consumer.html[idempotent consumer] as shown below. All
-the options on the�link:polling-consumer.html[ScheduledPollConsumer]�can
-also be used for more control on the consumer.
-
-[source,java]
----------------------------------------------------------------------------------
-@Override
-public void configure() throws Exception {
- String hipchatEndpointUri = "hipchat://?authToken=XXXX&consumeUsers=@Joe,@John";
- from(hipchatEndpointUri)
- .idempotentConsumer(
- simple("${in.header.HipchatMessageDate} ${in.header.HipchatFromUser}"),
- MemoryIdempotentRepository.memoryIdempotentRepository(200)
- )
- .to("mock:result");
-}
----------------------------------------------------------------------------------
-
-[[Hipchat-MessageheaderssetbytheHipchatconsumer]]
-Message headers set by the Hipchat consumer
-+++++++++++++++++++++++++++++++++++++++++++
-
-[width="100%",cols="10%,10%,10%,70%",options="header",]
-|=======================================================================
-
-|*Header* |*Constant* |*Type* |*Description*
-
-|HipchatFromUser |HipchatConstants.FROM_USER |_String_ |The body has the message that was sent from this user to the owner of
-authToken
-
-|HipchatMessageDate |HipchatConstants.MESSAGE_DATE |_String_ |The date message was sent. The format is ISO-8601 as present in the
-Hipchat https://www.hipchat.com/docs/apiv2/method/view_recent_privatechat_history[response].
-
-|HipchatFromUserResponseStatus |HipchatConstants.FROM_USER_RESPONSE_STATUS� |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_
-The status of the API response received.
-|=======================================================================
-
-[[Hipchat-HipchatProducer]]
-Hipchat Producer
-^^^^^^^^^^^^^^^^
-
-Producer can send messages to both Room's and User's simultaneously. The
-body of the exchange is sent as message. Sample usage is shown below.
-Appropriate headers needs to be set.
-
-[source,java]
-----------------------------------------------------------
-@Override
- public void configure() throws Exception {
- String hipchatEndpointUri = "hipchat://?authToken=XXXX";
- from("direct:start")
- .to(hipchatEndpointUri)
- .to("mock:result");
- }
-----------------------------------------------------------
-
-[[Hipchat-MessageheadersevaluatedbytheHipchatproducer]]
-Message headers evaluated by the Hipchat producer
-+++++++++++++++++++++++++++++++++++++++++++++++++
-
-[width="100%",cols="10%,10%,10%,70%",options="header",]
-|=======================================================================
-
-|*Header* |*Constant* |*Type* |*Description*
-
-|HipchatToUser |HipchatConstants.TO_USER |_String_ |The Hipchat user to which the message needs to be sent.
-
-|HipchatToRoom |HipchatConstants.TO_ROOM |_String_ |The Hipchat room to which the message needs to be sent.
-
-|HipchatMessageFormat |HipchatConstants.MESSAGE_FORMAT |String |Valid formats are 'text' or 'html'. *Default: 'text'*
-
-|HipchatMessageBackgroundColor |HipchatConstants.MESSAGE_BACKGROUND_COLOR |_String_ |Valid color values are 'yellow', 'green', 'red', 'purple', 'gray',
-'random'. *Default: 'yellow' (Room Only)*�
-
-|HipchatTriggerNotification |HipchatConstants.TRIGGER_NOTIFY |_String_ |Valid values are 'true' or 'false'. Whether this message should trigger
-a user notification (change the tab color, play a sound, notify mobile
-phones, etc). *Default: 'false' (Room Only)*
-|=======================================================================
-
-[[Hipchat-MessageheaderssetbytheHipchatproducer]]
-Message headers set by the Hipchat producer
-+++++++++++++++++++++++++++++++++++++++++++
-
-[width="100%",cols="10%,10%,10%,70%",options="header",]
-|=======================================================================
-
-|*Header* |*Constant* |*Type* |*Description*
-
-|HipchatToUserResponseStatus |HipchatConstants.TO_USER_RESPONSE_STATUS |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_
-The status of the API response received when message sent to the user.
-
-|HipchatFromUserResponseStatus |HipchatConstants.TO_ROOM_RESPONSE_STATUS |_http://hc.apache.org/httpcomponents-core-4.2.x/httpcore/apidocs/org/apache/http/StatusLine.html[StatusLine]_ |The status of the API response received when message sent to the room.
-|=======================================================================
-
-[[Hipchat-Dependencies]]
-Dependencies
-++++++++++++
-
-Maven users will need to add the following dependency to their pom.xml.
-
-*pom.xml*
-
-[source,xml]
-------------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-hipchat</artifactId>
- <version>${camel-version}</version>
-</dependency>
-------------------------------------------
-
-where�`${camel-version}` must be replaced by the actual version of Camel
-(2.15.0 or higher)
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-http/src/main/docs/http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc
new file mode 100644
index 0000000..4022639
--- /dev/null
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -0,0 +1,572 @@
+[[HTTP-HTTPComponent]]
+HTTP Component
+~~~~~~~~~~~~~~
+
+The *http:* component provides HTTP based link:endpoint.html[endpoints]
+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:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-http</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[HTTP-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------------------------------------------------------------
+http:hostname[:port][/resourceUri][?param1=value1][¶m2=value2]
+------------------------------------------------------------------
+
+Will by default use port 80 for HTTP and 443 for HTTPS.
+
+*camel-http vs camel-jetty*
+
+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 link:jetty.html[Jetty Component] or the
+link:servlet.html[Servlet Component]
+
+
+[[HTTP-Examples]]
+Examples
+^^^^^^^^
+
+Call the url with the body using POST and return response as out
+message. If body is null call URL using GET and return response as out
+message
+
+Java DSL
+
+Spring DSL
+
+[source,java]
+------------------------------
+from("direct:start")
+ .to("http://myhost/mypath");
+------------------------------
+
+[source,xml]
+--------------------------
+<from uri="direct:start"/>
+<to uri="http://oldhost"/>
+--------------------------
+
+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
+
+[source,java]
+-----------------------------------------------------------------------------------
+from("direct:start")
+ .setHeader(Exchange.HTTP_URI, simple("http://myserver/orders/${header.orderId}"))
+ .to("http://dummyhost");
+-----------------------------------------------------------------------------------
+
+URI parameters can either be set directly on the endpoint URI or as a
+header
+
+Java DSL
+
+[source,java]
+---------------------------------------------------------------------
+from("direct:start")
+ .to("http://oldhost?order=123&detail=short");
+from("direct:start")
+ .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short"))
+ .to("http://oldhost");
+---------------------------------------------------------------------
+
+Set the HTTP request method to POST
+
+Java DSL
+
+Spring DSL
+
+[source,java]
+----------------------------------------------------
+from("direct:start")
+ .setHeader(Exchange.HTTP_METHOD, constant("POST"))
+ .to("http://www.google.com");
+----------------------------------------------------
+
+[source,xml]
+----------------------------------------
+<from uri="direct:start"/>
+<setHeader headerName="CamelHttpMethod">
+ <constant>POST</constant>
+</setHeader>
+<to uri="http://www.google.com"/>
+<to uri="mock:results"/>
+----------------------------------------
+
+[[HTTP-HttpOptions]]
+Http Options
+^^^^^^^^^^^^
+
+
+
+// component options: START
+The HTTP component supports 6 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| httpClientConfigurer | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
+| httpConnectionManager | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
+| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. 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.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+
+
+
+
+
+// endpoint options: START
+The HTTP component supports 26 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| httpUri | producer | | URI | *Required* The url of the HTTP endpoint to call.
+| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet 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 Servlet 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 http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca
che the response body stream but use the response stream as-is as the message body.
+| authMethodPriority | producer | | String | Authentication method for proxy either as Basic Digest or NTLM.
+| bridgeEndpoint | producer | false | boolean | 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.
+| chunked | producer | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
+| connectionClose | producer | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
+| copyHeaders | producer | true | boolean | 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).
+| headerFilterStrategy | producer | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| httpBinding | producer | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| ignoreResponseBody | producer | false | boolean | If this option is true The http producer won't read response body and cache the input stream
+| okStatusCodeRange | producer | 200-299 | String | 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.
+| preserveHostHeader | producer | false | boolean | 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
+| proxyHost | producer | | String | The proxy host name
+| proxyPort | producer | | int | The proxy port number
+| throwExceptionOnFailure | producer | true | boolean | 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.
+| transferException | producer | false | boolean | 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. 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. This is by default turned off. 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.
+| urlRewrite | producer (advanced) | | UrlRewrite | Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| httpClientConfigurer | advanced | | HttpClientConfigurer | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
+| httpClientOptions | advanced | | Map | To configure the HttpClient using the key/values from the Map.
+| httpConnectionManager | advanced | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
+| httpConnectionManagerOptions | advanced | | Map | To configure the HttpConnectionManager using the key/values from the Map.
+| mapHttpMessageBody | advanced | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.
+| mapHttpMessageFormUrlEncodedBody | advanced | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.
+| mapHttpMessageHeaders | advanced | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+
+
+
+
+[[HTTP-MessageHeaders]]
+Message Headers
+^^^^^^^^^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Type |Description
+
+|`Exchange.HTTP_URI` |`String` |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.
+
+|`Exchange.HTTP_METHOD` |`String` |HTTP Method / Verb to use (GET/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)
+
+|`Exchange.HTTP_PATH` |`String` |Request URI's path, the header will be used to build the request URI
+with the HTTP_URI. *Camel 2.3.0:* If the path is start with "/", http
+producer will try to find the relative path based on the
+Exchange.HTTP_BASE_URI header or the
+exchange.getFromEndpoint().getEndpointUri();
+
+|`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`.
+
+|`Exchange.HTTP_SERVLET_REQUEST` |`HttpServletRequest` |The `HttpServletRequest` object.
+
+|`Exchange.HTTP_SERVLET_RESPONSE` |`HttpServletResponse` |The `HttpServletResponse` object.
+
+|`Exchange.HTTP_PROTOCOL_VERSION` |`String` |*Camel 2.5:* You can set the http protocol version with this header, eg.
+"HTTP/1.0". If you didn't specify the header, HttpProducer will use the
+default value "HTTP/1.1"
+|=======================================================================
+
+The header name above are constants. For the spring DSL you have to use
+the value of the constant instead of the name.
+
+[[HTTP-MessageBody]]
+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.
+
+[[HTTP-Responsecode]]
+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 `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.
+
+
+[[HTTP-HttpOperationFailedException]]
+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
+
+[[HTTP-CallingusingGETorPOST]]
+Calling using GET or POST
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following algorithm is used to determine if either `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.
+
+[[HTTP-HowtogetaccesstoHttpServletRequestandHttpServletResponse]]
+How to get access to HttpServletRequest and HttpServletResponse
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can get access to these two using the Camel type converter system
+using
+
+[source,java]
+----------------------------------------------------------------------------------
+HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class);
+HttpServletRequest response = exchange.getIn().getBody(HttpServletResponse.class);
+----------------------------------------------------------------------------------
+
+[[HTTP-Usingclienttimeout-SO_TIMEOUT]]
+Using client timeout - SO_TIMEOUT
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+See the unit test in
+http://svn.apache.org/viewvc?view=rev&revision=781775[this link]
+
+[[HTTP-MoreExamples]]
+More Examples
+~~~~~~~~~~~~~
+
+[[HTTP-ConfiguringaProxy]]
+Configuring a Proxy
+^^^^^^^^^^^^^^^^^^^
+
+Java DSL
+
+[source,java]
+---------------------------------------------------------------
+from("direct:start")
+ .to("http://oldhost?proxyHost=www.myproxy.com&proxyPort=80");
+---------------------------------------------------------------
+
+There is also support for proxy authentication via the `proxyUsername`
+and `proxyPassword` options.
+
+[[HTTP-UsingproxysettingsoutsideofURI]]
+Using proxy settings outside of URI
++++++++++++++++++++++++++++++++++++
+
+Java DSL
+
+Spring DSL
+
+[source,java]
+---------------------------------------------------------------
+ context.getProperties().put("http.proxyHost", "172.168.18.9");
+ context.getProperties().put("http.proxyPort" "8080");
+---------------------------------------------------------------
+
+[source,java]
+----------------------------------------------------------------
+ <camelContext>
+ <properties>
+ <property key="http.proxyHost" value="172.168.18.9"/>
+ <property key="http.proxyPort" value="8080"/>
+ </properties>
+ </camelContext>
+----------------------------------------------------------------
+
+Options on Endpoint will override options on the context.
+
+[[HTTP-Configuringcharset]]
+Configuring charset
+^^^^^^^^^^^^^^^^^^^
+
+If you are using `POST` to send data you can configure the `charset`
+
+[source,java]
+-------------------------------------------------
+setProperty(Exchange.CHARSET_NAME, "iso-8859-1");
+-------------------------------------------------
+
+[[HTTP-Samplewithscheduledpoll]]
+Sample with scheduled poll
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The sample polls the Google homepage every 10 seconds and write the page
+to the file `message.html`:
+
+[source,java]
+----------------------------------------------------------------------------------------
+from("timer://foo?fixedRate=true&delay=0&period=10000")
+ .to("http://www.google.com")
+ .setHeader(FileComponent.HEADER_FILE_NAME, "message.html").to("file:target/google");
+----------------------------------------------------------------------------------------
+
+[[HTTP-GettingtheResponseCode]]
+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`.
+
+[source,java]
+----------------------------------------------------------------------------------------------
+ Exchange exchange = template.send("http://www.google.com/search", new Processor() {
+ public void process(Exchange exchange) throws Exception {
+ exchange.getIn().setHeader(Exchange.HTTP_QUERY, constant("hl=en&q=activemq"));
+ }
+ });
+ Message out = exchange.getOut();
+ int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class);
+----------------------------------------------------------------------------------------------
+
+[[HTTP-UsingthrowExceptionOnFailure=falsetogetanyresponseback]]
+Using `throwExceptionOnFailure=false` to get any response back
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the route below we want to route a message that we
+link:content-enricher.html[enrich] with data returned from a remote HTTP
+call. As we want any response from the remote server, we set the
+`throwExceptionOnFailure` option to `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.
+
+[[HTTP-DisablingCookies]]
+Disabling Cookies
+^^^^^^^^^^^^^^^^^
+
+To disable cookies you can set the HTTP Client to ignore cookies by
+adding this URI option: +
+ `httpClient.cookiePolicy=ignoreCookies`
+
+[[HTTP-AdvancedUsage]]
+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.
+
+[[HTTP-SettingMaxConnectionsPerHost]]
+Setting MaxConnectionsPerHost
++++++++++++++++++++++++++++++
+
+The link:http.html[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:
+
+[[HTTP-Usingpreemptiveauthentication]]
+Using preemptive authentication
++++++++++++++++++++++++++++++++
+
+An end user reported that he had problem with authenticating with HTTPS.
+The problem was eventually resolved when he discovered the HTTPS server
+did not return a HTTP code 401 Authorization Required. The solution was
+to set the following URI option:
+`httpClient.authenticationPreemptive=true`
+
+[[HTTP-Acceptingselfsignedcertificatesfromremoteserver]]
+Accepting self signed certificates from remote server
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+See this
+http://www.nabble.com/Using-HTTPS-in-camel-http-when-remote-side-has-self-signed-cert-td25916878.html[link]
+from a mailing list discussion with some code to outline how to do this
+with the Apache Commons HTTP API.
+
+[[HTTP-SettingupSSLforHTTPClient]]
+Setting up SSL for HTTP Client
+++++++++++++++++++++++++++++++
+
+[[HTTP-UsingtheJSSEConfigurationUtility]]
+Using the JSSE Configuration Utility
+
+As of Camel 2.8, the HTTP4 component supports SSL/TLS configuration
+through the link:camel-configuration-utilities.html[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.
+
+[source,java]
+----------------------------------------------------------------
+KeyStoreParameters ksp = new KeyStoreParameters();
+ksp.setResource("/users/home/server/keystore.jks");
+ksp.setPassword("keystorePassword");
+
+KeyManagersParameters kmp = new KeyManagersParameters();
+kmp.setKeyStore(ksp);
+kmp.setKeyPassword("keyPassword");
+
+SSLContextParameters scp = new SSLContextParameters();
+scp.setKeyManagers(kmp);
+
+ProtocolSocketFactory factory =
+ new SSLContextParametersSecureProtocolSocketFactory(scp);
+
+Protocol.registerProtocol("https",
+ new Protocol(
+������� "https",
+������� factory,
+������� 443));
+
+from("direct:start")
+ .to("https://mail.google.com/mail/").to("mock:results");
+----------------------------------------------------------------
+
+[[HTTP-ConfiguringApacheHTTPClientDirectly]]
+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:
+
+[source,java]
+----------------------------------------------------------------------------
+Protocol authhttps = new Protocol("https", new AuthSSLProtocolSocketFactory(
+ new URL("file:my.keystore"), "mypassword",
+ new URL("file:my.truststore"), "mypassword"), 443);
+
+Protocol.registerProtocol("https", authhttps);
+----------------------------------------------------------------------------
+
+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 route
+builder class you can hook it up like so:
+
+[source,java]
+-------------------------------------------------------------------------------------
+HttpComponent httpComponent = getContext().getComponent("http", HttpComponent.class);
+httpComponent.setHttpClientConfigurer(new MyHttpClientConfigurer());
+-------------------------------------------------------------------------------------
+
+If you are doing this using the Spring DSL, you can specify your
+`HttpClientConfigurer` using the URI. For example:
+
+[source,java]
+-------------------------------------------------------------------------------------------
+<bean id="myHttpClientConfigurer"
+ class="my.https.HttpClientConfigurer">
+</bean>
+
+<to uri="https://myhostname.com:443/myURL?httpClientConfigurerRef=myHttpClientConfigurer"/>
+-------------------------------------------------------------------------------------------
+
+As long as you implement the HttpClientConfigurer and configure your
+keystore and truststore as described above, it will work fine.
+
+[[HTTP-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
+* link:jetty.html[Jetty]
+
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-http/src/main/docs/http.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http/src/main/docs/http.adoc b/components/camel-http/src/main/docs/http.adoc
deleted file mode 100644
index 4022639..0000000
--- a/components/camel-http/src/main/docs/http.adoc
+++ /dev/null
@@ -1,572 +0,0 @@
-[[HTTP-HTTPComponent]]
-HTTP Component
-~~~~~~~~~~~~~~
-
-The *http:* component provides HTTP based link:endpoint.html[endpoints]
-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:
-
-[source,xml]
-------------------------------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-http</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[HTTP-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
-------------------------------------------------------------------
-http:hostname[:port][/resourceUri][?param1=value1][¶m2=value2]
-------------------------------------------------------------------
-
-Will by default use port 80 for HTTP and 443 for HTTPS.
-
-*camel-http vs camel-jetty*
-
-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 link:jetty.html[Jetty Component] or the
-link:servlet.html[Servlet Component]
-
-
-[[HTTP-Examples]]
-Examples
-^^^^^^^^
-
-Call the url with the body using POST and return response as out
-message. If body is null call URL using GET and return response as out
-message
-
-Java DSL
-
-Spring DSL
-
-[source,java]
-------------------------------
-from("direct:start")
- .to("http://myhost/mypath");
-------------------------------
-
-[source,xml]
---------------------------
-<from uri="direct:start"/>
-<to uri="http://oldhost"/>
---------------------------
-
-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
-
-[source,java]
------------------------------------------------------------------------------------
-from("direct:start")
- .setHeader(Exchange.HTTP_URI, simple("http://myserver/orders/${header.orderId}"))
- .to("http://dummyhost");
------------------------------------------------------------------------------------
-
-URI parameters can either be set directly on the endpoint URI or as a
-header
-
-Java DSL
-
-[source,java]
----------------------------------------------------------------------
-from("direct:start")
- .to("http://oldhost?order=123&detail=short");
-from("direct:start")
- .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short"))
- .to("http://oldhost");
----------------------------------------------------------------------
-
-Set the HTTP request method to POST
-
-Java DSL
-
-Spring DSL
-
-[source,java]
-----------------------------------------------------
-from("direct:start")
- .setHeader(Exchange.HTTP_METHOD, constant("POST"))
- .to("http://www.google.com");
-----------------------------------------------------
-
-[source,xml]
-----------------------------------------
-<from uri="direct:start"/>
-<setHeader headerName="CamelHttpMethod">
- <constant>POST</constant>
-</setHeader>
-<to uri="http://www.google.com"/>
-<to uri="mock:results"/>
-----------------------------------------
-
-[[HTTP-HttpOptions]]
-Http Options
-^^^^^^^^^^^^
-
-
-
-// component options: START
-The HTTP component supports 6 options which are listed below.
-
-
-
-{% raw %}
-[width="100%",cols="2s,1m,8",options="header"]
-|=======================================================================
-| Name | Java Type | Description
-| httpClientConfigurer | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
-| httpConnectionManager | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. 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.
-| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-|=======================================================================
-{% endraw %}
-// component options: END
-
-
-
-
-
-
-
-
-// endpoint options: START
-The HTTP component supports 26 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| httpUri | producer | | URI | *Required* The url of the HTTP endpoint to call.
-| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet 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 Servlet 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 http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca
che the response body stream but use the response stream as-is as the message body.
-| authMethodPriority | producer | | String | Authentication method for proxy either as Basic Digest or NTLM.
-| bridgeEndpoint | producer | false | boolean | 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.
-| chunked | producer | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-| connectionClose | producer | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
-| copyHeaders | producer | true | boolean | 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).
-| headerFilterStrategy | producer | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-| httpBinding | producer | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-| ignoreResponseBody | producer | false | boolean | If this option is true The http producer won't read response body and cache the input stream
-| okStatusCodeRange | producer | 200-299 | String | 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.
-| preserveHostHeader | producer | false | boolean | 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
-| proxyHost | producer | | String | The proxy host name
-| proxyPort | producer | | int | The proxy port number
-| throwExceptionOnFailure | producer | true | boolean | 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.
-| transferException | producer | false | boolean | 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. 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. This is by default turned off. 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.
-| urlRewrite | producer (advanced) | | UrlRewrite | Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html
-| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
-| httpClientConfigurer | advanced | | HttpClientConfigurer | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
-| httpClientOptions | advanced | | Map | To configure the HttpClient using the key/values from the Map.
-| httpConnectionManager | advanced | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-| httpConnectionManagerOptions | advanced | | Map | To configure the HttpConnectionManager using the key/values from the Map.
-| mapHttpMessageBody | advanced | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.
-| mapHttpMessageFormUrlEncodedBody | advanced | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.
-| mapHttpMessageHeaders | advanced | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.
-| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-|=======================================================================
-{% endraw %}
-// endpoint options: END
-
-
-
-
-
-
-[[HTTP-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Type |Description
-
-|`Exchange.HTTP_URI` |`String` |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.
-
-|`Exchange.HTTP_METHOD` |`String` |HTTP Method / Verb to use (GET/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)
-
-|`Exchange.HTTP_PATH` |`String` |Request URI's path, the header will be used to build the request URI
-with the HTTP_URI. *Camel 2.3.0:* If the path is start with "/", http
-producer will try to find the relative path based on the
-Exchange.HTTP_BASE_URI header or the
-exchange.getFromEndpoint().getEndpointUri();
-
-|`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`.
-
-|`Exchange.HTTP_SERVLET_REQUEST` |`HttpServletRequest` |The `HttpServletRequest` object.
-
-|`Exchange.HTTP_SERVLET_RESPONSE` |`HttpServletResponse` |The `HttpServletResponse` object.
-
-|`Exchange.HTTP_PROTOCOL_VERSION` |`String` |*Camel 2.5:* You can set the http protocol version with this header, eg.
-"HTTP/1.0". If you didn't specify the header, HttpProducer will use the
-default value "HTTP/1.1"
-|=======================================================================
-
-The header name above are constants. For the spring DSL you have to use
-the value of the constant instead of the name.
-
-[[HTTP-MessageBody]]
-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.
-
-[[HTTP-Responsecode]]
-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 `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.
-
-
-[[HTTP-HttpOperationFailedException]]
-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
-
-[[HTTP-CallingusingGETorPOST]]
-Calling using GET or POST
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The following algorithm is used to determine if either `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.
-
-[[HTTP-HowtogetaccesstoHttpServletRequestandHttpServletResponse]]
-How to get access to HttpServletRequest and HttpServletResponse
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can get access to these two using the Camel type converter system
-using
-
-[source,java]
-----------------------------------------------------------------------------------
-HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class);
-HttpServletRequest response = exchange.getIn().getBody(HttpServletResponse.class);
-----------------------------------------------------------------------------------
-
-[[HTTP-Usingclienttimeout-SO_TIMEOUT]]
-Using client timeout - SO_TIMEOUT
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-See the unit test in
-http://svn.apache.org/viewvc?view=rev&revision=781775[this link]
-
-[[HTTP-MoreExamples]]
-More Examples
-~~~~~~~~~~~~~
-
-[[HTTP-ConfiguringaProxy]]
-Configuring a Proxy
-^^^^^^^^^^^^^^^^^^^
-
-Java DSL
-
-[source,java]
----------------------------------------------------------------
-from("direct:start")
- .to("http://oldhost?proxyHost=www.myproxy.com&proxyPort=80");
----------------------------------------------------------------
-
-There is also support for proxy authentication via the `proxyUsername`
-and `proxyPassword` options.
-
-[[HTTP-UsingproxysettingsoutsideofURI]]
-Using proxy settings outside of URI
-+++++++++++++++++++++++++++++++++++
-
-Java DSL
-
-Spring DSL
-
-[source,java]
----------------------------------------------------------------
- context.getProperties().put("http.proxyHost", "172.168.18.9");
- context.getProperties().put("http.proxyPort" "8080");
----------------------------------------------------------------
-
-[source,java]
-----------------------------------------------------------------
- <camelContext>
- <properties>
- <property key="http.proxyHost" value="172.168.18.9"/>
- <property key="http.proxyPort" value="8080"/>
- </properties>
- </camelContext>
-----------------------------------------------------------------
-
-Options on Endpoint will override options on the context.
-
-[[HTTP-Configuringcharset]]
-Configuring charset
-^^^^^^^^^^^^^^^^^^^
-
-If you are using `POST` to send data you can configure the `charset`
-
-[source,java]
--------------------------------------------------
-setProperty(Exchange.CHARSET_NAME, "iso-8859-1");
--------------------------------------------------
-
-[[HTTP-Samplewithscheduledpoll]]
-Sample with scheduled poll
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The sample polls the Google homepage every 10 seconds and write the page
-to the file `message.html`:
-
-[source,java]
-----------------------------------------------------------------------------------------
-from("timer://foo?fixedRate=true&delay=0&period=10000")
- .to("http://www.google.com")
- .setHeader(FileComponent.HEADER_FILE_NAME, "message.html").to("file:target/google");
-----------------------------------------------------------------------------------------
-
-[[HTTP-GettingtheResponseCode]]
-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`.
-
-[source,java]
-----------------------------------------------------------------------------------------------
- Exchange exchange = template.send("http://www.google.com/search", new Processor() {
- public void process(Exchange exchange) throws Exception {
- exchange.getIn().setHeader(Exchange.HTTP_QUERY, constant("hl=en&q=activemq"));
- }
- });
- Message out = exchange.getOut();
- int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class);
-----------------------------------------------------------------------------------------------
-
-[[HTTP-UsingthrowExceptionOnFailure=falsetogetanyresponseback]]
-Using `throwExceptionOnFailure=false` to get any response back
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In the route below we want to route a message that we
-link:content-enricher.html[enrich] with data returned from a remote HTTP
-call. As we want any response from the remote server, we set the
-`throwExceptionOnFailure` option to `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.
-
-[[HTTP-DisablingCookies]]
-Disabling Cookies
-^^^^^^^^^^^^^^^^^
-
-To disable cookies you can set the HTTP Client to ignore cookies by
-adding this URI option: +
- `httpClient.cookiePolicy=ignoreCookies`
-
-[[HTTP-AdvancedUsage]]
-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.
-
-[[HTTP-SettingMaxConnectionsPerHost]]
-Setting MaxConnectionsPerHost
-+++++++++++++++++++++++++++++
-
-The link:http.html[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:
-
-[[HTTP-Usingpreemptiveauthentication]]
-Using preemptive authentication
-+++++++++++++++++++++++++++++++
-
-An end user reported that he had problem with authenticating with HTTPS.
-The problem was eventually resolved when he discovered the HTTPS server
-did not return a HTTP code 401 Authorization Required. The solution was
-to set the following URI option:
-`httpClient.authenticationPreemptive=true`
-
-[[HTTP-Acceptingselfsignedcertificatesfromremoteserver]]
-Accepting self signed certificates from remote server
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-See this
-http://www.nabble.com/Using-HTTPS-in-camel-http-when-remote-side-has-self-signed-cert-td25916878.html[link]
-from a mailing list discussion with some code to outline how to do this
-with the Apache Commons HTTP API.
-
-[[HTTP-SettingupSSLforHTTPClient]]
-Setting up SSL for HTTP Client
-++++++++++++++++++++++++++++++
-
-[[HTTP-UsingtheJSSEConfigurationUtility]]
-Using the JSSE Configuration Utility
-
-As of Camel 2.8, the HTTP4 component supports SSL/TLS configuration
-through the link:camel-configuration-utilities.html[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.
-
-[source,java]
-----------------------------------------------------------------
-KeyStoreParameters ksp = new KeyStoreParameters();
-ksp.setResource("/users/home/server/keystore.jks");
-ksp.setPassword("keystorePassword");
-
-KeyManagersParameters kmp = new KeyManagersParameters();
-kmp.setKeyStore(ksp);
-kmp.setKeyPassword("keyPassword");
-
-SSLContextParameters scp = new SSLContextParameters();
-scp.setKeyManagers(kmp);
-
-ProtocolSocketFactory factory =
- new SSLContextParametersSecureProtocolSocketFactory(scp);
-
-Protocol.registerProtocol("https",
- new Protocol(
-������� "https",
-������� factory,
-������� 443));
-
-from("direct:start")
- .to("https://mail.google.com/mail/").to("mock:results");
-----------------------------------------------------------------
-
-[[HTTP-ConfiguringApacheHTTPClientDirectly]]
-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:
-
-[source,java]
-----------------------------------------------------------------------------
-Protocol authhttps = new Protocol("https", new AuthSSLProtocolSocketFactory(
- new URL("file:my.keystore"), "mypassword",
- new URL("file:my.truststore"), "mypassword"), 443);
-
-Protocol.registerProtocol("https", authhttps);
-----------------------------------------------------------------------------
-
-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 route
-builder class you can hook it up like so:
-
-[source,java]
--------------------------------------------------------------------------------------
-HttpComponent httpComponent = getContext().getComponent("http", HttpComponent.class);
-httpComponent.setHttpClientConfigurer(new MyHttpClientConfigurer());
--------------------------------------------------------------------------------------
-
-If you are doing this using the Spring DSL, you can specify your
-`HttpClientConfigurer` using the URI. For example:
-
-[source,java]
--------------------------------------------------------------------------------------------
-<bean id="myHttpClientConfigurer"
- class="my.https.HttpClientConfigurer">
-</bean>
-
-<to uri="https://myhostname.com:443/myURL?httpClientConfigurerRef=myHttpClientConfigurer"/>
--------------------------------------------------------------------------------------------
-
-As long as you implement the HttpClientConfigurer and configure your
-keystore and truststore as described above, it will work fine.
-
-[[HTTP-SeeAlso]]
-See Also
-^^^^^^^^
-
-* link:configuring-camel.html[Configuring Camel]
-* link:component.html[Component]
-* link:endpoint.html[Endpoint]
-* link:getting-started.html[Getting Started]
-
-* link:jetty.html[Jetty]
-