org.apache.camel.component.restlet

Class RestletComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.impl.HeaderFilterStrategyComponent

org.apache.camel.component.restlet.RestletComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, HeaderFilterStrategyAware, RestApiConsumerFactory, RestConsumerFactory, StatefulService, SuspendableService

public class RestletComponent
extends HeaderFilterStrategyComponent
implements RestConsumerFactory, RestApiConsumerFactory

A Camel component embedded Restlet that produces and consumes exchanges.

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

Method Summary

Modifier and Type	Method and Description
protected void	addServerIfNecessary(RestletEndpoint endpoint)
void	connect(RestletConsumer consumer)
Consumer	createApiConsumer(CamelContext camelContext, Processor processor, String contextPath, RestConfiguration configuration, Map<String,Object> parameters) Creates a new REST API Event Driven Consumer, which provides API listing of the REST services
Consumer	createConsumer(CamelContext camelContext, Processor processor, String verb, String basePath, String uriTemplate, String consumes, String produces, RestConfiguration configuration, Map<String,Object> parameters) Creates a new REST Event Driven Consumer, which consumes messages from the endpoint using the given processor
protected Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
protected org.restlet.Server	createServer(RestletEndpoint endpoint)
void	disconnect(RestletConsumer consumer)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
Boolean	getControllerDaemon()
Integer	getControllerSleepTimeMs()
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()
protected String	preProcessUri(String uri) Deprecated.
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	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.
protected void	setupServerWithSSLContext(org.restlet.util.Series<org.restlet.data.Parameter> params, SSLContextParameters scp)
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.
protected String	stringArrayToString(String[] strings)
protected boolean	useIntrospectionOnEndpoint() Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance

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

getHeaderFilterStrategy, setEndpointHeaderFilterStrategy, setHeaderFilterStrategy

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, 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

Constructor Detail

RestletComponent

public RestletComponent()

RestletComponent

public RestletComponent(org.restlet.Component component)

Method Detail

createEndpoint

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

Description copied from class: DefaultComponent

A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:

createEndpoint in class DefaultComponent

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - is thrown if error creating the endpoint

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()

useIntrospectionOnEndpoint

protected boolean useIntrospectionOnEndpoint()

Description copied from class: DefaultComponent

Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance

Overrides:

useIntrospectionOnEndpoint in class DefaultComponent

connect

public void connect(RestletConsumer consumer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(RestletConsumer consumer)
                throws Exception

Throws:

Exception

createServer

protected org.restlet.Server createServer(RestletEndpoint endpoint)

stringArrayToString

protected String stringArrayToString(String[] strings)

setupServerWithSSLContext

protected void setupServerWithSSLContext(org.restlet.util.Series<org.restlet.data.Parameter> params,
                                         SSLContextParameters scp)
                                  throws GeneralSecurityException,
                                         IOException

Throws:

GeneralSecurityException

IOException

addServerIfNecessary

protected void addServerIfNecessary(RestletEndpoint endpoint)
                             throws Exception

Throws:

Exception

preProcessUri

@Deprecated
protected String preProcessUri(String uri)

Deprecated.

Overrides:

preProcessUri in class DefaultComponent

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.

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.

createConsumer

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

Description copied from interface: RestConsumerFactory

Creates a new REST Event Driven Consumer, which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface RestConsumerFactory

Parameters:

camelContext - the camel context

processor - the processor

verb - HTTP verb such as GET, POST

basePath - base path

uriTemplate - uri template

consumes - media-types for what this REST service consume as input (accept-type), is null or */* for anything

produces - media-types for what this REST service produces as output, can be null

parameters - additional parameters

Returns:

a newly created REST consumer

Throws:

Exception - can be thrown

createApiConsumer

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

Description copied from interface: RestApiConsumerFactory

Creates a new REST API Event Driven Consumer, which provides API listing of the REST services

Specified by:

createApiConsumer in interface RestApiConsumerFactory

Parameters:

camelContext - the camel context

processor - the processor

contextPath - the context-path

parameters - additional parameters

Returns:

a newly created REST API consumer

Throws:

Exception - can be thrown