org.apache.camel.http.common

Class HttpCommonEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.http.common.HttpCommonEndpoint

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 abstract class HttpCommonEndpoint
extends org.apache.camel.impl.DefaultEndpoint
implements org.apache.camel.spi.HeaderFilterStrategyAware

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
HttpCommonEndpoint()
HttpCommonEndpoint(String endPointURI, HttpCommonComponent component, URI httpURI)

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(HttpConsumer consumer)
void	disconnect(HttpConsumer consumer)
String	getAuthMethodPriority()
HttpBinding	getBinding()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
String	getHttpMethodRestrict()
URI	getHttpUri()
String	getOkStatusCodeRange()
String	getPath()
int	getPort()
String	getProtocol()
String	getProxyHost()
int	getProxyPort()
Integer	getResponseBufferSize()
UrlRewrite	getUrlRewrite()
boolean	isBridgeEndpoint()
boolean	isChunked()
boolean	isCopyHeaders() If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy.
boolean	isDisableStreamCache()
boolean	isEagerCheckContentAvailable()
boolean	isIgnoreResponseBody()
boolean	isLenientProperties()
boolean	isMatchOnUriPrefix()
boolean	isSingleton()
boolean	isThrowExceptionOnFailure()
boolean	isTraceEnabled()
boolean	isTransferException()
void	setAuthMethodPriority(String authMethodPriority) Authentication method for proxy, either as Basic, Digest or NTLM.
void	setBinding(HttpBinding binding) To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
void	setBridgeEndpoint(boolean bridge) If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request.
void	setChunked(boolean chunked) If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response
void	setCopyHeaders(boolean copyHeaders)
void	setDisableStreamCache(boolean disable) Determines whether or not the raw input stream from Jetty is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache.
void	setEagerCheckContentAvailable(boolean eagerCheckContentAvailable) Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present.
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
void	setHttpMethodRestrict(String httpMethodRestrict) Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.
void	setHttpUri(URI httpUri) The url of the HTTP endpoint to call.
void	setIgnoreResponseBody(boolean ignoreResponseBody) If this option is true, The http producer won't read response body and cache the input stream.
void	setMatchOnUriPrefix(boolean match) Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
void	setOkStatusCodeRange(String okStatusCodeRange) The status codes which is considered a success response.
void	setProxyHost(String proxyHost) The proxy host name
void	setProxyPort(int proxyPort) The proxy port number
void	setResponseBufferSize(Integer responseBufferSize) To use a custom buffer size on the javax.servlet.ServletResponse.
void	setThrowExceptionOnFailure(boolean throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
void	setTraceEnabled(boolean traceEnabled) Specifies whether to enable HTTP TRACE for this Jetty consumer.
void	setTransferException(boolean transferException) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
void	setUrlRewrite(UrlRewrite urlRewrite) Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints.

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, 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.Endpoint

createConsumer, createProducer

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

HttpCommonEndpoint

public HttpCommonEndpoint()

HttpCommonEndpoint

public HttpCommonEndpoint(String endPointURI,
                  HttpCommonComponent component,
                  URI httpURI)
                   throws URISyntaxException

Throws:

URISyntaxException

Method Detail

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

getBinding

public HttpBinding getBinding()

setBinding

public void setBinding(HttpBinding binding)

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

getPath

public String getPath()

getPort

public int getPort()

getProtocol

public String getProtocol()

getHttpUri

public URI getHttpUri()

setHttpUri

public void setHttpUri(URI httpUri)

The url of the HTTP endpoint to call.

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)

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

Specified by:

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

isThrowExceptionOnFailure

public boolean isThrowExceptionOnFailure()

setThrowExceptionOnFailure

public void setThrowExceptionOnFailure(boolean throwExceptionOnFailure)

Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.

isBridgeEndpoint

public boolean isBridgeEndpoint()

setBridgeEndpoint

public void setBridgeEndpoint(boolean bridge)

If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back.

isMatchOnUriPrefix

public boolean isMatchOnUriPrefix()

setMatchOnUriPrefix

public void setMatchOnUriPrefix(boolean match)

Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.

See more details at: http://camel.apache.org/how-do-i-let-jetty-match-wildcards.html

isDisableStreamCache

public boolean isDisableStreamCache()

setDisableStreamCache

public void setDisableStreamCache(boolean disable)

Determines whether or not the raw input stream from Jetty is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Jetty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Jetty to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.

isChunked

public boolean isChunked()

setChunked

public void setChunked(boolean chunked)

If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

The proxy host name

getProxyPort

public int getProxyPort()

setProxyPort

public void setProxyPort(int proxyPort)

The proxy port number

getAuthMethodPriority

public String getAuthMethodPriority()

setAuthMethodPriority

public void setAuthMethodPriority(String authMethodPriority)

Authentication method for proxy, either as Basic, Digest or NTLM.

isTransferException

public boolean isTransferException()

setTransferException

public void setTransferException(boolean transferException)

Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.

isTraceEnabled

public boolean isTraceEnabled()

setTraceEnabled

public void setTraceEnabled(boolean traceEnabled)

Specifies whether to enable HTTP TRACE for this Jetty consumer. By default TRACE is turned off.

getHttpMethodRestrict

public String getHttpMethodRestrict()

setHttpMethodRestrict

public void setHttpMethodRestrict(String httpMethodRestrict)

Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.

getUrlRewrite

public UrlRewrite getUrlRewrite()

setUrlRewrite

public void setUrlRewrite(UrlRewrite urlRewrite)

Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html

getResponseBufferSize

public Integer getResponseBufferSize()

setResponseBufferSize

public void setResponseBufferSize(Integer responseBufferSize)

To use a custom buffer size on the javax.servlet.ServletResponse.

isIgnoreResponseBody

public boolean isIgnoreResponseBody()

setIgnoreResponseBody

public void setIgnoreResponseBody(boolean ignoreResponseBody)

If this option is true, The http producer won't read response body and cache the input stream.

isCopyHeaders

public boolean isCopyHeaders()

If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers).

setCopyHeaders

public void setCopyHeaders(boolean copyHeaders)

isEagerCheckContentAvailable

public boolean isEagerCheckContentAvailable()

setEagerCheckContentAvailable

public void setEagerCheckContentAvailable(boolean eagerCheckContentAvailable)

Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data.

getOkStatusCodeRange

public String getOkStatusCodeRange()

setOkStatusCodeRange

public void setOkStatusCodeRange(String okStatusCodeRange)

The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.

The default range is 200-299