org.apache.camel.component.http
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.http.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

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

void	connect(HttpConsumer consumer)
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()
void	disconnect(HttpConsumer consumer)
String	getAuthMethodPriority()
HttpBinding	getBinding()
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.
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
HttpClientConfigurer	getHttpClientConfigurer()
org.apache.commons.httpclient.HttpConnectionManager	getHttpConnectionManager()
String	getHttpMethodRestrict()
URI	getHttpUri()
String	getPath()
int	getPort()
String	getProtocol()
String	getProxyHost()
int	getProxyPort()
Integer	getResponseBufferSize()
UrlRewrite	getUrlRewrite()
boolean	isBridgeEndpoint()
boolean	isChunked()
boolean	isDisableStreamCache()
boolean	isLenientProperties()
boolean	isMatchOnUriPrefix()
boolean	isSingleton()
boolean	isThrowExceptionOnFailure()
boolean	isTraceEnabled()
boolean	isTransferException()
void	setAuthMethodPriority(String authMethodPriority)
void	setBinding(HttpBinding binding)
void	setBridgeEndpoint(boolean bridge)
void	setChunked(boolean chunked)
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	setDisableStreamCache(boolean disable)
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
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	setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)
void	setHttpMethodRestrict(String httpMethodRestrict)
void	setHttpUri(URI httpUri)
void	setMatchOnUriPrefix(boolean match)
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setResponseBufferSize(Integer responseBufferSize)
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, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, hashCode, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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.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

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

createHttpClient

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

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

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

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

getBinding

public HttpBinding getBinding()

setBinding

public void setBinding(HttpBinding binding)

getPath

public String getPath()

getPort

public int getPort()

getProtocol

public String getProtocol()

getHttpUri

public URI getHttpUri()

setHttpUri

public void setHttpUri(URI httpUri)

getHttpConnectionManager

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

setHttpConnectionManager

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

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)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

getProxyPort

public int getProxyPort()

setProxyPort

public void setProxyPort(int proxyPort)

getAuthMethodPriority

public String getAuthMethodPriority()

setAuthMethodPriority

public void setAuthMethodPriority(String authMethodPriority)

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)

getResponseBufferSize

public Integer getResponseBufferSize()

setResponseBufferSize

public void setResponseBufferSize(Integer responseBufferSize)