net.sf.serfj

Class ResponseHelper

java.lang.Object

net.sf.serfj.ResponseHelper

public class ResponseHelper
extends Object

This class allows the developer to render the predefined page for an action, or to render the page she wants, or serialize an object to JSon, XML, or whatever as a response.

Author:

Eduardo Yáñez

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResponseHelper(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, net.sf.serfj.UrlInfo urlInfo, String viewsPath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doResponse()
protected void	forward()
javax.servlet.ServletContext	getContext() Gets ServletContext object related to this request.
String	getExtension() Gets the URL extension, if any.
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'
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
Object	getParam(String name) Gets a the value of a parameter that came in the URL or in the request.
Map<String,Object>	getParams() Gets a Map containing all the parameters in the query string, and all the attributes in the request.
javax.servlet.http.HttpServletRequest	getRequest() Gets HttpServletRequest object related to this request.
javax.servlet.http.HttpServletResponse	getResponse() Gets HttpServletResponse object related to this request.
String	getSerializer() Gets the Serializer class, if any.
void	notRenderPage(Method method) If the method is annotated with DoNotRenderPage, marks the response as not to render any page.
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.
protected void	sendFile()
protected void	serialize()
void	serialize(Object object) Serialize an object.
void	setAttachmentFilename(String filename) Sets the filename for the file that will be sent.
void	setContentType(String contentType) Sets the contentType in case there isn't another FileSerializer implementation.
void	setFile(File file) Sets the file to send to the client.
void	setFile(File file, String attachmentFilename, String contentType) Sets the file to send to the client.
protected void	writeFile(FileSerializer serializer)
protected void	writeObject(String contentType, String serialized)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseHelper

protected ResponseHelper(javax.servlet.ServletContext context,
              javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              net.sf.serfj.UrlInfo urlInfo,
              String viewsPath)

Constructor.

Method Detail

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Gets HttpServletResponse object related to this request.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Gets HttpServletRequest object related to this request.

getContext

public javax.servlet.ServletContext getContext()

Gets ServletContext object related to this request.

notRenderPage

public void notRenderPage(Method method)

If the method is annotated with DoNotRenderPage, marks the response as not to render any page. If there isn't object to serialize in the response and notRenderPage flag is set on, the framework will return a HTTP status code 204 (No content), else a page will be rendered.

Parameters:

method - Method to inspect.

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.

Parameters:

object - Object to serialize.

setFile

public void setFile(File file)

Sets the file to send to the client. If a file is set then the framework will try to read it and write it into the response using a FileSerializer.

Parameters:

file - The file.

setAttachmentFilename

public void setAttachmentFilename(String filename)

Sets the filename for the file that will be sent.

Parameters:

filename - File name.

setContentType

public void setContentType(String contentType)

Sets the contentType in case there isn't another FileSerializer implementation.

Parameters:

contentType - Content type for the response header.

setFile

public void setFile(File file,
           String attachmentFilename,
           String contentType)

Sets the file to send to the client. If a file is set then the framework will try to read it and write it into the response using a FileSerializer.

Parameters:

file - The file.

attachmentFilename - Name for the file that will be sent.

contentType - Content type for the response header.

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.

getParams

public Map<String,Object> getParams()

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

getParam

public Object getParam(String name)

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

getId

public 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

public 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

doResponse

protected void doResponse()
                   throws IOException,
                          javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

serialize

protected void serialize()
                  throws IOException

Throws:

IOException

sendFile

protected void sendFile()
                 throws IOException

Throws:

IOException

forward

protected void forward()
                throws IOException,
                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

writeObject

protected void writeObject(String contentType,
               String serialized)
                    throws IOException

Throws:

IOException

writeFile

protected void writeFile(FileSerializer serializer)
                  throws IOException

Throws:

IOException