de.gerdiproject.harvest.rest

Class HttpResponseFactory

java.lang.Object

de.gerdiproject.harvest.rest.HttpResponseFactory

public class HttpResponseFactory
extends Object

This factory creates common server responses to HTTP requests.

Author:

Robin Weiss

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	createAcceptedResponse(String message) Creates a HTTP-202 response for signalling that a process was started.
static javax.ws.rs.core.Response	createBadRequestResponse() Creates a HTTP-400 response with "N/A" as message.
static javax.ws.rs.core.Response	createBadRequestResponse(String message) Creates a HTTP-400 response with a specified message.
static javax.ws.rs.core.Response	createBusyResponse(String message, long retryInSeconds) Creates a response, replying that the service is not available at the moment.
static javax.ws.rs.core.Response	createFubarResponse() Creates a HTTP-500 response for the case that the service is broken beyond all repair.
static javax.ws.rs.core.Response	createInitResponse() Creates a HTTP-503 response that should be returned during the initialization state of the harvester.
static javax.ws.rs.core.Response	createKnownErrorResponse(String message) Creates a HTTP-500 response for a known but unexpected server error.
static javax.ws.rs.core.Response	createMethodNotAllowedResponse() Creates a HTTP-405 response.
static javax.ws.rs.core.Response	createOkResponse(Object entity) Creates a HTTP-200 message with a specified entity.
static javax.ws.rs.core.Response	createPlainTextOkResponse(String message) Creates a HTTP-200 plain text response.
static javax.ws.rs.core.Response	createServerErrorResponse() Creates an error message depending on the current state of the harvester.
static javax.ws.rs.core.Response	createSynchronousEventResponse(ISynchronousEvent<?> event) Creates a server response for an ISynchronousEvent.
static javax.ws.rs.core.Response	createUnknownErrorResponse() Creates a HTTP-500 response for unknown server errors.
static javax.ws.rs.core.Response	createValueResponse(javax.ws.rs.core.Response.Status statusCode, com.google.gson.JsonElement value) Creates a response with a specified status code and entity.

Methods inherited from class java.lang.Object

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

Method Detail

createInitResponse

public static javax.ws.rs.core.Response createInitResponse()

Creates a HTTP-503 response that should be returned during the initialization state of the harvester.

Returns:

a HTTP-503 explaining that the service is initializing

createBusyResponse

public static javax.ws.rs.core.Response createBusyResponse(String message,
                                                           long retryInSeconds)

Creates a response, replying that the service is not available at the moment. If available, a Retry-Again header is set with the remaining seconds of the process.

Parameters:

message - an error message, explaining what has failed

retryInSeconds - the number of seconds until the request should be attempted again, or -1 if this number is unknown

Returns:

a response, replying that the service is not available at the moment

createAcceptedResponse

public static javax.ws.rs.core.Response createAcceptedResponse(String message)

Creates a HTTP-202 response for signalling that a process was started.

Parameters:

message - a message, explaining what has started

Returns:

a HTTP-202 response for signalling that a process was started

createFubarResponse

public static javax.ws.rs.core.Response createFubarResponse()

Creates a HTTP-500 response for the case that the service is broken beyond all repair.

Returns:

a HTTP-500 response

createUnknownErrorResponse

public static javax.ws.rs.core.Response createUnknownErrorResponse()

Creates a HTTP-500 response for unknown server errors.

Returns:

a HTTP-500 response

createKnownErrorResponse

public static javax.ws.rs.core.Response createKnownErrorResponse(String message)

Creates a HTTP-500 response for a known but unexpected server error.

Parameters:

message - the message that is passed as an entity of the response

Returns:

a HTTP-500 response

createBadRequestResponse

public static javax.ws.rs.core.Response createBadRequestResponse()

Creates a HTTP-400 response with "N/A" as message.

Returns:

a HTTP-400 response with "N/A" as message

createBadRequestResponse

public static javax.ws.rs.core.Response createBadRequestResponse(String message)

Creates a HTTP-400 response with a specified message.

Parameters:

message - the message that is passed as an entity of the response

Returns:

a HTTP-400 response with a specified message

createMethodNotAllowedResponse

public static javax.ws.rs.core.Response createMethodNotAllowedResponse()

Creates a HTTP-405 response.

Returns:

a HTTP-405 response

createOkResponse

public static javax.ws.rs.core.Response createOkResponse(Object entity)

Creates a HTTP-200 message with a specified entity.

Parameters:

entity - the entity that is passed along with the response

Returns:

a HTTP-200 message with a specified entity

createPlainTextOkResponse

public static javax.ws.rs.core.Response createPlainTextOkResponse(String message)

Creates a HTTP-200 plain text response.

Parameters:

message - the response text

Returns:

a plain text HTTP-200

createValueResponse

public static javax.ws.rs.core.Response createValueResponse(javax.ws.rs.core.Response.Status statusCode,
                                                            com.google.gson.JsonElement value)

Creates a response with a specified status code and entity.

Parameters:

statusCode - the HTTP return code of the response

value - the entity that is passed along with the response

Returns:

a response with a specified status code and entity

createServerErrorResponse

public static javax.ws.rs.core.Response createServerErrorResponse()

Creates an error message depending on the current state of the harvester.

Returns:

an error message that befits the current state of the harvester

createSynchronousEventResponse

public static javax.ws.rs.core.Response createSynchronousEventResponse(ISynchronousEvent<?> event)

Creates a server response for an ISynchronousEvent. During initialization, these events may not be registered yet, which is handled by replying with an HTTP-503 code.

Parameters:

event - the synchronous event that is to be dispatched

Returns:

a HTTP-200 response with the event return value as plain text entity, or a HTTP-500 response if the service is broken beyond repair, or a HTTP-503 response if the service is initializing