com.communote.server.web.commons.helper

Class JsonRequestHelper

java.lang.Object

com.communote.server.web.commons.helper.JsonRequestHelper

public class JsonRequestHelper
extends Object

Util to work with JSON requests and responses.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
JsonRequestHelper()

Method Summary

Modifier and Type	Method and Description
static org.codehaus.jackson.node.ObjectNode	createJsonErrorResponse(String message) Create a JSON error response object
static org.codehaus.jackson.node.ObjectNode	createJsonSuccessResponse(String message, org.codehaus.jackson.node.ObjectNode result) Create a JSON success response object
static boolean	isJsonResponseRequested(javax.servlet.http.HttpServletRequest request) Test whether a JSON response should be returned by inspecting the Accept header.
static void	writeJsonErrorResponse(javax.servlet.http.HttpServletResponse response, String errorMessage) Write a JSON error to the response.
static void	writeJsonErrorResponseQuietly(javax.servlet.http.HttpServletResponse response, String errorMessage) Write a JSON error to the response without throwing exceptions in case of errors.
static void	writeJsonResponse(javax.servlet.http.HttpServletResponse response, org.codehaus.jackson.node.ObjectNode json) Write a JSON object to the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRequestHelper

public JsonRequestHelper()

Method Detail

createJsonErrorResponse

public static org.codehaus.jackson.node.ObjectNode createJsonErrorResponse(String message)

Create a JSON error response object

Parameters:

message - a message to add to the response, can be null

Returns:

the JSON

createJsonSuccessResponse

public static org.codehaus.jackson.node.ObjectNode createJsonSuccessResponse(String message,
                                                                             org.codehaus.jackson.node.ObjectNode result)

Create a JSON success response object

Parameters:

message - a message to add to the response, can be null

result - a result object to add to the response, can be null

Returns:

the JSON

isJsonResponseRequested

public static boolean isJsonResponseRequested(javax.servlet.http.HttpServletRequest request)

Test whether a JSON response should be returned by inspecting the Accept header.

Parameters:

request - the request

Returns:

true if a JSON response is to be returned

writeJsonResponse

public static void writeJsonResponse(javax.servlet.http.HttpServletResponse response,
                                     org.codehaus.jackson.node.ObjectNode json)
                              throws IOException

Write a JSON object to the response.

Parameters:

response - the response

json - the JSON object to write

Throws:

IOException - in case of an exception while serializing the json object

writeJsonErrorResponse

public static void writeJsonErrorResponse(javax.servlet.http.HttpServletResponse response,
                                          String errorMessage)
                                   throws IOException

Write a JSON error to the response.

Parameters:

response - the response

errorMessage - the message to send

Throws:

IOException - in case of an exception while serializing the json object

writeJsonErrorResponseQuietly

public static void writeJsonErrorResponseQuietly(javax.servlet.http.HttpServletResponse response,
                                                 String errorMessage)

Write a JSON error to the response without throwing exceptions in case of errors.

Parameters:

response - the response

errorMessage - the message to send