com.googlecode.jsonrpc4j

Interface HttpStatusCodeProvider

All Known Implementing Classes:

DefaultHttpStatusCodeProvider

public interface HttpStatusCodeProvider

A status code provider maps an HTTP status code to a JSON-RPC result code (e.g. -32000 -> 500).

From version 2.0 on the JSON-RPC specification is not explicitly documenting the mapping of result/error codes, so this provider can be used to configure application specific HTTP status codes for a given JSON-RPC error code.

The default implementation DefaultHttpStatusCodeProvider follows the rules defined in the JSON-RPC over HTTP document.

Method Summary

Modifier and Type	Method and Description
int	getHttpStatusCode(int resultCode) Returns an HTTP status code for the given response and result code.
java.lang.Integer	getJsonRpcCode(int httpStatusCode) Returns result code for the given HTTP status code

Method Detail

getHttpStatusCode

int getHttpStatusCode(int resultCode)

Returns an HTTP status code for the given response and result code.

Parameters:

resultCode - the result code of the current JSON-RPC method call. This is used to look up the HTTP status code.

Returns:

the int representation of the HTTP status code that should be used by the JSON-RPC response.

getJsonRpcCode

java.lang.Integer getJsonRpcCode(int httpStatusCode)

Returns result code for the given HTTP status code

Parameters:

httpStatusCode - the int representation of the HTTP status code that should be used by the JSON-RPC response.

Returns:

resultCode the result code of the current JSON-RPC method call. This is used to look up the HTTP status