org.apache.camel.builder.endpoint.dsl

Interface HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

HttpEndpointBuilderFactory

public static interface HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Advanced builder for endpoint for the HTTP component.

Method Summary

Modifier and Type	Method and Description
default HttpEndpointBuilderFactory.HttpEndpointBuilder	basic()
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	clientBuilder(Object clientBuilder) Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	clientBuilder(String clientBuilder) Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	clientConnectionManager(Object clientConnectionManager) To use a custom HttpClientConnectionManager to manage connections.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	clientConnectionManager(String clientConnectionManager) To use a custom HttpClientConnectionManager to manage connections.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	connectionsPerRoute(int connectionsPerRoute) The maximum number of connections per route.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	connectionsPerRoute(String connectionsPerRoute) The maximum number of connections per route.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	cookieHandler(Object cookieHandler) Configure a cookie handler to maintain a HTTP session.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	cookieHandler(String cookieHandler) Configure a cookie handler to maintain a HTTP session.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	cookieStore(Object cookieStore) To use a custom CookieStore.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	cookieStore(String cookieStore) To use a custom CookieStore.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	deleteWithBody(boolean deleteWithBody) Whether the HTTP DELETE should include the message body or not.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	deleteWithBody(String deleteWithBody) Whether the HTTP DELETE should include the message body or not.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	getWithBody(boolean getWithBody) Whether the HTTP GET should include the message body or not.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	getWithBody(String getWithBody) Whether the HTTP GET should include the message body or not.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpBinding(Object httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpBinding(String httpBinding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClient(Object httpClient) Sets a custom HttpClient to be used by the producer.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClient(String httpClient) Sets a custom HttpClient to be used by the producer.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClientConfigurer(Object httpClientConfigurer) Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClientConfigurer(String httpClientConfigurer) Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClientOptions(Map values) To configure the HttpClient using the key/values from the Map.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpClientOptions(String key, Object value) To configure the HttpClient using the key/values from the Map.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpContext(Object httpContext) To use a custom HttpContext instance.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	httpContext(String httpContext) To use a custom HttpContext instance.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageBody(boolean mapHttpMessageBody) If this option is true then IN exchange Body of the exchange will be mapped to HTTP body.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageBody(String mapHttpMessageBody) If this option is true then IN exchange Body of the exchange will be mapped to HTTP body.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody) If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageFormUrlEncodedBody(String mapHttpMessageFormUrlEncodedBody) If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageHeaders(boolean mapHttpMessageHeaders) If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	mapHttpMessageHeaders(String mapHttpMessageHeaders) If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	maxTotalConnections(int maxTotalConnections) The maximum number of connections.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	maxTotalConnections(String maxTotalConnections) The maximum number of connections.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	okStatusCodeRange(String okStatusCodeRange) The status codes which are considered a success response.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	useSystemProperties(boolean useSystemProperties) To use System Properties as fallback for configuration.
default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder	useSystemProperties(String useSystemProperties) To use System Properties as fallback for configuration.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default HttpEndpointBuilderFactory.HttpEndpointBuilder basic()

httpBinding

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpBinding(Object httpBinding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a: <code>org.apache.camel.http.common.HttpBinding</code> type. Group: common (advanced)

Parameters:

httpBinding - the value to set

Returns:

the dsl builder

httpBinding

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpBinding(String httpBinding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option will be converted to a <code>org.apache.camel.http.common.HttpBinding</code> type. Group: common (advanced)

Parameters:

httpBinding - the value to set

Returns:

the dsl builder

cookieHandler

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder cookieHandler(Object cookieHandler)

Configure a cookie handler to maintain a HTTP session. The option is a: <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer (advanced)

Parameters:

cookieHandler - the value to set

Returns:

the dsl builder

cookieHandler

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder cookieHandler(String cookieHandler)

Configure a cookie handler to maintain a HTTP session. The option will be converted to a <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer (advanced)

Parameters:

cookieHandler - the value to set

Returns:

the dsl builder

cookieStore

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder cookieStore(Object cookieStore)

To use a custom CookieStore. By default the 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). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. The option is a: <code>org.apache.http.client.CookieStore</code> type. Group: producer (advanced)

Parameters:

cookieStore - the value to set

Returns:

the dsl builder

cookieStore

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder cookieStore(String cookieStore)

To use a custom CookieStore. By default the 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). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. The option will be converted to a <code>org.apache.http.client.CookieStore</code> type. Group: producer (advanced)

Parameters:

cookieStore - the value to set

Returns:

the dsl builder

deleteWithBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder deleteWithBody(boolean deleteWithBody)

Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

deleteWithBody - the value to set

Returns:

the dsl builder

deleteWithBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder deleteWithBody(String deleteWithBody)

Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

deleteWithBody - the value to set

Returns:

the dsl builder

getWithBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder getWithBody(boolean getWithBody)

Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

getWithBody - the value to set

Returns:

the dsl builder

getWithBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder getWithBody(String getWithBody)

Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

getWithBody - the value to set

Returns:

the dsl builder

okStatusCodeRange

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder okStatusCodeRange(String okStatusCodeRange)

The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. The option is a: <code>java.lang.String</code> type. Default: 200-299 Group: producer (advanced)

Parameters:

okStatusCodeRange - the value to set

Returns:

the dsl builder

clientBuilder

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder clientBuilder(Object clientBuilder)

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. The option is a: <code>org.apache.http.impl.client.HttpClientBuilder</code> type. Group: advanced

Parameters:

clientBuilder - the value to set

Returns:

the dsl builder

clientBuilder

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder clientBuilder(String clientBuilder)

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. The option will be converted to a <code>org.apache.http.impl.client.HttpClientBuilder</code> type. Group: advanced

Parameters:

clientBuilder - the value to set

Returns:

the dsl builder

clientConnectionManager

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder clientConnectionManager(Object clientConnectionManager)

To use a custom HttpClientConnectionManager to manage connections. The option is a: <code>org.apache.http.conn.HttpClientConnectionManager</code> type. Group: advanced

Parameters:

clientConnectionManager - the value to set

Returns:

the dsl builder

clientConnectionManager

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder clientConnectionManager(String clientConnectionManager)

To use a custom HttpClientConnectionManager to manage connections. The option will be converted to a <code>org.apache.http.conn.HttpClientConnectionManager</code> type. Group: advanced

Parameters:

clientConnectionManager - the value to set

Returns:

the dsl builder

connectionsPerRoute

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder connectionsPerRoute(int connectionsPerRoute)

The maximum number of connections per route. The option is a: <code>int</code> type. Default: 20 Group: advanced

Parameters:

connectionsPerRoute - the value to set

Returns:

the dsl builder

connectionsPerRoute

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder connectionsPerRoute(String connectionsPerRoute)

The maximum number of connections per route. The option will be converted to a <code>int</code> type. Default: 20 Group: advanced

Parameters:

connectionsPerRoute - the value to set

Returns:

the dsl builder

httpClient

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClient(Object httpClient)

Sets a custom HttpClient to be used by the producer. The option is a: <code>org.apache.http.client.HttpClient</code> type. Group: advanced

Parameters:

httpClient - the value to set

Returns:

the dsl builder

httpClient

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClient(String httpClient)

Sets a custom HttpClient to be used by the producer. The option will be converted to a <code>org.apache.http.client.HttpClient</code> type. Group: advanced

Parameters:

httpClient - the value to set

Returns:

the dsl builder

httpClientConfigurer

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClientConfigurer(Object httpClientConfigurer)

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc. The option is a: <code>org.apache.camel.component.http.HttpClientConfigurer</code> type. Group: advanced

Parameters:

httpClientConfigurer - the value to set

Returns:

the dsl builder

httpClientConfigurer

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClientConfigurer(String httpClientConfigurer)

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc. The option will be converted to a <code>org.apache.camel.component.http.HttpClientConfigurer</code> type. Group: advanced

Parameters:

httpClientConfigurer - the value to set

Returns:

the dsl builder

httpClientOptions

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClientOptions(String key,
                                                                                 Object value)

To configure the HttpClient using the key/values from the Map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the httpClientOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

httpClientOptions

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpClientOptions(Map values)

To configure the HttpClient using the key/values from the Map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the httpClientOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

values - the values

Returns:

the dsl builder

httpContext

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpContext(Object httpContext)

To use a custom HttpContext instance. The option is a: <code>org.apache.http.protocol.HttpContext</code> type. Group: advanced

Parameters:

httpContext - the value to set

Returns:

the dsl builder

httpContext

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder httpContext(String httpContext)

To use a custom HttpContext instance. The option will be converted to a <code>org.apache.http.protocol.HttpContext</code> type. Group: advanced

Parameters:

httpContext - the value to set

Returns:

the dsl builder

mapHttpMessageBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageBody(boolean mapHttpMessageBody)

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. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageBody - the value to set

Returns:

the dsl builder

mapHttpMessageBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageBody(String mapHttpMessageBody)

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. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageBody - the value to set

Returns:

the dsl builder

mapHttpMessageFormUrlEncodedBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody)

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. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageFormUrlEncodedBody - the value to set

Returns:

the dsl builder

mapHttpMessageFormUrlEncodedBody

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageFormUrlEncodedBody(String mapHttpMessageFormUrlEncodedBody)

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. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageFormUrlEncodedBody - the value to set

Returns:

the dsl builder

mapHttpMessageHeaders

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageHeaders(boolean mapHttpMessageHeaders)

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. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageHeaders - the value to set

Returns:

the dsl builder

mapHttpMessageHeaders

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder mapHttpMessageHeaders(String mapHttpMessageHeaders)

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. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapHttpMessageHeaders - the value to set

Returns:

the dsl builder

maxTotalConnections

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder maxTotalConnections(int maxTotalConnections)

The maximum number of connections. The option is a: <code>int</code> type. Default: 200 Group: advanced

Parameters:

maxTotalConnections - the value to set

Returns:

the dsl builder

maxTotalConnections

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder maxTotalConnections(String maxTotalConnections)

The maximum number of connections. The option will be converted to a <code>int</code> type. Default: 200 Group: advanced

Parameters:

maxTotalConnections - the value to set

Returns:

the dsl builder

synchronous

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

useSystemProperties

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder useSystemProperties(boolean useSystemProperties)

To use System Properties as fallback for configuration. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

useSystemProperties - the value to set

Returns:

the dsl builder

useSystemProperties

default HttpEndpointBuilderFactory.AdvancedHttpEndpointBuilder useSystemProperties(String useSystemProperties)

To use System Properties as fallback for configuration. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

useSystemProperties - the value to set

Returns:

the dsl builder