[CONF] Apache Camel: Restlet (page edited)

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[CONF] Apache Camel: Restlet (page edited)

Dhiraj Bokde (Confluence)

Restlet has been edited by William Tam (Feb 12, 2009).

(View changes)


Restlet Component

The Restlet component provides Restlet based endpoints for consuming and producing RESTful resources.

URI format


Format of restletUrl:


Restlet promotes decoupling of protocol and application concerns. The reference implementation of Restlet Engine supports a number of protocols. However, we have tested the HTTP protocol only. The default port is port 80. We do not automatically switch default port based on the protocol yet.


Name Default Value Description
restletMethod GET The method to be used in the request for producer. For consumer, the Restlet Endpoint only consumes requests made by restletMethod. The string value is converted to org.restlet.data.Method by the Method.valueOf(String) method.
In 1.x only, restletBindingRef. For 2.x or later, use restletBinding=#refName An instance of DefaultRestletBinding object The name to lookup the RestletBinding object in the Camel Registry.
In 1.x only, restletRealmRef. For 2.x or later use restletRealm=#refName null The name to lookup the Realm Map in the Camel Registry.
headerFilterStrategy (2.x or later) An instance of RestletHeaderFilterStrategy object 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.

Message Headers

Name Type Description
org.apache.camel.restlet.auth.login String Login name for basic authentication. It is set on the IN message by application and get filtered before Restlet Request header by Camel.
org.apache.camel.restlet.auth.password String Password name for basic authentication. It is set on the IN message by application and get filtered before Restlet Request header by Camel.
org.apache.camel.restlet.mediaType String It can be set on the OUT message by application/processor. The value is the content-type of the response message. If this header is not set, content-type will be set based on the object type of the out message body.
org.apache.camel.restlet.queryString String The query string of the request URI. It is set on the IN message by DefaultRestletBinding when the Restlet Component receives a request.
org.apache.camel.restlet.responseCode String or Integer It can be set on the OUT message by application/processor. The value is the response code of the response message. If this header is not set, response code will be set by Restlet runtime engine.
org.restlet.*   Attributes of a Restlet message that get propagated to Camel IN headers.

Message Body

Camel will store the Restlet response from the external server on the OUT body. All headers from the IN message will be copied to the OUT message so headers is preserved during routing.


Restlet Endpoint with Authentication

This sample starts a Restlet consumer endpoint that listens POST requests on http://localhost:8080. The route looks like follow. The consumer invokes a processor that creates a response to echo the request body and the value of header "id".

from("restlet:http://localhost:9080/securedOrders?restletMethod=post&restletRealm=#realm").process(new Processor() {
    public void process(Exchange exchange) throws Exception {
                "received [" + exchange.getIn().getBody()
                + "] as an order id = "
                + exchange.getIn().getHeader("id"));

The restletRealmRef (in 2.x, use the # notation. i.e. restletRealm=#refName)in URI query is an option to lookup a Realm Map in the registry. If this option is specified, the Restlet consumer will use the information to authenticate user logins. Only authenticated requests can access the resources. In this sample, we create a Spring application context that serves as a registry. The bean ID of the Realm Map should match the restletRealmRef.

An error occurred: http://svn.apache.org/repos/asf/camel/trunk/componnetscamel-restlet/src/test/resources/org/apache/camel/component/restlet/camel-context.xml. The system administrator has been notified.

The sample starts a direct endpoint that sends requests to the server on http://localhost:8080 (i.e. our Restlet consumer endpoint).

// Note: restletMethod and restletRealmRef are stripped 
// from the query before a request is sent as they are 
// only processed by Camel.

That is all we need. We are ready to send a request and try out the Restlet component. The sample client sends a request to "direct:start-auth" endpoint with the following headers. Notice that org.apache.camel.restlet.auth.login and org.apache.camel.restlet.auth.password will not be propagated as Restlet header.

  • org.apache.camel.restlet.auth.login (internally used by Camel)
  • org.apache.camel.restlet.auth.password (internally used by Camel)
  • id ("application" header)
final String id = "89531";

Map<String, Object> headers = new HashMap<String, Object>();
headers.put(RestletConstants.LOGIN, "admin");
headers.put(RestletConstants.PASSWORD, "foo");
headers.put("id", id);

String response = (String) template.requestBodyAndHeaders("direct:start-auth", 
        "<order foo='1'/>", headers);

The sample client will get a response:

received [<order foo='1'/>] as an order id = 89531