Overview of the JerseyMe API

The JerseyMe API allows a client application to access RESTful web services using Java ME. It is modelled after Jersey's client API for Java SE. The minimum platform requirements are CLDC 1.1 and MIDP 2.0.

Sun GlassFish Mobility Platform applications can use JerseyMe to access resources on the web.

JerseyMe supports caching using the file system on the device. Caching can be used to avoid re-fetching the same resource over and over and also to support an offline mode, in which resources are retrieved only from the local cache, even if they are stale.

The JerseyMe API contains the following classes and interface:

• com.sun.jerseyme.api.client.Client, which provides the entry point to the API

• The com.sun.jerseyme.api.client.UniformInterface interface and its implementation, the com.sun.jerseyme.api.client.WebResource class, which implements a web resource on which the HTTP methods GET, PUT, POST, DELETE and HEAD can be called

• The UniformInterfaceException class, which indicates an error in a UniformInterface method

See Chapter 5, JerseyMe API Documentation for summaries of the JerseyMe API methods. The API documentation is also included in the Sun GlassFish Mobility Platform client bundle. In the directory where you unzipped the client bundle (see the Sun GlassFish Mobility Platform 1.1 Installation Guide for details), it is in the directory sgmp-client-1_1_01-fcs-b02/doc/JerseyMe/api/doc.

The MusicDB and Salesforce sample clients make only minor use of the JerseyMe API, but other applications are likely to find it very useful.