er.rest.routes

Class ERXRouteResults

java.lang.Object

er.rest.routes.ERXRouteResults

All Implemented Interfaces:

WOActionResults

public class ERXRouteResults
extends Object
implements WOActionResults

ERXRouteResults encapsulates the data necessary to produce a RESTful response. This object exists to defer the generation of the response (so you can chain together rest responders).

Author:

mschrag

Properties

Name	Description
ERXRest.strictMode	(default "true") If set to true, creating a ressource will return status code 201 Created, if set to false, will return 200 OK

Constructor Summary

Constructors

Constructor and Description
ERXRouteResults(WOContext context, ERXRestContext restContext, ERXRestFormat format, ERXRestRequestNode responseNode) Constructs an ERXRouteResults.

Method Summary

Modifier and Type	Method and Description
ERXRestFormat	format() Returns the intended format of this response.
WOResponse	generateResponse() Generates a WOResponse out of this ERXRouteResults.
ERXRestRequestNode	responseNode() Returns the ERXRestRequestNode to render.
void	setHeaderForKey(String header, String key) Adds a header for the resulting WOResponse.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ERXRouteResults

public ERXRouteResults(WOContext context,
                       ERXRestContext restContext,
                       ERXRestFormat format,
                       ERXRestRequestNode responseNode)

Constructs an ERXRouteResults.

Parameters:

context - the current context

restContext - the REST context

format - the intended format of this response

responseNode - the ERXRestRequestNode to render

Method Detail

setHeaderForKey

public void setHeaderForKey(String header,
                            String key)

Adds a header for the resulting WOResponse.

Parameters:

header - the header to add

key - the key to add

format

public ERXRestFormat format()

Returns the intended format of this response.

Returns:

the intended format of this response

responseNode

public ERXRestRequestNode responseNode()

Returns the ERXRestRequestNode to render.

Returns:

the ERXRestRequestNode to render

generateResponse

public WOResponse generateResponse()

Generates a WOResponse out of this ERXRouteResults.

Specified by:

generateResponse in interface WOActionResults

Returns:

a generated WOResponse