public abstract class HttpCommonEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.cloud.DiscoverableService
Constructor and Description |
---|
HttpCommonEndpoint() |
HttpCommonEndpoint(String endPointURI,
HttpCommonComponent component,
URI httpURI) |
Modifier and Type | Method and Description |
---|---|
boolean |
canConnect(HttpConsumer consumer) |
void |
connect(HttpConsumer consumer) |
void |
disconnect(HttpConsumer consumer) |
String |
getAuthDomain() |
String |
getAuthHost() |
String |
getAuthMethod() |
String |
getAuthMethodPriority() |
String |
getAuthPassword() |
String |
getAuthUsername() |
HttpBinding |
getBinding()
Deprecated.
use
getHttpBinding() |
HttpCommonComponent |
getComponent() |
CookieHandler |
getCookieHandler() |
org.apache.camel.spi.HeaderFilterStrategy |
getHeaderFilterStrategy() |
HttpBinding |
getHttpBinding() |
HttpMethods |
getHttpMethod() |
String |
getHttpMethodRestrict() |
URI |
getHttpUri() |
String |
getOkStatusCodeRange() |
String |
getPath() |
int |
getPort() |
String |
getProtocol() |
String |
getProxyAuthDomain() |
String |
getProxyAuthHost() |
String |
getProxyAuthMethod() |
String |
getProxyAuthPassword() |
int |
getProxyAuthPort() |
String |
getProxyAuthScheme() |
String |
getProxyAuthUsername() |
String |
getProxyHost() |
int |
getProxyPort() |
Integer |
getResponseBufferSize() |
Map<String,String> |
getServiceProperties() |
boolean |
isAsync() |
boolean |
isBridgeEndpoint() |
boolean |
isChunked() |
boolean |
isConnectionClose() |
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 |
isMapHttpMessageBody() |
boolean |
isMapHttpMessageFormUrlEncodedBody() |
boolean |
isMapHttpMessageHeaders() |
boolean |
isMatchOnUriPrefix() |
boolean |
isOptionsEnabled() |
boolean |
isPreserveHostHeader() |
boolean |
isThrowExceptionOnFailure() |
boolean |
isTraceEnabled() |
boolean |
isTransferException() |
void |
setAsync(boolean async)
If this option is true, the consumer will work in async mode
|
void |
setAuthDomain(String authDomain)
Authentication domain to use with NTML
|
void |
setAuthHost(String authHost)
Authentication host to use with NTML
|
void |
setAuthMethod(String authMethod)
Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM.
|
void |
setAuthMethodPriority(String authMethodPriority)
Which authentication method to prioritize to use, either as Basic, Digest or NTLM.
|
void |
setAuthPassword(String authPassword)
Authentication password
|
void |
setAuthUsername(String authUsername)
Authentication username
|
void |
setBinding(HttpBinding httpBinding)
Deprecated.
|
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 Servlet will disable the HTTP streaming and set the content-length header on the response
|
void |
setConnectionClose(boolean connectionClose)
If this option is true, the producer will add a Connection Close header to HTTP Request
|
void |
setCookieHandler(CookieHandler cookieHandler)
Configure a cookie handler to maintain a HTTP session
|
void |
setCopyHeaders(boolean copyHeaders) |
void |
setDisableStreamCache(boolean disable)
Determines whether or not the raw input stream from Servlet 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 |
setHttpBinding(HttpBinding httpBinding)
To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
|
void |
setHttpMethod(HttpMethods httpMethod)
Configure the HTTP method to use.
|
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 |
setMapHttpMessageBody(boolean mapHttpMessageBody)
If this option is true, the IN exchange body will be mapped to HTTP
|
void |
setMapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody)
If this option is true then IN exchange Form Encoded body will be mapped to HTTP
|
void |
setMapHttpMessageHeaders(boolean mapHttpMessageHeaders)
If this option is true, the IN exchange headers will be mapped to HTTP Headers
|
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 are considered a success response.
|
void |
setOptionsEnabled(boolean optionsEnabled)
Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
|
void |
setPreserveHostHeader(boolean preserveHostHeader)
If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header,
useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client,
this allows applications which use the Host header to generate accurate URL's for a proxied service
|
void |
setProxyAuthDomain(String proxyAuthDomain)
Proxy authentication domain to use with NTML
|
void |
setProxyAuthHost(String proxyAuthHost)
Proxy authentication host to use with NTML
|
void |
setProxyAuthMethod(String proxyAuthMethod)
Proxy authentication method to use
|
void |
setProxyAuthPassword(String proxyAuthPassword)
Proxy authentication password
|
void |
setProxyAuthPort(int proxyAuthPort)
Proxy authentication port
|
void |
setProxyAuthScheme(String proxyAuthScheme)
Proxy authentication scheme to use
|
void |
setProxyAuthUsername(String proxyAuthUsername)
Proxy authentication username
|
void |
setProxyHost(String proxyHost)
Proxy hostname to use
|
void |
setProxyPort(int proxyPort)
Proxy port to use
|
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 Servlet consumer.
|
void |
setTransferException(boolean transferException)
If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized
in the response as a application/x-java-serialized-object content type.
|
configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString
doResume, doShutdown, doSuspend, getStatus, init, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend
public HttpCommonEndpoint()
public HttpCommonEndpoint(String endPointURI, HttpCommonComponent component, URI httpURI) throws URISyntaxException
URISyntaxException
public void connect(HttpConsumer consumer) throws Exception
Exception
public void disconnect(HttpConsumer consumer) throws Exception
Exception
public boolean canConnect(HttpConsumer consumer) throws Exception
Exception
public HttpCommonComponent getComponent()
getComponent
in class org.apache.camel.support.DefaultEndpoint
public boolean isLenientProperties()
isLenientProperties
in interface org.apache.camel.Endpoint
isLenientProperties
in class org.apache.camel.support.DefaultEndpoint
public Map<String,String> getServiceProperties()
getServiceProperties
in interface org.apache.camel.cloud.DiscoverableService
@Deprecated public HttpBinding getBinding()
getHttpBinding()
@Deprecated public void setBinding(HttpBinding httpBinding)
setHttpBinding(HttpBinding)
public HttpBinding getHttpBinding()
public void setHttpBinding(HttpBinding httpBinding)
public String getPath()
public int getPort()
public String getProtocol()
public URI getHttpUri()
public void setHttpUri(URI httpUri)
public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()
getHeaderFilterStrategy
in interface org.apache.camel.spi.HeaderFilterStrategyAware
public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
setHeaderFilterStrategy
in interface org.apache.camel.spi.HeaderFilterStrategyAware
public boolean isThrowExceptionOnFailure()
public void setThrowExceptionOnFailure(boolean throwExceptionOnFailure)
public boolean isBridgeEndpoint()
public void setBridgeEndpoint(boolean bridge)
public boolean isPreserveHostHeader()
public void setPreserveHostHeader(boolean preserveHostHeader)
public boolean isMatchOnUriPrefix()
public void setMatchOnUriPrefix(boolean match)
public boolean isDisableStreamCache()
public void setDisableStreamCache(boolean disable)
public boolean isChunked()
public void setChunked(boolean chunked)
public boolean isTransferException()
public boolean isConnectionClose()
public void setConnectionClose(boolean connectionClose)
public void setTransferException(boolean transferException)
public boolean isTraceEnabled()
public void setTraceEnabled(boolean traceEnabled)
public boolean isOptionsEnabled()
public void setOptionsEnabled(boolean optionsEnabled)
public String getHttpMethodRestrict()
public void setHttpMethodRestrict(String httpMethodRestrict)
public Integer getResponseBufferSize()
public void setResponseBufferSize(Integer responseBufferSize)
public boolean isIgnoreResponseBody()
public void setIgnoreResponseBody(boolean ignoreResponseBody)
public boolean isCopyHeaders()
public void setCopyHeaders(boolean copyHeaders)
public boolean isEagerCheckContentAvailable()
public void setEagerCheckContentAvailable(boolean eagerCheckContentAvailable)
public String getOkStatusCodeRange()
public void setOkStatusCodeRange(String okStatusCodeRange)
public boolean isMapHttpMessageBody()
public void setMapHttpMessageBody(boolean mapHttpMessageBody)
public boolean isMapHttpMessageHeaders()
public void setMapHttpMessageHeaders(boolean mapHttpMessageHeaders)
public boolean isMapHttpMessageFormUrlEncodedBody()
public void setMapHttpMessageFormUrlEncodedBody(boolean mapHttpMessageFormUrlEncodedBody)
public boolean isAsync()
public void setAsync(boolean async)
public CookieHandler getCookieHandler()
public void setCookieHandler(CookieHandler cookieHandler)
public HttpMethods getHttpMethod()
public void setHttpMethod(HttpMethods httpMethod)
public String getAuthMethod()
public void setAuthMethod(String authMethod)
public String getAuthMethodPriority()
public void setAuthMethodPriority(String authMethodPriority)
public String getAuthUsername()
public void setAuthUsername(String authUsername)
public String getAuthPassword()
public void setAuthPassword(String authPassword)
public String getAuthDomain()
public void setAuthDomain(String authDomain)
public String getAuthHost()
public void setAuthHost(String authHost)
public String getProxyAuthScheme()
public void setProxyAuthScheme(String proxyAuthScheme)
public String getProxyAuthMethod()
public void setProxyAuthMethod(String proxyAuthMethod)
public String getProxyAuthUsername()
public void setProxyAuthUsername(String proxyAuthUsername)
public String getProxyAuthPassword()
public void setProxyAuthPassword(String proxyAuthPassword)
public String getProxyAuthDomain()
public void setProxyAuthDomain(String proxyAuthDomain)
public String getProxyAuthHost()
public void setProxyAuthHost(String proxyAuthHost)
public int getProxyAuthPort()
public void setProxyAuthPort(int proxyAuthPort)
public String getProxyHost()
public void setProxyHost(String proxyHost)
public int getProxyPort()
public void setProxyPort(int proxyPort)
Apache Camel