...
| Name |
Default Value |
Description |
| headerFilterStrategy=#refName |
An instance of RestletHeaderFilterStrategy |
Use the # notation (headerFilterStrategy=#refName) to reference a header filter strategy in the Camel Registry. The strategy will be plugged into the restlet binding if it is HeaderFilterStrategyAware. |
| restletBinding=#refName |
An instance of DefaultRestletBinding |
The bean ID of a RestletBinding object in the Camel Registry. |
| restletMethod |
GET |
On a producer endpoint, specifies the request method to use. On a consumer endpoint, specifies that the endpoint consumes only restletMethod requests. The string value is converted to org.restlet.data.Method by the Method.valueOf(String) method. |
| restletMethods |
None |
Consumer only 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. |
| restletRealm=#refName |
null |
The bean ID of the Realm Map in the Camel Registry. |
| restletUriPatterns=#refName |
None |
Consumer only Specify one ore more URI templates to be serviced by a restlet consumer endpoint, using the # notation to reference a List<String> 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. |
| throwExceptionOnFailure (2.6 or later) |
true |
*Producer only * Throws exception on a producer failure. |
| connectionTimeout |
300000 |
Since Camel 2.12.3 Producer only The Client will give up connection if the connection is timeout, 0 for unlimited wait. |
| socketTimeout |
300000 |
Since Camel 2.12.3 Producer only The Client socket receive timeout, 0 for unlimited wait. |
disableStreamCache |
false |
Camel 2.14: Determines whether or not the raw input stream from Jetty 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 Jetty input stream to support reading it multiple times to ensure it 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. |
Component Options
The Restlet component can be configured with the following options. Notice these are component options and cannot be configured on the endpoint, see further below for an example.
| Name |
Default Value |
Description |
| controllerDaemon |
true |
Camel 2.10: Indicates if the controller thread should be a daemon (not blocking JVM exit). |
| controllerSleepTimeMs |
100 |
Camel 2.10: Time for the controller thread to sleep between each control. |
| inboundBufferSize |
8192 |
Camel 2.10: The size of the buffer when reading messages. |
| minThreads |
1 |
Camel 2.10: Minimum threads waiting to service requests. |
| maxThreads |
10 |
Camel 2.10: Maximum threads that will service requests. |
| lowThreads |
8 |
Camel 2.13: Number of worker threads determining when the connector is considered overloaded. |
| maxQueued |
0 |
Camel 2.13: 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. |
| maxConnectionsPerHost |
-1 |
Camel 2.10: Maximum number of concurrent connections per host (IP address). |
| maxTotalConnections |
-1 |
Camel 2.10: Maximum number of concurrent connections in total. |
| outboundBufferSize |
8192 |
Camel 2.10: The size of the buffer when writing messages. |
| persistingConnections |
true |
Camel 2.10: Indicates if connections should be kept alive after a call. |
| pipeliningConnections |
false |
Camel 2.10: Indicates if pipelining connections are supported. |
| threadMaxIdleTimeMs |
60000 |
Camel 2.10: Time for an idle thread to wait for an operation before being collected. |
| useForwardedForHeader |
false |
Camel 2.10: 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. |
| reuseAddress |
true |
Camel 2.10.5/2.11.1: Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocket#reuseAddress property for additional details. |
disableStreamCache |
false |
Camel 2.14: Determines whether or not the raw input stream from Jetty 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 Jetty input stream to support reading it multiple times to ensure it 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. |
![]() Wiki Markup |
{div:class=confluenceTableSmall}
|| Name || Type || Description ||
| {{Content-Type}} | {{String}} | Specifies the content type, which can be set on the OUT message by the application/processor. The value is the {{content-type}} of the response message. If this header is not set, the content type is based on the object type of the OUT message body. In Camel 2.3 onward, if the Content-Type header is specified in the Camel IN message, the value of the header determine the content type for the Restlet request message. Otherwise, it is defaulted to "application/x-www-form-urlencoded'. Prior to release 2.3, it is not possible to change the request content type default. |
| {{CamelAcceptContentType}} | {{String}} | *Since Camel 2.9.3, 2.10.0:* The HTTP Accept request header. |
| {{CamelHttpMethod}} | {{String}} | The HTTP request method. This is set in the IN message header. |
| {{CamelHttpQuery}} | {{String}} | The query string of the request URI. It is set on the IN message by {{DefaultRestletBinding}} when the restlet component receives a request. |
| {{CamelHttpResponseCode}} | {{String}} or {{Integer}} | The response code can be set on the OUT message by the application/processor. The value is the response code of the response message. If this header is not set, the response code is set by the restlet runtime engine. |
| {{CamelHttpUri}} | {{String}} | The HTTP request URI. This is set in the IN message header. |
| {{CamelRestletLogin}} | {{String}} | Login name for basic authentication. It is set on the IN message by the application and gets filtered before the restlet request header by Camel. |
| {{CamelRestletPassword}} | {{String}} | Password name for basic authentication. It is set on the IN message by the application and gets filtered before the restlet request header by Camel. |
| {{CamelRestletRequest}} | {{Request}} | *Camel 2.8:* The {{org.restlet.Request}} object which holds all request details. |
| {{CamelRestletResponse}} | {{Response}} | *Camel 2.8:* The {{org.restlet.Response}} object. You can use this to create responses using the API from Restlet. See examples below. |
| {{org.restlet.\*}} | | Attributes of a Restlet message that get propagated to Camel IN headers. |
| {{cache-control}}| {{String}} or {{List<CacheDirective>}} | *Camel 2.11:* User can set the cache-control with the String value or the List of CacheDirective of Restlet from the camel message header. |
{div} |
...
