org.apache.camel.component.http4

Class HttpEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

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

public class HttpEndpoint
extends org.apache.camel.impl.DefaultPollingEndpoint
implements org.apache.camel.spi.HeaderFilterStrategyAware

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
void	connect(HttpConsumer consumer)
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()
void	disconnect(HttpConsumer consumer)
protected void	doStop()
HttpBinding	getBinding()
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()
org.apache.http.client.CookieStore	getCookieStore()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
org.apache.http.client.HttpClient	getHttpClient() Gets the HttpClient to be used by HttpProducer
HttpClientConfigurer	getHttpClientConfigurer()
org.apache.http.protocol.HttpContext	getHttpContext()
String	getHttpMethodRestrict()
URI	getHttpUri()
String	getPath()
int	getPort()
String	getProtocol()
UrlRewrite	getUrlRewrite()
boolean	isAuthenticationPreemptive()
boolean	isBridgeEndpoint()
boolean	isChunked()
boolean	isClearExpiredCookies()
boolean	isDisableStreamCache()
boolean	isLenientProperties()
boolean	isMatchOnUriPrefix()
boolean	isSingleton()
boolean	isThrowExceptionOnFailure()
boolean	isTraceEnabled()
boolean	isTransferException()
void	setAuthenticationPreemptive(boolean authenticationPreemptive)
void	setBinding(HttpBinding binding)
void	setBridgeEndpoint(boolean bridge)
void	setChunked(boolean chunked)
void	setClearExpiredCookies(boolean clearExpiredCookies)
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)
void	setCookieStore(org.apache.http.client.CookieStore cookieStore)
void	setDisableStreamCache(boolean disable)
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
void	setHttpBinding(HttpBinding binding)
void	setHttpBindingRef(HttpBinding binding)
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)
void	setHttpMethodRestrict(String httpMethodRestrict)
void	setHttpUri(URI httpUri)
void	setMatchOnUriPrefix(boolean match)
void	setThrowExceptionOnFailure(boolean throwExceptionOnFailure)
void	setTraceEnabled(boolean traceEnabled)
void	setTransferException(boolean transferException)
void	setUrlRewrite(UrlRewrite urlRewrite)

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

createConsumer

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties

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

configureConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, doStart, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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

Specified by:

createProducer in interface org.apache.camel.Endpoint

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.

connect

public void connect(HttpConsumer consumer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(HttpConsumer consumer)
                throws Exception

Throws:

Exception

isLenientProperties

public boolean isLenientProperties()

Specified by:

isLenientProperties in interface org.apache.camel.Endpoint

Overrides:

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

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

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

Parameters:

httpClientConfigurer - the strategy for configuring new HttpClient instances

getBinding

public HttpBinding getBinding()

setBinding

public void setBinding(HttpBinding binding)

setHttpBinding

public void setHttpBinding(HttpBinding binding)

setHttpBindingRef

public void setHttpBindingRef(HttpBinding binding)

setHttpContext

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

getPath

public String getPath()

getPort

public int getPort()

getProtocol

public String getProtocol()

getHttpUri

public URI getHttpUri()

setHttpUri

public void setHttpUri(URI httpUri)

getClientConnectionManager

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

setClientConnectionManager

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

getHeaderFilterStrategy

public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

Specified by:

getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

setHeaderFilterStrategy

public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

Specified by:

setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

isThrowExceptionOnFailure

public boolean isThrowExceptionOnFailure()

setThrowExceptionOnFailure

public void setThrowExceptionOnFailure(boolean throwExceptionOnFailure)

isBridgeEndpoint

public boolean isBridgeEndpoint()

setBridgeEndpoint

public void setBridgeEndpoint(boolean bridge)

isMatchOnUriPrefix

public boolean isMatchOnUriPrefix()

setMatchOnUriPrefix

public void setMatchOnUriPrefix(boolean match)

isDisableStreamCache

public boolean isDisableStreamCache()

setDisableStreamCache

public void setDisableStreamCache(boolean disable)

isChunked

public boolean isChunked()

setChunked

public void setChunked(boolean chunked)

isTransferException

public boolean isTransferException()

setTransferException

public void setTransferException(boolean transferException)

isTraceEnabled

public boolean isTraceEnabled()

setTraceEnabled

public void setTraceEnabled(boolean traceEnabled)

getHttpMethodRestrict

public String getHttpMethodRestrict()

setHttpMethodRestrict

public void setHttpMethodRestrict(String httpMethodRestrict)

getUrlRewrite

public UrlRewrite getUrlRewrite()

setUrlRewrite

public void setUrlRewrite(UrlRewrite urlRewrite)

isClearExpiredCookies

public boolean isClearExpiredCookies()

setClearExpiredCookies

public void setClearExpiredCookies(boolean clearExpiredCookies)

getCookieStore

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

setCookieStore

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

isAuthenticationPreemptive

public boolean isAuthenticationPreemptive()

setAuthenticationPreemptive

public void setAuthenticationPreemptive(boolean authenticationPreemptive)