org.apache.camel.component.restlet

Class RestletEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.restlet.RestletEndpoint

All Implemented Interfaces:

org.apache.camel.AsyncEndpoint, 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

@UriEndpoint(firstVersion="2.0.0",
             scheme="restlet",
             title="Restlet",
             syntax="restlet:protocol:host:port/uriPattern",
             consumerClass=RestletConsumer.class,
             label="rest",
             lenientProperties=true)
public class RestletEndpoint
extends org.apache.camel.impl.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.HeaderFilterStrategyAware

Component for consuming and producing Restful resources using Restlet.

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
RestletEndpoint(RestletComponent component, String remaining)

Method Summary

Modifier and Type	Method and Description
void	connect(RestletConsumer restletConsumer)
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange()
org.apache.camel.Producer	createProducer()
void	disconnect(RestletConsumer restletConsumer)
protected void	doStart()
protected void	doStop()
int	getConnectTimeout()
org.apache.camel.http.common.cookie.CookieHandler	getCookieHandler()
org.apache.camel.ExchangePattern	getExchangePattern()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
String	getHost()
int	getPort()
String	getProtocol()
Map<String,Object>	getQueryParameters()
RestletBinding	getRestletBinding()
org.restlet.data.Method	getRestletMethod()
org.restlet.data.Method[]	getRestletMethods()
Map<String,String>	getRestletRealm()
List<String>	getRestletUriPatterns() Deprecated.
int	getSocketTimeout()
org.apache.camel.util.jsse.SSLContextParameters	getSslContextParameters()
String	getUriPattern()
boolean	isAutoCloseStream()
boolean	isDisableStreamCache()
boolean	isLenientProperties()
boolean	isSingleton()
boolean	isStreamRepresentation()
boolean	isThrowExceptionOnFailure()
void	setAutoCloseStream(boolean autoCloseStream) Whether to auto close the stream representation as response from calling a REST service using the restlet producer.
void	setCompleteEndpointUri(String uri)
void	setConnectTimeout(int connectTimeout) The Client will give up connection if the connection is timeout, 0 for unlimited wait.
void	setCookieHandler(org.apache.camel.http.common.cookie.CookieHandler cookieHandler) Configure a cookie handler to maintain a HTTP session
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	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
void	setHost(String host) The hostname of the restlet service
void	setPort(int port) The port number of the restlet service
void	setProtocol(String protocol) The protocol to use which is http or https
void	setQueryParameters(Map<String,Object> queryParameters) Additional query parameters for producer
void	setRestletBinding(RestletBinding restletBinding) To use a custom RestletBinding to bind between Restlet and Camel message.
void	setRestletMethod(org.restlet.data.Method restletMethod) On a producer endpoint, specifies the request method to use.
void	setRestletMethods(org.restlet.data.Method[] restletMethods) Specify one or more methods separated by commas (e.g.
void	setRestletRealm(Map<String,String> restletRealm) To configure the security realms of restlet as a map.
void	setRestletUriPatterns(List<String> restletUriPatterns) Deprecated.
void	setSocketTimeout(int socketTimeout) The Client socket receive timeout, 0 for unlimited wait.
void	setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters scp) To configure security using SSLContextParameters.
void	setStreamRepresentation(boolean streamRepresentation) Whether to support stream representation as response from calling a REST service using the restlet producer.
void	setThrowExceptionOnFailure(boolean throwExceptionOnFailure) Whether to throw exception on a producer failure.
void	setUriPattern(String uriPattern) The resource pattern such as /customer/{id}

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, 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

configureProperties, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

RestletEndpoint

public RestletEndpoint(RestletComponent component,
                       String remaining)
                throws Exception

Throws:

Exception

Method Detail

setCompleteEndpointUri

public void setCompleteEndpointUri(String uri)

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

isLenientProperties

public boolean isLenientProperties()

Specified by:

isLenientProperties in interface org.apache.camel.Endpoint

Overrides:

isLenientProperties in class org.apache.camel.impl.DefaultEndpoint

createExchange

public org.apache.camel.Exchange createExchange()

Specified by:

createExchange in interface org.apache.camel.Endpoint

Overrides:

createExchange in class org.apache.camel.impl.DefaultEndpoint

createConsumer

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

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

createProducer

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

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

connect

public void connect(RestletConsumer restletConsumer)
             throws Exception

Throws:

Exception

disconnect

public void disconnect(RestletConsumer restletConsumer)
                throws Exception

Throws:

Exception

getRestletMethod

public org.restlet.data.Method getRestletMethod()

setRestletMethod

public void setRestletMethod(org.restlet.data.Method restletMethod)

On a producer endpoint, specifies the request method to use. On a consumer endpoint, specifies that the endpoint consumes only restletMethod requests.

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

The protocol to use which is http or https

getHost

public String getHost()

setHost

public void setHost(String host)

The hostname of the restlet service

getPort

public int getPort()

setPort

public void setPort(int port)

The port number of the restlet service

getSocketTimeout

public int getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

The Client socket receive timeout, 0 for unlimited wait.

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

The Client will give up connection if the connection is timeout, 0 for unlimited wait.

getUriPattern

public String getUriPattern()

setUriPattern

public void setUriPattern(String uriPattern)

The resource pattern such as /customer/{id}

getRestletBinding

public RestletBinding getRestletBinding()

setRestletBinding

public void setRestletBinding(RestletBinding restletBinding)

To use a custom RestletBinding to bind between Restlet and Camel message.

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

getHeaderFilterStrategy

public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

Specified by:

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

setRestletRealm

public void setRestletRealm(Map<String,String> restletRealm)

To configure the security realms of restlet as a map.

getRestletRealm

public Map<String,String> getRestletRealm()

getExchangePattern

public org.apache.camel.ExchangePattern getExchangePattern()

Overrides:

getExchangePattern in class org.apache.camel.impl.DefaultEndpoint

setRestletMethods

public void setRestletMethods(org.restlet.data.Method[] restletMethods)

Specify one or more methods separated by commas (e.g. restletMethods=post,put) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified, the restletMethod setting is ignored. The possible methods are: ALL,CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE

getRestletMethods

public org.restlet.data.Method[] getRestletMethods()

setRestletUriPatterns

@Deprecated
public void setRestletUriPatterns(List<String> restletUriPatterns)

Deprecated.

Specify one ore more URI templates to be serviced by a restlet consumer endpoint, using the # notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI, both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored.

getRestletUriPatterns

@Deprecated
public List<String> getRestletUriPatterns()

Deprecated.

isThrowExceptionOnFailure

public boolean isThrowExceptionOnFailure()

setThrowExceptionOnFailure

public void setThrowExceptionOnFailure(boolean throwExceptionOnFailure)

Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value.

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.

getSslContextParameters

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

setSslContextParameters

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

To configure security using SSLContextParameters.

isStreamRepresentation

public boolean isStreamRepresentation()

setStreamRepresentation

public void setStreamRepresentation(boolean streamRepresentation)

Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route, you may need to not auto close the stream.

isAutoCloseStream

public boolean isAutoCloseStream()

setAutoCloseStream

public void setAutoCloseStream(boolean autoCloseStream)

Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route, you may need to not auto close the stream.

getCookieHandler

public org.apache.camel.http.common.cookie.CookieHandler getCookieHandler()

setCookieHandler

public void setCookieHandler(org.apache.camel.http.common.cookie.CookieHandler cookieHandler)

Configure a cookie handler to maintain a HTTP session

getQueryParameters

public Map<String,Object> getQueryParameters()

setQueryParameters

public void setQueryParameters(Map<String,Object> queryParameters)

Additional query parameters for producer

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception