docs/modules/ROOT/pages/http-starter.adoc - camel-spring-boot - Git at Google

 // spring-boot-auto-configure options: START
 :page-partial:
 :doctitle: Camel Spring Boot Starter for http

 == Spring Boot Auto-Configuration

 When using http with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

 [source,xml]
 ----
 <dependency>
   <groupId>org.apache.camel.springboot</groupId>
   <artifactId>camel-http-starter</artifactId>
   <version>x.x.x</version>
   <!-- use the same version as your Camel core version -->
 </dependency>
 ----


 The component supports 27 options, which are listed below.


 [width="100%",cols="2,5,^1,2",options="header"]
 |===
 | Name | Description | Default | Type
 | *camel.component.http.allow-java-serialized-object* | 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. | false | Boolean
 | *camel.component.http.autowired-enabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean
 | *camel.component.http.client-connection-manager* | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. The option is a org.apache.http.conn.HttpClientConnectionManager type. |  | HttpClientConnectionManager
 | *camel.component.http.connect-timeout* | Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | Integer
 | *camel.component.http.connection-request-timeout* | The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | Integer
 | *camel.component.http.connection-time-to-live* | The time for connection to live, the time unit is millisecond, the default value is always keep alive. |  | Long
 | *camel.component.http.connections-per-route* | The maximum number of connections per route. | 20 | Integer
 | *camel.component.http.cookie-store* | 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 cookie shouldn't be stored as we are just bridging (eg acting as a proxy). The option is a org.apache.http.client.CookieStore type. |  | CookieStore
 | *camel.component.http.enabled* | Whether to enable auto configuration of the http component. This is enabled by default. |  | Boolean
 | *camel.component.http.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type. |  | HeaderFilterStrategy
 | *camel.component.http.http-binding* | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a org.apache.camel.http.common.HttpBinding type. |  | HttpBinding
 | *camel.component.http.http-client-configurer* | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. The option is a org.apache.camel.component.http.HttpClientConfigurer type. |  | HttpClientConfigurer
 | *camel.component.http.http-configuration* | To use the shared HttpConfiguration as base configuration. The option is a org.apache.camel.http.common.HttpConfiguration type. |  | HttpConfiguration
 | *camel.component.http.http-context* | To use a custom org.apache.http.protocol.HttpContext when executing requests. The option is a org.apache.http.protocol.HttpContext type. |  | HttpContext
 | *camel.component.http.lazy-start-producer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean
 | *camel.component.http.max-total-connections* | The maximum number of connections. | 200 | Integer
 | *camel.component.http.proxy-auth-domain* | Proxy authentication domain to use |  | String
 | *camel.component.http.proxy-auth-host* | Proxy authentication host |  | String
 | *camel.component.http.proxy-auth-method* | Proxy authentication method to use |  | String
 | *camel.component.http.proxy-auth-nt-host* | Proxy authentication domain (workstation name) to use with NTML |  | String
 | *camel.component.http.proxy-auth-password* | Proxy authentication password |  | String
 | *camel.component.http.proxy-auth-port* | Proxy authentication port |  | Integer
 | *camel.component.http.proxy-auth-username* | Proxy authentication username |  | String
 | *camel.component.http.socket-timeout* | Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | -1 | Integer
 | *camel.component.http.ssl-context-parameters* | To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.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. The option is a org.apache.camel.support.jsse.SSLContextParameters type. |  | SSLContextParameters
 | *camel.component.http.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean
 | *camel.component.http.x509-hostname-verifier* | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a javax.net.ssl.HostnameVerifier type. |  | HostnameVerifier
 |===
 // spring-boot-auto-configure options: END
	// spring-boot-auto-configure options: START
	:page-partial:
	:doctitle: Camel Spring Boot Starter for http

	== Spring Boot Auto-Configuration

	When using http with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

	[source,xml]
	----
	<dependency>
	<groupId>org.apache.camel.springboot</groupId>
	<artifactId>camel-http-starter</artifactId>
	<version>x.x.x</version>
	<!-- use the same version as your Camel core version -->
	</dependency>
	----


	The component supports 27 options, which are listed below.



	[width="100%",cols="2,5,^1,2",options="header"]
	\|===
	\| Name \| Description \| Default \| Type
	\| camel.component.http.allow-java-serialized-object \| 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. \| false \| Boolean
	\| camel.component.http.autowired-enabled \| Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. \| true \| Boolean
	\| camel.component.http.client-connection-manager \| To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. The option is a org.apache.http.conn.HttpClientConnectionManager type. \| \| HttpClientConnectionManager
	\| camel.component.http.connect-timeout \| Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). \| -1 \| Integer
	\| camel.component.http.connection-request-timeout \| The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). \| -1 \| Integer
	\| camel.component.http.connection-time-to-live \| The time for connection to live, the time unit is millisecond, the default value is always keep alive. \| \| Long
	\| camel.component.http.connections-per-route \| The maximum number of connections per route. \| 20 \| Integer
	\| camel.component.http.cookie-store \| 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 cookie shouldn't be stored as we are just bridging (eg acting as a proxy). The option is a org.apache.http.client.CookieStore type. \| \| CookieStore
	\| camel.component.http.enabled \| Whether to enable auto configuration of the http component. This is enabled by default. \| \| Boolean
	\| camel.component.http.header-filter-strategy \| To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type. \| \| HeaderFilterStrategy
	\| camel.component.http.http-binding \| To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a org.apache.camel.http.common.HttpBinding type. \| \| HttpBinding
	\| camel.component.http.http-client-configurer \| To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. The option is a org.apache.camel.component.http.HttpClientConfigurer type. \| \| HttpClientConfigurer
	\| camel.component.http.http-configuration \| To use the shared HttpConfiguration as base configuration. The option is a org.apache.camel.http.common.HttpConfiguration type. \| \| HttpConfiguration
	\| camel.component.http.http-context \| To use a custom org.apache.http.protocol.HttpContext when executing requests. The option is a org.apache.http.protocol.HttpContext type. \| \| HttpContext
	\| camel.component.http.lazy-start-producer \| Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. \| false \| Boolean
	\| camel.component.http.max-total-connections \| The maximum number of connections. \| 200 \| Integer
	\| camel.component.http.proxy-auth-domain \| Proxy authentication domain to use \| \| String
	\| camel.component.http.proxy-auth-host \| Proxy authentication host \| \| String
	\| camel.component.http.proxy-auth-method \| Proxy authentication method to use \| \| String
	\| camel.component.http.proxy-auth-nt-host \| Proxy authentication domain (workstation name) to use with NTML \| \| String
	\| camel.component.http.proxy-auth-password \| Proxy authentication password \| \| String
	\| camel.component.http.proxy-auth-port \| Proxy authentication port \| \| Integer
	\| camel.component.http.proxy-auth-username \| Proxy authentication username \| \| String
	\| camel.component.http.socket-timeout \| Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). \| -1 \| Integer
	\| camel.component.http.ssl-context-parameters \| To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.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. The option is a org.apache.camel.support.jsse.SSLContextParameters type. \| \| SSLContextParameters
	\| camel.component.http.use-global-ssl-context-parameters \| Enable usage of global SSL context parameters. \| false \| Boolean
	\| camel.component.http.x509-hostname-verifier \| To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a javax.net.ssl.HostnameVerifier type. \| \| HostnameVerifier
	\|===
	// spring-boot-auto-configure options: END