org.apache.camel.component.jetty

Class JettyHttpEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.http.HttpEndpoint

org.apache.camel.component.jetty.JettyHttpEndpoint

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

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
JettyHttpEndpoint(JettyHttpComponent component, String uri, URI httpURL)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
abstract JettyContentExchange	createContentExchange()
protected org.eclipse.jetty.client.HttpClient	createJettyHttpClient()
org.apache.camel.Producer	createProducer()
JettyHttpComponent	getComponent()
Long	getContinuationTimeout()
List<javax.servlet.Filter>	getFilters()
List<org.eclipse.jetty.server.Handler>	getHandlers()
org.eclipse.jetty.client.HttpClient	getHttpClient()
Integer	getHttpClientMaxThreads()
Integer	getHttpClientMinThreads()
Map<String,Object>	getHttpClientParameters()
JettyHttpBinding	getJettyBinding(org.eclipse.jetty.client.HttpClient httpClient)
javax.servlet.Filter	getMultipartFilter()
org.apache.camel.util.jsse.SSLContextParameters	getSslContextParameters()
Boolean	getUseContinuation()
boolean	isEnableJmx()
boolean	isEnableMultipartFilter()
boolean	isSendDateHeader()
boolean	isSendServerVersion()
boolean	isSessionSupport()
void	setContinuationTimeout(Long continuationTimeout) Allows to set a timeout in millis when using Jetty as consumer (server).
void	setEnableJmx(boolean enableJmx) If this option is true, Jetty JMX support will be enabled for this endpoint.
void	setEnableMultipartFilter(boolean enableMultipartFilter) Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not.
void	setFilters(List<javax.servlet.Filter> filterList)
void	setHandlers(List<org.eclipse.jetty.server.Handler> handlers)
void	setHttpClient(org.eclipse.jetty.client.HttpClient httpClient) Sets a shared HttpClient to use for all producers created by this endpoint.
void	setHttpClientMaxThreads(Integer httpClientMaxThreads) To set a value for maximum number of threads in HttpClient thread pool.
void	setHttpClientMinThreads(Integer httpClientMinThreads) To set a value for minimum number of threads in HttpClient thread pool.
void	setHttpClientParameters(Map<String,Object> httpClientParameters) Configuration of Jetty's HttpClient.
void	setJettyBinding(JettyHttpBinding jettyBinding)
void	setMultipartFilter(javax.servlet.Filter filter) Allows using a custom multipart filter.
void	setSendDateHeader(boolean sendDateHeader) If the option is true, jetty server will send the date header to the client which sends the request.
void	setSendServerVersion(boolean sendServerVersion) If the option is true, jetty will send the server header with the jetty version information to the client which sends the request.
void	setSessionSupport(boolean support) Specifies whether to enable the session manager on the server side of Jetty.
void	setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters
void	setUseContinuation(Boolean useContinuation) Whether or not to use Jetty continuations for the Jetty Server.

Methods inherited from class org.apache.camel.component.http.HttpEndpoint

connect, createHttpClient, createPollingConsumer, disconnect, getAuthMethodPriority, getBinding, getClientParams, getHeaderFilterStrategy, getHttpClientConfigurer, getHttpConnectionManager, getHttpMethodRestrict, getHttpUri, getPath, getPort, getProtocol, getProxyHost, getProxyPort, getResponseBufferSize, getUrlRewrite, isBridgeEndpoint, isChunked, isDisableStreamCache, isLenientProperties, isMatchOnUriPrefix, isSingleton, isThrowExceptionOnFailure, isTraceEnabled, isTransferException, setAuthMethodPriority, setBinding, setBridgeEndpoint, setChunked, setClientParams, setDisableStreamCache, setHeaderFilterStrategy, setHttpClientConfigurer, setHttpConnectionManager, setHttpMethodRestrict, setHttpUri, setMatchOnUriPrefix, 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, 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, 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

JettyHttpEndpoint

public JettyHttpEndpoint(JettyHttpComponent component,
                 String uri,
                 URI httpURL)
                  throws URISyntaxException

Throws:

URISyntaxException

Method Detail

getComponent

public JettyHttpComponent getComponent()

Overrides:

getComponent in class org.apache.camel.component.http.HttpEndpoint

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Overrides:

createProducer in class org.apache.camel.component.http.HttpEndpoint

Throws:

Exception

createJettyHttpClient

protected org.eclipse.jetty.client.HttpClient createJettyHttpClient()
                                                             throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Overrides:

createConsumer in class org.apache.camel.component.http.HttpEndpoint

Throws:

Exception

setSessionSupport

public void setSessionSupport(boolean support)

Specifies whether to enable the session manager on the server side of Jetty.

isSessionSupport

public boolean isSessionSupport()

getHandlers

public List<org.eclipse.jetty.server.Handler> getHandlers()

setHandlers

public void setHandlers(List<org.eclipse.jetty.server.Handler> handlers)

getHttpClient

public org.eclipse.jetty.client.HttpClient getHttpClient()
                                                  throws Exception

Throws:

Exception

setHttpClient

public void setHttpClient(org.eclipse.jetty.client.HttpClient httpClient)

Sets a shared HttpClient to use for all producers created by this endpoint. By default each producer will use a new http client, and not share.

Important: Make sure to handle the lifecycle of the shared client, such as stopping the client, when it is no longer in use. Camel will call the start method on the client to ensure its started when this endpoint creates a producer.

This options should only be used in special circumstances.

getJettyBinding

public JettyHttpBinding getJettyBinding(org.eclipse.jetty.client.HttpClient httpClient)

setJettyBinding

public void setJettyBinding(JettyHttpBinding jettyBinding)

isEnableJmx

public boolean isEnableJmx()

setEnableJmx

public void setEnableJmx(boolean enableJmx)

If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.

isSendServerVersion

public boolean isSendServerVersion()

setSendServerVersion

public void setSendServerVersion(boolean sendServerVersion)

If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.

isSendDateHeader

public boolean isSendDateHeader()

setSendDateHeader

public void setSendDateHeader(boolean sendDateHeader)

If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.

isEnableMultipartFilter

public boolean isEnableMultipartFilter()

setEnableMultipartFilter

public void setEnableMultipartFilter(boolean enableMultipartFilter)

Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well.

setMultipartFilter

public void setMultipartFilter(javax.servlet.Filter filter)

Allows using a custom multipart filter. Note: setting multipartFilter forces the value of enableMultipartFilter to true.

getMultipartFilter

public javax.servlet.Filter getMultipartFilter()

setFilters

public void setFilters(List<javax.servlet.Filter> filterList)

getFilters

public List<javax.servlet.Filter> getFilters()

getContinuationTimeout

public Long getContinuationTimeout()

setContinuationTimeout

public void setContinuationTimeout(Long continuationTimeout)

Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of <= 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine.

getUseContinuation

public Boolean getUseContinuation()

setUseContinuation

public void setUseContinuation(Boolean useContinuation)

Whether or not to use Jetty continuations for the Jetty Server.

getSslContextParameters

public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters

getHttpClientMinThreads

public Integer getHttpClientMinThreads()

setHttpClientMinThreads

public void setHttpClientMinThreads(Integer httpClientMinThreads)

To set a value for minimum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool.

getHttpClientMaxThreads

public Integer getHttpClientMaxThreads()

setHttpClientMaxThreads

public void setHttpClientMaxThreads(Integer httpClientMaxThreads)

To set a value for maximum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool.

getHttpClientParameters

public Map<String,Object> getHttpClientParameters()

setHttpClientParameters

public void setHttpClientParameters(Map<String,Object> httpClientParameters)

Configuration of Jetty's HttpClient. For example, setting httpClient.idleTimeout=30000 sets the idle timeout to 30 seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds, in case you want to timeout sooner if you have long running request/response calls.

createContentExchange

public abstract JettyContentExchange createContentExchange()