org.apache.camel.component.http4

Class HttpEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.http.common.HttpCommonEndpoint

org.apache.camel.component.http4.HttpEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="http4,http4s",
             title="HTTP4,HTTP4S",
             syntax="http4:httpUri",
             producerOnly=true,
             label="http")
public class HttpEndpoint
extends org.apache.camel.http.common.HttpCommonEndpoint

Represents a HTTP endpoint

Version:

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
HttpEndpoint()
HttpEndpoint(String endPointURI, HttpComponent component, org.apache.http.impl.client.HttpClientBuilder clientBuilder, org.apache.http.conn.HttpClientConnectionManager clientConnectionManager, HttpClientConfigurer clientConfigurer)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI, org.apache.http.impl.client.HttpClientBuilder clientBuilder, org.apache.http.conn.HttpClientConnectionManager clientConnectionManager, HttpClientConfigurer clientConfigurer)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI, org.apache.http.conn.HttpClientConnectionManager clientConnectionManager)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected org.apache.http.client.HttpClient	createHttpClient() Factory method to create a new HttpClient instance Producers and consumers should use the getHttpClient() method instead.
org.apache.camel.PollingConsumer	createPollingConsumer()
org.apache.camel.Producer	createProducer()
protected void	doStop()
org.apache.http.impl.client.HttpClientBuilder	getClientBuilder() Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
org.apache.http.conn.HttpClientConnectionManager	getClientConnectionManager()
HttpComponent	getComponent()
org.apache.http.client.CookieStore	getCookieStore()
org.apache.http.client.HttpClient	getHttpClient() Gets the HttpClient to be used by HttpProducer
HttpClientConfigurer	getHttpClientConfigurer()
org.apache.http.protocol.HttpContext	getHttpContext()
boolean	isAuthenticationPreemptive()
boolean	isClearExpiredCookies()
void	setAuthenticationPreemptive(boolean authenticationPreemptive) If this option is true, camel-http4 sends preemptive basic authentication to the server.
void	setClearExpiredCookies(boolean clearExpiredCookies) Whether to clear expired cookies before sending the HTTP request.
void	setClientBuilder(org.apache.http.impl.client.HttpClientBuilder clientBuilder) Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
void	setClientConnectionManager(org.apache.http.conn.HttpClientConnectionManager clientConnectionManager) To use a custom HttpClientConnectionManager to manage connections
void	setCookieStore(org.apache.http.client.CookieStore cookieStore) To use a custom org.apache.http.client.CookieStore.
void	setHttpClient(org.apache.http.client.HttpClient httpClient)
void	setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer) Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
void	setHttpContext(org.apache.http.protocol.HttpContext httpContext)

Methods inherited from class org.apache.camel.http.common.HttpCommonEndpoint

connect, disconnect, getAuthMethodPriority, getBinding, getHeaderFilterStrategy, getHttpMethodRestrict, getHttpUri, getOkStatusCodeRange, getPath, getPort, getProtocol, getProxyHost, getProxyPort, getResponseBufferSize, getUrlRewrite, isBridgeEndpoint, isChunked, isCopyHeaders, isDisableStreamCache, isEagerCheckContentAvailable, isIgnoreResponseBody, isLenientProperties, isMatchOnUriPrefix, isSingleton, isThrowExceptionOnFailure, isTraceEnabled, isTransferException, setAuthMethodPriority, setBinding, setBridgeEndpoint, setChunked, setCopyHeaders, setDisableStreamCache, setEagerCheckContentAvailable, setHeaderFilterStrategy, setHttpMethodRestrict, setHttpUri, setIgnoreResponseBody, setMatchOnUriPrefix, setOkStatusCodeRange, setProxyHost, setProxyPort, setResponseBufferSize, setThrowExceptionOnFailure, setTraceEnabled, setTransferException, setUrlRewrite

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, doStart, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

HttpEndpoint

public HttpEndpoint()

HttpEndpoint

public HttpEndpoint(String endPointURI,
            HttpComponent component,
            URI httpURI)
             throws URISyntaxException

Throws:

URISyntaxException

HttpEndpoint

public HttpEndpoint(String endPointURI,
            HttpComponent component,
            URI httpURI,
            org.apache.http.conn.HttpClientConnectionManager clientConnectionManager)
             throws URISyntaxException

Throws:

URISyntaxException

HttpEndpoint

public HttpEndpoint(String endPointURI,
            HttpComponent component,
            org.apache.http.impl.client.HttpClientBuilder clientBuilder,
            org.apache.http.conn.HttpClientConnectionManager clientConnectionManager,
            HttpClientConfigurer clientConfigurer)
             throws URISyntaxException

Throws:

URISyntaxException

HttpEndpoint

public HttpEndpoint(String endPointURI,
            HttpComponent component,
            URI httpURI,
            org.apache.http.impl.client.HttpClientBuilder clientBuilder,
            org.apache.http.conn.HttpClientConnectionManager clientConnectionManager,
            HttpClientConfigurer clientConfigurer)
             throws URISyntaxException

Throws:

URISyntaxException

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

createPollingConsumer

public org.apache.camel.PollingConsumer createPollingConsumer()
                                                       throws Exception

Specified by:

createPollingConsumer in interface org.apache.camel.Endpoint

Overrides:

createPollingConsumer in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Gets the HttpClient to be used by HttpProducer

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

createHttpClient

protected org.apache.http.client.HttpClient createHttpClient()

Factory method to create a new HttpClient instance

Producers and consumers should use the getHttpClient() method instead.

getComponent

public HttpComponent getComponent()

Overrides:

getComponent in class org.apache.camel.http.common.HttpCommonEndpoint

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

getClientBuilder

public org.apache.http.impl.client.HttpClientBuilder getClientBuilder()

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.

setClientBuilder

public void setClientBuilder(org.apache.http.impl.client.HttpClientBuilder clientBuilder)

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.

getHttpClientConfigurer

public HttpClientConfigurer getHttpClientConfigurer()

getHttpContext

public org.apache.http.protocol.HttpContext getHttpContext()

setHttpClientConfigurer

public void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer)

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc

setHttpContext

public void setHttpContext(org.apache.http.protocol.HttpContext httpContext)

getClientConnectionManager

public org.apache.http.conn.HttpClientConnectionManager getClientConnectionManager()

setClientConnectionManager

public void setClientConnectionManager(org.apache.http.conn.HttpClientConnectionManager clientConnectionManager)

To use a custom HttpClientConnectionManager to manage connections

isClearExpiredCookies

public boolean isClearExpiredCookies()

setClearExpiredCookies

public void setClearExpiredCookies(boolean clearExpiredCookies)

Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired.

getCookieStore

public org.apache.http.client.CookieStore getCookieStore()

setCookieStore

public void setCookieStore(org.apache.http.client.CookieStore cookieStore)

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).

isAuthenticationPreemptive

public boolean isAuthenticationPreemptive()

setAuthenticationPreemptive

public void setAuthenticationPreemptive(boolean authenticationPreemptive)

If this option is true, camel-http4 sends preemptive basic authentication to the server.