com.communote.plugins.api.rest.v30.response

Class ResponseHelper

java.lang.Object

com.communote.plugins.api.rest.v30.response.ResponseHelper

public final class ResponseHelper
extends Object

The response helper contains all functionality to build the response.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static org.codehaus.jackson.map.ObjectMapper	MAPPER

Constructor Summary

Constructors

Constructor and Description
ResponseHelper()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	buildErrorResponse(ApiResult<Object> apiResult, javax.ws.rs.core.Response.ResponseBuilder responseBuilder, javax.servlet.http.HttpServletRequest httpServletRequest) Build the error response.
static javax.ws.rs.core.Response	buildErrorResponse(Status status, javax.ws.rs.core.Request request) Build an error response from the error describing status object and the current request
static <T> javax.ws.rs.core.Response	buildResponse(T result, String message, javax.ws.rs.core.Request request, ApiResult.ResultStatus status, Reason... errors) Get the success response from resource
static <T> javax.ws.rs.core.Response	buildResponse(T result, String message, javax.ws.rs.core.Request request, ApiResult.ResultStatus status, javax.ws.rs.core.Response.Status responseStatus) Get the success response from resource
static <T> javax.ws.rs.core.Response	buildSuccessResponse(List<T> result, javax.ws.rs.core.Request request) Get the success response from resource list
static <T> javax.ws.rs.core.Response	buildSuccessResponse(List<T> result, javax.ws.rs.core.Request request, Map<String,Object> metaData) Get the success response from resource list with specific meta data
static <T> javax.ws.rs.core.Response	buildSuccessResponse(T result, javax.ws.rs.core.Request request) Get the success response from resource
static <T> javax.ws.rs.core.Response	buildSuccessResponse(T result, javax.ws.rs.core.Request request, String messageKey, Object... arguments) Get the success response from resource
static <T> javax.ws.rs.core.Response	buildSuccessResponse(T result, String message, javax.ws.rs.core.Request request) Get the success response from resource
protected javax.ws.rs.core.Response	buildValidationErrorResult(List<ApiResultError> errors, javax.ws.rs.core.Request request) returns response with the 400 (bad request) status code, caused by validation errors
static int	getHttpCodeFromErrorCode(String errorCode) Convert one of the ErrorCodes constants to a matching HTTP status code.
protected static <T> String	getText(javax.ws.rs.core.Request request, String messageKey, Object... arguments) Get text of message key with consideration of locale and replace arguments

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

public static final org.codehaus.jackson.map.ObjectMapper MAPPER

Constructor Detail

ResponseHelper

public ResponseHelper()

Method Detail

buildErrorResponse

public static javax.ws.rs.core.Response buildErrorResponse(ApiResult<Object> apiResult,
                                                           javax.ws.rs.core.Response.ResponseBuilder responseBuilder,
                                                           javax.servlet.http.HttpServletRequest httpServletRequest)
                                                    throws ResponseBuildException,
                                                           ExtensionNotSupportedException

Build the error response.

Parameters:

apiResult - ApiResult

responseBuilder - Response.ResponseBuilder

httpServletRequest - HttpServletRequest

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildErrorResponse

public static javax.ws.rs.core.Response buildErrorResponse(Status status,
                                                           javax.ws.rs.core.Request request)
                                                    throws ResponseBuildException,
                                                           ExtensionNotSupportedException

Build an error response from the error describing status object and the current request

Parameters:

status - the status object holding the details about the occurred error

request - the current request

Returns:

the response

Throws:

ResponseBuildException - in case of an error while building the response

ExtensionNotSupportedException - in case the extension describing the response content-type is not supported

buildResponse

public static <T> javax.ws.rs.core.Response buildResponse(T result,
                                                          String message,
                                                          javax.ws.rs.core.Request request,
                                                          ApiResult.ResultStatus status,
                                                          Reason... errors)
                                                   throws ResponseBuildException,
                                                          ExtensionNotSupportedException

Get the success response from resource

Type Parameters:

T - type of resource

Parameters:

result - resource

message - message setted in the request

request - Request

status - The status to set.

errors - Optional errors, which should be send back.

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildResponse

public static <T> javax.ws.rs.core.Response buildResponse(T result,
                                                          String message,
                                                          javax.ws.rs.core.Request request,
                                                          ApiResult.ResultStatus status,
                                                          javax.ws.rs.core.Response.Status responseStatus)
                                                   throws ResponseBuildException,
                                                          ExtensionNotSupportedException

Get the success response from resource

Type Parameters:

T - type of resource

Parameters:

result - resource

message - message setted in the request

request - Request

status - The status to set.

responseStatus - Status of the response who is required for the status code.

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildSuccessResponse

public static <T> javax.ws.rs.core.Response buildSuccessResponse(List<T> result,
                                                                 javax.ws.rs.core.Request request)
                                                          throws ResponseBuildException,
                                                                 ExtensionNotSupportedException

Get the success response from resource list

Type Parameters:

T - type of resource

Parameters:

result - list of resources

request - Request

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildSuccessResponse

public static <T> javax.ws.rs.core.Response buildSuccessResponse(List<T> result,
                                                                 javax.ws.rs.core.Request request,
                                                                 Map<String,Object> metaData)
                                                          throws ResponseBuildException,
                                                                 ExtensionNotSupportedException

Get the success response from resource list with specific meta data

Type Parameters:

T - type of resource

Parameters:

result - list of resources

request - Request

metaData - map with meta data to extend the result

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildSuccessResponse

public static <T> javax.ws.rs.core.Response buildSuccessResponse(T result,
                                                                 javax.ws.rs.core.Request request)
                                                          throws ResponseBuildException,
                                                                 ExtensionNotSupportedException

Get the success response from resource

Type Parameters:

T - type of resource

Parameters:

result - resource

request - Request

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildSuccessResponse

public static <T> javax.ws.rs.core.Response buildSuccessResponse(T result,
                                                                 javax.ws.rs.core.Request request,
                                                                 String messageKey,
                                                                 Object... arguments)
                                                          throws ResponseBuildException,
                                                                 ExtensionNotSupportedException

Get the success response from resource

Type Parameters:

T - type of resource

Parameters:

result - resource

messageKey - key of message

request - Request

arguments - elements witch should replace in message text

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

buildSuccessResponse

public static <T> javax.ws.rs.core.Response buildSuccessResponse(T result,
                                                                 String message,
                                                                 javax.ws.rs.core.Request request)
                                                          throws ResponseBuildException,
                                                                 ExtensionNotSupportedException

Get the success response from resource

Type Parameters:

T - type of resource

Parameters:

result - resource

message - message setted in the request

request - Request

Returns:

Response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

getHttpCodeFromErrorCode

public static final int getHttpCodeFromErrorCode(String errorCode)

Convert one of the ErrorCodes constants to a matching HTTP status code. In case there is no match 500 will be returned.

Parameters:

errorCode - the code to convert

Returns:

the HTTP status codes

getText

protected static <T> String getText(javax.ws.rs.core.Request request,
                                    String messageKey,
                                    Object... arguments)

Get text of message key with consideration of locale and replace arguments

Type Parameters:

T - type of resource

Parameters:

request - Request

messageKey - key of message

arguments - elements witch should replace in message text

Returns:

text of messageKey

buildValidationErrorResult

protected javax.ws.rs.core.Response buildValidationErrorResult(List<ApiResultError> errors,
                                                               javax.ws.rs.core.Request request)
                                                        throws ResponseBuildException,
                                                               ExtensionNotSupportedException

returns response with the 400 (bad request) status code, caused by validation errors

Parameters:

errors - list of the validation errors

request - Request

Returns:

appropriate response

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported