org.apache.camel.component.http

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.http.HttpEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.cloud.DiscoverableService, 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(firstVersion="1.0.0",
             scheme="http,https",
             title="HTTP,HTTPS",
             syntax="http:httpUri",
             producerOnly=true,
             label="http",
             lenientProperties=true)
public class HttpEndpoint
extends org.apache.camel.http.common.HttpCommonEndpoint

For calling out to external HTTP servers using Apache HTTP Client 3.x.

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.commons.httpclient.params.HttpClientParams clientParams, org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager, HttpClientConfigurer clientConfigurer)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI, org.apache.commons.httpclient.params.HttpClientParams clientParams, org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager, HttpClientConfigurer clientConfigurer)
HttpEndpoint(String endPointURI, HttpComponent component, URI httpURI, org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.commons.httpclient.HttpClient	createHttpClient() Factory method used by producers and consumers to create a new HttpClient instance
org.apache.camel.PollingConsumer	createPollingConsumer()
org.apache.camel.Producer	createProducer()
org.apache.commons.httpclient.params.HttpClientParams	getClientParams() Provide access to the client parameters used on new HttpClient instances used by producers or consumers of this endpoint.
HttpClientConfigurer	getHttpClientConfigurer()
Map<String,Object>	getHttpClientOptions()
org.apache.commons.httpclient.HttpConnectionManager	getHttpConnectionManager()
Map<String,Object>	getHttpConnectionManagerOptions()
void	setClientParams(org.apache.commons.httpclient.params.HttpClientParams clientParams) Provide access to the client parameters used on new HttpClient instances used by producers or consumers of this endpoint.
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	setHttpClientOptions(Map<String,Object> httpClientOptions) To configure the HttpClient using the key/values from the Map.
void	setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager) To use a custom HttpConnectionManager to manage connections
void	setHttpConnectionManagerOptions(Map<String,Object> httpConnectionManagerOptions) To configure the HttpConnectionManager using the key/values from the Map.

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

connect, disconnect, getAuthDomain, getAuthHost, getAuthMethod, getAuthMethodPriority, getAuthPassword, getAuthUsername, getBinding, getComponent, getCookieHandler, getHeaderFilterStrategy, getHttpBinding, getHttpMethod, getHttpMethodRestrict, getHttpUri, getOkStatusCodeRange, getPath, getPort, getProtocol, getProxyAuthDomain, getProxyAuthHost, getProxyAuthMethod, getProxyAuthPassword, getProxyAuthPort, getProxyAuthScheme, getProxyAuthUsername, getProxyHost, getProxyPort, getResponseBufferSize, getServiceProperties, getUrlRewrite, isAsync, isBridgeEndpoint, isChunked, isConnectionClose, isCopyHeaders, isDisableStreamCache, isEagerCheckContentAvailable, isIgnoreResponseBody, isLenientProperties, isMapHttpMessageBody, isMapHttpMessageFormUrlEncodedBody, isMapHttpMessageHeaders, isMatchOnUriPrefix, isOptionsEnabled, isPreserveHostHeader, isSingleton, isThrowExceptionOnFailure, isTraceEnabled, isTransferException, setAsync, setAuthDomain, setAuthHost, setAuthMethod, setAuthMethodPriority, setAuthPassword, setAuthUsername, setBinding, setBridgeEndpoint, setChunked, setConnectionClose, setCookieHandler, setCopyHeaders, setDisableStreamCache, setEagerCheckContentAvailable, setHeaderFilterStrategy, setHttpBinding, setHttpMethod, setHttpMethodRestrict, setHttpUri, setIgnoreResponseBody, setMapHttpMessageBody, setMapHttpMessageFormUrlEncodedBody, setMapHttpMessageHeaders, setMatchOnUriPrefix, setOkStatusCodeRange, setOptionsEnabled, setPreserveHostHeader, setProxyAuthDomain, setProxyAuthHost, setProxyAuthMethod, setProxyAuthPassword, setProxyAuthPort, setProxyAuthScheme, setProxyAuthUsername, 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, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, 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.commons.httpclient.HttpConnectionManager httpConnectionManager)
             throws URISyntaxException

Throws:

URISyntaxException

HttpEndpoint

public HttpEndpoint(String endPointURI,
                    HttpComponent component,
                    org.apache.commons.httpclient.params.HttpClientParams clientParams,
                    org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager,
                    HttpClientConfigurer clientConfigurer)
             throws URISyntaxException

Throws:

URISyntaxException

HttpEndpoint

public HttpEndpoint(String endPointURI,
                    HttpComponent component,
                    URI httpURI,
                    org.apache.commons.httpclient.params.HttpClientParams clientParams,
                    org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager,
                    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

createHttpClient

public org.apache.commons.httpclient.HttpClient createHttpClient()

Factory method used by producers and consumers to create a new HttpClient instance

getClientParams

public org.apache.commons.httpclient.params.HttpClientParams getClientParams()

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

setClientParams

public void setClientParams(org.apache.commons.httpclient.params.HttpClientParams clientParams)

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

getHttpClientConfigurer

public HttpClientConfigurer getHttpClientConfigurer()

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

getHttpConnectionManager

public org.apache.commons.httpclient.HttpConnectionManager getHttpConnectionManager()

setHttpConnectionManager

public void setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)

To use a custom HttpConnectionManager to manage connections

getHttpClientOptions

public Map<String,Object> getHttpClientOptions()

setHttpClientOptions

public void setHttpClientOptions(Map<String,Object> httpClientOptions)

To configure the HttpClient using the key/values from the Map.

getHttpConnectionManagerOptions

public Map<String,Object> getHttpConnectionManagerOptions()

setHttpConnectionManagerOptions

public void setHttpConnectionManagerOptions(Map<String,Object> httpConnectionManagerOptions)

To configure the HttpConnectionManager using the key/values from the Map.