org.miniclient.util

Class ResponseUtil

java.lang.Object

org.miniclient.util.ResponseUtil

public final class ResponseUtil
extends Object

Note that we do not define a separate "Response" object. Response is simply a map of { String -> Object } with a special structure at the top level. Currently, we support a number of "predefined" top-level keys: "statusCode", "error", and "payload". These are extensible. That is, as long as the caller/service agree, arbitrary key->value pairs can be added. The caller will simply ignore the keys which it does not understand. Note that, currently, we do not allow both error and payload in a single response (although we do not really have a way of enforcing it). If both are included in a response, it should be treated as an error response and the payload should be ignored.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ERROR The value should be a map with keys, code and message.
static String	KEY_ERROR_CODE Int (or String) code.
static String	KEY_ERROR_MESSAGE Error message string.
static String	KEY_ERROR_TRACE Error stack trace, or other detailed error message.
static String	KEY_LOCATION HTTP Response header "Location".
static String	KEY_PAYLOAD Value is a generic object.
static String	KEY_RESOURCE Request URL.
static String	KEY_STATUSCODE Required? Int value of the response.statusCode.

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,Object>	buildResponse(String resource, int statusCode, Object payload)
static Map<String,Object>	buildResponse(String resource, int statusCode, Object payload, String location)
static Map<String,Object>	buildResponse(String resource, int statusCode, String errorCode, String errorMessage)
static Map<String,Object>	buildResponse(String resource, int statusCode, String errorCode, String errorMessage, String errorTrace)
static Map<String,String>	getError(Map<String,Object> response)
static Object	getPayload(Map<String,Object> response)
static int	getSatusCude(Map<String,Object> response)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_STATUSCODE

public static final String KEY_STATUSCODE

Required? Int value of the response.statusCode.

See Also:

Constant Field Values

KEY_PAYLOAD

public static final String KEY_PAYLOAD

Value is a generic object. Could be a scalar value, or a Map of {String -> Object}, representing an object.

See Also:

Constant Field Values

KEY_RESOURCE

public static final String KEY_RESOURCE

Request URL. This is not really needed since the caller always have this information. But, it can be convenient to have this in the response data structure at times...

See Also:

Constant Field Values

KEY_LOCATION

public static final String KEY_LOCATION

HTTP Response header "Location". To be used with 201 or other 3xx status codes.

See Also:

Constant Field Values

KEY_ERROR

public static final String KEY_ERROR

The value should be a map with keys, code and message.

See Also:

Constant Field Values

KEY_ERROR_CODE

public static final String KEY_ERROR_CODE

Int (or String) code. For convenience, we treat code as String.

See Also:

Constant Field Values

KEY_ERROR_MESSAGE

public static final String KEY_ERROR_MESSAGE

Error message string.

See Also:

Constant Field Values

KEY_ERROR_TRACE

public static final String KEY_ERROR_TRACE

Error stack trace, or other detailed error message.

See Also:

Constant Field Values

Method Detail

buildResponse

public static Map<String,Object> buildResponse(String resource,
                               int statusCode,
                               Object payload)

buildResponse

public static Map<String,Object> buildResponse(String resource,
                               int statusCode,
                               Object payload,
                               String location)

buildResponse

public static Map<String,Object> buildResponse(String resource,
                               int statusCode,
                               String errorCode,
                               String errorMessage)

buildResponse

public static Map<String,Object> buildResponse(String resource,
                               int statusCode,
                               String errorCode,
                               String errorMessage,
                               String errorTrace)

getSatusCude

public static int getSatusCude(Map<String,Object> response)

getError

public static Map<String,String> getError(Map<String,Object> response)

getPayload

public static Object getPayload(Map<String,Object> response)