org.apache.camel.component.restlet

Class RestletComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.component.restlet.RestletComponent

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.spi.RestApiConsumerFactory, org.apache.camel.spi.RestConsumerFactory, org.apache.camel.spi.RestProducerFactory, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class RestletComponent
extends org.apache.camel.impl.DefaultComponent
implements org.apache.camel.spi.RestConsumerFactory, org.apache.camel.spi.RestApiConsumerFactory, org.apache.camel.spi.RestProducerFactory, org.apache.camel.SSLContextParametersAware, org.apache.camel.spi.HeaderFilterStrategyAware

A Camel component embedded Restlet that produces and consumes exchanges.

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
RestletComponent()
RestletComponent(org.restlet.Component component)

Method Summary

Modifier and Type	Method and Description
protected void	addServerIfNecessary(RestletEndpoint endpoint)
protected static void	cleanupConverters(List<String> converters)
void	connect(RestletConsumer consumer)
org.apache.camel.Consumer	createApiConsumer(org.apache.camel.CamelContext camelContext, org.apache.camel.Processor processor, String contextPath, org.apache.camel.spi.RestConfiguration configuration, Map<String,Object> parameters)
org.apache.camel.Consumer	createConsumer(org.apache.camel.CamelContext camelContext, org.apache.camel.Processor processor, String verb, String basePath, String uriTemplate, String consumes, String produces, org.apache.camel.spi.RestConfiguration configuration, Map<String,Object> parameters)
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
org.apache.camel.Producer	createProducer(org.apache.camel.CamelContext camelContext, String host, String verb, String basePath, String uriTemplate, String queryParameters, String consumes, String produces, Map<String,Object> parameters)
protected RestletHost	createRestletHost()
void	disconnect(RestletConsumer consumer)
protected void	doStart()
protected void	doStop()
Boolean	getControllerDaemon()
Integer	getControllerSleepTimeMs()
List<String>	getEnabledConverters()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
Integer	getInboundBufferSize()
Integer	getLowThreads()
Integer	getMaxConnectionsPerHost()
Integer	getMaxQueued()
Integer	getMaxThreads()
Integer	getMaxTotalConnections()
Integer	getMinThreads()
Integer	getOutboundBufferSize()
Boolean	getPersistingConnections()
Boolean	getPipeliningConnections()
int	getPort()
Boolean	getReuseAddress()
Boolean	getSynchronous()
Integer	getThreadMaxIdleTimeMs()
Boolean	getUseForwardedForHeader()
boolean	isDisableStreamCache()
boolean	isUseGlobalSslContextParameters()
void	setControllerDaemon(Boolean controllerDaemon) Indicates if the controller thread should be a daemon (not blocking JVM exit).
void	setControllerSleepTimeMs(Integer controllerSleepTimeMs) Time for the controller thread to sleep between each control.
void	setDisableStreamCache(boolean disableStreamCache) Determines whether or not the raw input stream from Restlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache.
void	setEnabledConverters(List<String> enabledConverters) A list of converters to enable as full class name or simple class name.
void	setEnabledConverters(String enabledConverters) A comma separated list of converters to enable as full class name or simple class name.
void	setEndpointHeaderFilterStrategy(org.apache.camel.Endpoint endpoint)
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
void	setInboundBufferSize(Integer inboundBufferSize) The size of the buffer when reading messages.
void	setLowThreads(Integer lowThreads) Number of worker threads determining when the connector is considered overloaded.
void	setMaxConnectionsPerHost(Integer maxConnectionsPerHost) Maximum number of concurrent connections per host (IP address).
void	setMaxQueued(Integer maxQueued) Maximum number of calls that can be queued if there aren't any worker thread available to service them.
void	setMaxThreads(Integer maxThreads) Maximum threads that will service requests.
void	setMaxTotalConnections(Integer maxTotalConnections) Maximum number of concurrent connections in total.
void	setMinThreads(Integer minThreads) Minimum threads waiting to service requests.
void	setOutboundBufferSize(Integer outboundBufferSize) The size of the buffer when writing messages.
void	setPersistingConnections(Boolean persistingConnections) Indicates if connections should be kept alive after a call.
void	setPipeliningConnections(Boolean pipeliningConnections) Indicates if pipelining connections are supported.
void	setPort(int port) To configure the port number for the restlet consumer routes.
void	setReuseAddress(Boolean reuseAddress) Enable/disable the SO_REUSEADDR socket option.
void	setSynchronous(Boolean synchronous) Whether to use synchronous Restlet Client for the producer.
void	setThreadMaxIdleTimeMs(Integer threadMaxIdleTimeMs) Time for an idle thread to wait for an operation before being collected.
void	setUseForwardedForHeader(Boolean useForwardedForHeader) Lookup the "X-Forwarded-For" header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result.
void	setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.
protected boolean	useIntrospectionOnEndpoint()

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

afterConfiguration, createComponentConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, useRawUri, validateParameters, validateURI

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.SSLContextParametersAware

retrieveGlobalSslContextParameters

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext

Constructor Detail

RestletComponent

public RestletComponent()

RestletComponent

public RestletComponent(org.restlet.Component component)

Method Detail

createEndpoint

protected org.apache.camel.Endpoint createEndpoint(String uri,
                                                   String remaining,
                                                   Map<String,Object> parameters)
                                            throws Exception

Specified by:

createEndpoint in class org.apache.camel.impl.DefaultComponent

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultComponent

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultComponent

Throws:

Exception

useIntrospectionOnEndpoint

protected boolean useIntrospectionOnEndpoint()

Overrides:

useIntrospectionOnEndpoint in class org.apache.camel.impl.DefaultComponent

connect

public void connect(RestletConsumer consumer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(RestletConsumer consumer)
                throws Exception

Throws:

Exception

addServerIfNecessary

protected void addServerIfNecessary(RestletEndpoint endpoint)
                             throws Exception

Throws:

Exception

createRestletHost

protected RestletHost createRestletHost()

getControllerDaemon

public Boolean getControllerDaemon()

setControllerDaemon

public void setControllerDaemon(Boolean controllerDaemon)

Indicates if the controller thread should be a daemon (not blocking JVM exit).

getControllerSleepTimeMs

public Integer getControllerSleepTimeMs()

setControllerSleepTimeMs

public void setControllerSleepTimeMs(Integer controllerSleepTimeMs)

Time for the controller thread to sleep between each control.

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 strategy)

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

Specified by:

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

getInboundBufferSize

public Integer getInboundBufferSize()

setInboundBufferSize

public void setInboundBufferSize(Integer inboundBufferSize)

The size of the buffer when reading messages.

getMaxConnectionsPerHost

public Integer getMaxConnectionsPerHost()

setMaxConnectionsPerHost

public void setMaxConnectionsPerHost(Integer maxConnectionsPerHost)

Maximum number of concurrent connections per host (IP address).

getMaxThreads

public Integer getMaxThreads()

setMaxThreads

public void setMaxThreads(Integer maxThreads)

Maximum threads that will service requests.

getLowThreads

public Integer getLowThreads()

setLowThreads

public void setLowThreads(Integer lowThreads)

Number of worker threads determining when the connector is considered overloaded.

getMaxTotalConnections

public Integer getMaxTotalConnections()

setMaxTotalConnections

public void setMaxTotalConnections(Integer maxTotalConnections)

Maximum number of concurrent connections in total.

getMinThreads

public Integer getMinThreads()

setMinThreads

public void setMinThreads(Integer minThreads)

Minimum threads waiting to service requests.

getOutboundBufferSize

public Integer getOutboundBufferSize()

setOutboundBufferSize

public void setOutboundBufferSize(Integer outboundBufferSize)

The size of the buffer when writing messages.

getPersistingConnections

public Boolean getPersistingConnections()

setPersistingConnections

public void setPersistingConnections(Boolean persistingConnections)

Indicates if connections should be kept alive after a call.

getPipeliningConnections

public Boolean getPipeliningConnections()

setPipeliningConnections

public void setPipeliningConnections(Boolean pipeliningConnections)

Indicates if pipelining connections are supported.

getThreadMaxIdleTimeMs

public Integer getThreadMaxIdleTimeMs()

setThreadMaxIdleTimeMs

public void setThreadMaxIdleTimeMs(Integer threadMaxIdleTimeMs)

Time for an idle thread to wait for an operation before being collected.

getUseForwardedForHeader

public Boolean getUseForwardedForHeader()

setUseForwardedForHeader

public void setUseForwardedForHeader(Boolean useForwardedForHeader)

Lookup the "X-Forwarded-For" header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks.

getReuseAddress

public Boolean getReuseAddress()

setReuseAddress

public void setReuseAddress(Boolean reuseAddress)

Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocket#reuseAddress property for additional details.

getMaxQueued

public Integer getMaxQueued()

setMaxQueued

public void setMaxQueued(Integer maxQueued)

Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0', then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1', then an unbounded queue is used and calls are never rejected.

isDisableStreamCache

public boolean isDisableStreamCache()

setDisableStreamCache

public void setDisableStreamCache(boolean disableStreamCache)

Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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. DefaultRestletBinding 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.

getPort

public int getPort()

setPort

public void setPort(int port)

To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers.

getSynchronous

public Boolean getSynchronous()

setSynchronous

public void setSynchronous(Boolean synchronous)

Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better.

getEnabledConverters

public List<String> getEnabledConverters()

setEnabledConverters

public void setEnabledConverters(List<String> enabledConverters)

A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null

setEnabledConverters

public void setEnabledConverters(String enabledConverters)

A comma separated list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null

isUseGlobalSslContextParameters

public boolean isUseGlobalSslContextParameters()

Specified by:

isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

setUseGlobalSslContextParameters

public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters.

Specified by:

setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.CamelContext camelContext,
                                                org.apache.camel.Processor processor,
                                                String verb,
                                                String basePath,
                                                String uriTemplate,
                                                String consumes,
                                                String produces,
                                                org.apache.camel.spi.RestConfiguration configuration,
                                                Map<String,Object> parameters)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.spi.RestConsumerFactory

Throws:

Exception

createApiConsumer

public org.apache.camel.Consumer createApiConsumer(org.apache.camel.CamelContext camelContext,
                                                   org.apache.camel.Processor processor,
                                                   String contextPath,
                                                   org.apache.camel.spi.RestConfiguration configuration,
                                                   Map<String,Object> parameters)
                                            throws Exception

Specified by:

createApiConsumer in interface org.apache.camel.spi.RestApiConsumerFactory

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer(org.apache.camel.CamelContext camelContext,
                                                String host,
                                                String verb,
                                                String basePath,
                                                String uriTemplate,
                                                String queryParameters,
                                                String consumes,
                                                String produces,
                                                Map<String,Object> parameters)
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.spi.RestProducerFactory

Throws:

Exception

cleanupConverters

protected static void cleanupConverters(List<String> converters)

setEndpointHeaderFilterStrategy

public void setEndpointHeaderFilterStrategy(org.apache.camel.Endpoint endpoint)