org.dmonix.servlet

Interface ResponseBuilder

All Known Implementing Classes:

JSONServlet

public interface ResponseBuilder

Interface for building the response to be sent to the client.

Since:

1.0

Author:

Peter Nerg

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.gson.Gson	gson

Method Summary

Modifier and Type	Method and Description
default Response	AcceptedResponse() Creates an empty response with only 202 - Accepted
default Response	CreatedResponse() Creates an empty response with only 201 - Created
default Response	EmptyResponse(int responseCode) Creates an empty response with only a response code
default Response	ErrorResponse(int responseCode, String message) Creates an error with a provided error code
default Response	ErrorResponse(Throwable throwable) Creates an error response with a internal error code.
default Response	ErrorResponseMissingPath() Creates an error with code 400 and the message that the path is missing
default Response	ErrorResponseNotFound(String message) Creates an error with a 404 - Not found
default Response	ErrorResponseResourceAlreadyExists(String path) Creates an error with code 403 and the message that the path already exists.
default Response	ErrorResponseUnsupportedOperation() Creates an error with code 405 stating the operation is not supported.
default Response	ObjectResponse(Object object) Creates a response where the provided object will be converted to json.
default Response	ObjectResponse(Object object, String charEncoding) Creates a response where the provided object will be converted to json.
default void	writeResponse(javax.servlet.http.HttpServletResponse resp, Response response) Write the response to the client.
default void	writeResponse(javax.servlet.http.HttpServletResponse resp, Try<Response> response) Write the response to the client.

Field Detail

gson

static final com.google.gson.Gson gson

Method Detail

EmptyResponse

default Response EmptyResponse(int responseCode)

Creates an empty response with only a response code

Parameters:

responseCode - The HTTP response code

Returns:

The response object

AcceptedResponse

default Response AcceptedResponse()

Creates an empty response with only 202 - Accepted

Returns:

The response object

CreatedResponse

default Response CreatedResponse()

Creates an empty response with only 201 - Created

Returns:

The response object

ObjectResponse

default Response ObjectResponse(Object object)

Creates a response where the provided object will be converted to json.
Will by default use the charset UTF-8

Parameters:

object - The response object/message

Returns:

The response object

ObjectResponse

default Response ObjectResponse(Object object,
                                String charEncoding)

Creates a response where the provided object will be converted to json.

Parameters:

object - The response object/message

charEncoding - The character encoding to use

Returns:

The response object

ErrorResponse

default Response ErrorResponse(Throwable throwable)

Creates an error response with a internal error code.
Will in practice create an ErrorResponse with the message from the exception.

Parameters:

throwable - The underlying issue

Returns:

The response object

See Also:

ErrorResponse(int, String)

ErrorResponse

default Response ErrorResponse(int responseCode,
                               String message)

Creates an error with a provided error code

Parameters:

responseCode - The HTTP response code

message - The message

Returns:

The response object

ErrorResponseNotFound

default Response ErrorResponseNotFound(String message)

Creates an error with a 404 - Not found

Parameters:

message - The message

Returns:

The response object

ErrorResponseMissingPath

default Response ErrorResponseMissingPath()

Creates an error with code 400 and the message that the path is missing

Returns:

The response object

ErrorResponseResourceAlreadyExists

default Response ErrorResponseResourceAlreadyExists(String path)

Creates an error with code 403 and the message that the path already exists.

Parameters:

path - The path which already existed

Returns:

The response object

ErrorResponseUnsupportedOperation

default Response ErrorResponseUnsupportedOperation()

Creates an error with code 405 stating the operation is not supported.

Returns:

The response object

writeResponse

default void writeResponse(javax.servlet.http.HttpServletResponse resp,
                           Try<Response> response)
                    throws IOException

Write the response to the client.

Parameters:

resp - The HTTP servlet response object

response - The response object, either successful or failed

Throws:

IOException

writeResponse

default void writeResponse(javax.servlet.http.HttpServletResponse resp,
                           Response response)
                    throws IOException

Write the response to the client.

Parameters:

resp - The HTTP servlet response object

response - The response object to be sent to the client

Throws:

IOException