Restlet

Restlet

Description: A Camel component embedded Restlet that produces and consumes exchanges.
Scheme: restlet
Syntax: restlet:protocol:host:port/uriPattern
Maven: org.apache.camel/camel-restlet/2.16.1

Represents a endpoint

Name Kind Group Required Default Type Enum Description
protocol path common true java.lang.String http
https
The protocol to use which is http or https
host path common true java.lang.String The hostname of the restlet service
port path common true 80 int The port number of the restlet service
uriPattern path common true java.lang.String The resource pattern such as /customer/{id}
disableStreamCache parameter common boolean 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.
headerFilterStrategy parameter common org.apache.camel.spi.HeaderFilterStrategy To use a custom HeaderFilterStrategy to filter header to and from Camel message.
restletBinding parameter common org.apache.camel.component.restlet.RestletBinding To use a custom RestletBinding to bind between Restlet and Camel message.
restletMethod parameter common GET org.restlet.data.Method On a producer endpoint, specifies the request method to use. On a consumer endpoint, specifies that the endpoint consumes only restletMethod requests.
restletRealm parameter common java.util.Map To configure the security realms of restlet as a map.
sslContextParameters parameter common org.apache.camel.util.jsse.SSLContextParameters To configure security using SSLContextParameters.
restletMethods parameter consumer org.restlet.data.Method[] 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.
restletUriPatterns parameter consumer java.util.List 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.
connectTimeout parameter producer 30000 int The Client will give up connection if the connection is timeout, 0 for unlimited wait.
socketTimeout parameter producer 30000 int The Client socket receive timeout, 0 for unlimited wait.
throwExceptionOnFailure parameter producer true boolean 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.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

restlet consumer

A Restlet consumer acts as a server to listen client requests.