JBoss Community Archive (Read Only)

ModeShape 3

ModeShape's REST Service

ModeShape's RESTful API was intended to be used by HTTP clients, so it's quite easy to write a simple client application to read and write repository content using the RESTful API. However, since our trusty web browser is indeed a simple HTTP client, we can use it to directly interact with the RESTful API. It might not be pretty, but it works beautifully.

The RESTful API is nothing more than a simple JAX-RS web application that is packaged as a WAR file and that comes in 2 flavors:

Both web applications use Basic HTTP Authentication and require a role named connect to be present in the authenticated user's set of roles.

ModeShape 3 provides two different versions of the RESTful API:

  1. REST Service 2.x - the version which was included in ModeShape 2 and which has been deprecated. However, for backwards compatibility it is still accessible using the v1 URL prefix: http://<host>:<port>/<context>/v1/

  2. REST Service 3.x - a newer version which is an extension of the old one, plus a number of additional improvements.

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-11 12:06:51 UTC, last content change 2012-08-16 12:44:28 UTC.