Nuxeo 5 defines 3 differents types of restlets :

All restlets are bound to one or more URL patterns. These urls patterns are used by Nuxeo RestletServlet to determine which restlet needs to receive the call.

When defining URLs you can use {} to have parts of the URL that will be converted as parameters.

For example :

/{repo}/{docid}/{filename}/upload

will define a URL pattern with 4 parts and you will have access from withing your code to 3 parameters: repo, docId and filename.

These parameters can be used via Restlet API :

req.getAttributes().get("repo");

You can also access the standard GET/POST parameters via

req.getResourceRef().getQueryAsForm().getFirstValue("SomeParameter");

Contributing a new restlet is quite simple.

The first thing to do is to write a new restlet: you can either implement the Restlet Interface "by hand" or just inherit from NuxeoBaseRestlet or NuxeoBaseStatelessRestet.

Once your class is written, you need to contribute to the restlets extension point exposed by org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService.

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.platform.ui.web.restAPI.contrib">

  <extension
      target="org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService"
      point="restlets">
    <restletPlugin
        name="upload"
        class="org.nuxeo.ecm.platform.ui.web.restAPI.UploadRestlet"
        enabled="true"
        useSeam="true"
        useConversation="false">
      <urlPatterns>
        <urlPattern>/{repo}/{docid}/{filename}/upload</urlPattern>
      </urlPatterns>
   </restletPlugin>
   ...

The useSeam and useConversation flags define how the Nuxeo Restlet servlet will handle the call.

The Browse restlet is a simple way to navigate into the respository via REST.

A typicall call to list content of default repository would be : http://127.0.0.1:8080/nuxeo/restAPI/default/*/browse

If you need to browse the document 95ce52b2-6959-4afa-bc63-396096b376b4 a typicall call would be : http://127.0.0.1:8080/nuxeo/restAPI/default/95ce52b2-6959-4afa-bc63-396096b376b4/browse

Typical output for this restlet would be:

<document title="2fbf878d-9c2f-42c6-acbb-ea339ce15615" 
          type="Root" 
          id="2fbf878d-9c2f-42c6-acbb-ea339ce15615" 
          url="/default/2fbf878d-9c2f-42c6-acbb-ea339ce15615">
  <document title="Default domain"
            type="Domain"
            id="95ce52b2-6959-4afa-bc63-396096b376b4"
            url="/default/95ce52b2-6959-4afa-bc63-396096b376b4"/>
</document>

This restlet uses Seam in order to have documentManager injected (this is not a need but rather a simple way of accessing the repository without using the Service API)

Browse restlet registration looks like this:

<restletPlugin
    name="browse"
    class="org.nuxeo.ecm.platform.ui.web.restAPI.BrowseRestlet"
    enabled="true"
    useSeam="true">
  <urlPatterns>
    <urlPattern>/{repo}/{docid}/browse</urlPattern>
  </urlPatterns>
</restletPlugin>

This restlet is a simple REST frontend on top of IO core service. This can be used to export a document or a document tree as XML.

A typicall call would be :

This restlet uses Seam in order to have documentManager injected (this is not a need but rather a simple way of accessing the repository without using the Service API)

Export restlet registration looks like this:

<restletPlugin
    name="export"
    class="org.nuxeo.ecm.platform.ui.web.restAPI.ExportRestlet"
    enabled="true"
    useSeam="true">
  <urlPatterns>
    <urlPattern>/{repo}/{docid}/export</urlPattern>
    <urlPattern>/{repo}/{docid}/exportSingle</urlPattern>
    <urlPattern>/{repo}/{docid}/exportTree</urlPattern>
  </urlPatterns>
</restletPlugin>

This restlet provide a REST API for Lock Management.

A typical call would be:

This restlet is stateless and uses Nuxeo Service API

Lock restlet registration looks like this

<restletPlugin
    name="locking"
    class="org.nuxeo.ecm.platform.ui.web.restAPI.LockingRestlet"
    enabled="true"
    useSeam="false"
    useConversation="false">
  <urlPatterns>
    <urlPattern>/{repo}/{docid}/Locking</urlPattern>
  </urlPatterns>
</restletPlugin>

This restlet provides a REST API for file upload that is used by the Firefox helper.

A typical call would be:

This restlet uses Seam conversation.

pluginUpload restlet registration looks like this

<restletPlugin
    name="pluginUpload"
    class="org.nuxeo.ecm.platform.ui.web.restAPI.PluginUploadRestlet"
    enabled="true"
    useSeam="true"
    useConversation="true">
  <urlPatterns>
    <urlPattern>/{repo}/{docid}/pluginUpload</urlPattern>
  </urlPatterns>
</restletPlugin>

You can download the RestPack from Nuxeo download site or build it from source.

To deploy the module, just copy the jar file in nuxeo.ear/platform folder and restart you JBoss