Versions Compared

Old Version 2

changes.mady.by.user Donald Brown

Saved on

compared with

New Version 3

changes.mady.by.user Donald Brown

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Rest Plugin

Excerpt

simplifies Rest-style resources to be consumed by both human and machine clients

. The goals are to 100% follow Ruby on Rails-style Rest URL conventions and enable XML-free resource development. It builds on the Codebehind Plugin to support automatic configuration of both actions and results.

...

and the framework handles the serialization and deserialization automatically.

Features

  • Fully implements Ruby-On-Rails Rest-style URLs
  • Supports XML-free development, without requiring annotations
  • Built-in serialization support for XML and JSON
  • Automatic handling of errors
  • Type-safe configuration of the HTTP response
  • Automatic conditional GET support

Usage

As with the Codebehind Plugin, the first step is to tell the plugin where to find your resource action classes. Modify the configuration of your Struts 2 filter in web.xml and add the 'actionPackages' init-param like so:

...

Also, notice we aren't returning the usual "success" result code in either method. This allows us to use the special features of the Codebehind Plugin to intuitively select the result template to process when this resource is accessed with the .xhtml extension. In this case, we can provide a customized XHTML view of the resource by creating /orders-show.jsp and /orders-update.jsp for the respective methods.

Custom ContentTypeHandlers

If you need to handle extensions that aren't supported by the default handlers, you can create your own ContentTypeHandler implementation and define it in your struts.xml:

...

Code Block
struts.rest.handlerOverride.xml=myXml

Example

The plugin ships with a struts2-rest-showcase application that demonstrates a simple Rest web program.

Settings

The following settings can be customized. See the developer guide.

Setting

Description

Default

Possible Values

struts.rest.handlerOverride.EXTENSION

The alias for the ContentTypeHandler implementation that handles the EXTENSION value

N/A

Any declared alias for a ContentTypeHandler implementation

struts.rest.defaultHandlerName

The default extension to use when non is explicitly specified in the request

xml

Any extension

Installation

This plugin can be installed by copying the plugin jar into your application's /WEB-INF/lib directory. It does depend on the Codebehind Plugin, so if aren't using a build system that supports transitive dependencies like Maven 2, you will need to add that plugin as well.

Resources

Version History

From Struts 2.1.1+