net.sf.serfj

Class RestController

java.lang.Object

net.sf.serfj.RestController

public class RestController
extends Object

Class that can be used as parent class for an action which wants to be a Serfj controller.

Author:

Eduardo Yáñez

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestController()
protected	RestController(ResponseHelper response)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addObject2Request(String name, Object object) Deprecated. Use putParam(String name, Object object)
String	getExtension() Gets the URL extension, if any.
protected String	getId() Gets the value of an Id for the current resource. /sessions/1 -> Id: 1, identifier of 'session' /sessions/1/users/2 -> Id: 2, identifier of 'users'
protected String	getId(String resource) Gets the value of an Id given its resource's name. /sessions/1 -> Id: 1, Resource: session /sessions/1/users/2 -> Id: 2, Resource: user
protected Object	getParam(String name) Gets a the value of a parameter that came in the URL or in the request.
protected Map<String,Object>	getParams() Gets a Map containing all the parameters in the query string, and all the attributes in the request.
protected String	getRemoteAddress() Returns the remote address with including protocol.
ResponseHelper	getResponseHelper() Gets the ResponseHelper associated to the request. When a controller's action is called, a ResponseHelper is set through RestController.setResponseHelper(ResponseHelper response) so the action method will be able to access objects like HttpServletResponse, ServletContext and HttpServletRequest.
String	getSerializer() Gets the Serializer class, if any.
protected String	getStringParam(String name) Returns parameter's value that is a String.
protected void	putParam(String name, Object object) Adds an object to the request.
void	renderPage() Renders the predefined page.
void	renderPage(String page) Renders some page within 'views' directory.
void	renderPage(String resource, String page) Renders a page from a resource.
void	serialize(Object object) Serialize an object.
void	setResponseHelper(ResponseHelper response)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestController

protected RestController()

RestController

protected RestController(ResponseHelper response)

Method Detail

setResponseHelper

public void setResponseHelper(ResponseHelper response)

getResponseHelper

public ResponseHelper getResponseHelper()

Gets the ResponseHelper associated to the request.
When a controller's action is called, a ResponseHelper is set through RestController.setResponseHelper(ResponseHelper response)
so the action method will be able to access objects like HttpServletResponse, ServletContext and HttpServletRequest.

getParams

protected Map<String,Object> getParams()

Gets a Map containing all the parameters in the query string, and all the attributes in the request.

getParam

protected Object getParam(String name)

Gets a the value of a parameter that came in the URL or in the request.

addObject2Request

protected void addObject2Request(String name,
                     Object object)

Deprecated. Use putParam(String name, Object object)

Adds an object to the request. If a page will be renderer and it needs some objects to work, with this method a developer can add objects to the request, so the page can obtain them.

Parameters:

name - Parameter name

object - Object to put in the request

putParam

protected void putParam(String name,
            Object object)

Adds an object to the request. If a page will be renderer and it needs some objects to work, with this method a developer can add objects to the request, so the page can obtain them.

Parameters:

name - Parameter name

object - Object to put in the request

getRemoteAddress

protected String getRemoteAddress()

Returns the remote address with including protocol. For example: http://192.168.12.10.
Checks for x-forwarded-for and x_forwarded_for headers in case there were proxies between client and server.

getStringParam

protected String getStringParam(String name)

Returns parameter's value that is a String.

Parameters:

name - Parameter's name.

Returns:

Parameter's value.

Throws:

ClassCastException - if the value is not a String.

getId

protected String getId()

Gets the value of an Id for the current resource.

/sessions/1 -> Id: 1, identifier of 'session'
/sessions/1/users/2 -> Id: 2, identifier of 'users'

getId

protected String getId(String resource)

Gets the value of an Id given its resource's name.

/sessions/1 -> Id: 1, Resource: session
/sessions/1/users/2 -> Id: 2, Resource: user

renderPage

public void renderPage()
                throws IOException

Renders the predefined page.

Throws:

IOException - if the page doesn't exist.

renderPage

public void renderPage(String page)
                throws IOException

Renders some page within 'views' directory.

Parameters:

page - The page could have an extension or not. If it doesn't have an extension, the framework first looks for page.jsp, then .html or .htm extension.

Throws:

IOException - if the page doesn't exist.

renderPage

public void renderPage(String resource,
              String page)
                throws IOException

Renders a page from a resource.

Parameters:

resource - The name of the resource (bank, account, etc...). It must exists below /views directory.

page - The page can have an extension or not. If it doesn't have an extension, the framework first looks for page.jsp, then with .html or .htm extension.

Throws:

IOException - if the page doesn't exist.

serialize

public void serialize(Object object)

Serialize an object. Serializer class used to process the object can be known using ResponseHelper.getSerializer() method.

The serializer used depends on the extension received in the request.

Parameters:

object - Object to serialize.

getExtension

public String getExtension()

Gets the URL extension, if any.

Returns:

An extension or an empty String if there isn't anyone.

getSerializer

public String getSerializer()

Gets the Serializer class, if any.

Returns:

A String with the fully qualified name of the serializer class that will be used in case of needed to serialize an object in the response.