JsonRpcBasicServer (jsonrpc4j 1.4.6 API)

java.lang.Object
- com.googlecode.jsonrpc4j.JsonRpcBasicServer

Direct Known Subclasses:

JsonRpcServer
```
public class JsonRpcBasicServer
extends java.lang.Object
```
A JSON-RPC request server reads JSON-RPC requests from an input stream and writes responses to an output stream. Can even run on Android system.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CODE_OK`
`static java.lang.String`	`DATA`
`static java.lang.String`	`ERROR`
`static java.lang.String`	`ERROR_CODE`
`static java.lang.String`	`ERROR_MESSAGE`
`static java.lang.String`	`EXCEPTION_TYPE_NAME`
`protected HttpStatusCodeProvider`	`httpStatusCodeProvider`
`static java.lang.String`	`ID`
`static java.lang.String`	`JSONRPC`
`static java.lang.String`	`JSONRPC_CONTENT_TYPE`
`static java.lang.String`	`METHOD`
`static java.lang.String`	`NAME`
`static java.lang.String`	`NULL`
`static java.lang.String`	`PARAMS`
`static java.lang.String`	`RESULT`
`static java.lang.String`	`VERSION`
`static java.lang.String`	`WEB_PARAM_ANNOTATION_CLASS_LOADER`

Constructor Summary

Constructors
Constructor and Description
`JsonRpcBasicServer(java.lang.Object handler)` Creates the server with a default `ObjectMapper` delegating all calls to the given `handler`.
`JsonRpcBasicServer(java.lang.Object handler, java.lang.Class<?> remoteInterface)` Creates the server with a default `ObjectMapper` delegating all calls to the given `handler` `Object` but only methods available on the `remoteInterface`.
`JsonRpcBasicServer(com.fasterxml.jackson.databind.ObjectMapper mapper, java.lang.Object handler)` Creates the server with the given `ObjectMapper` delegating all calls to the given `handler`.
`JsonRpcBasicServer(com.fasterxml.jackson.databind.ObjectMapper mapper, java.lang.Object handler, java.lang.Class<?> remoteInterface)` Creates the server with the given `ObjectMapper` delegating all calls to the given `handler` `Object` but only methods available on the `remoteInterface`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`getHandler(java.lang.String serviceName)` Get the handler (object) that should be invoked to execute the specified RPC method.
`protected java.lang.Class<?>[]`	`getHandlerInterfaces(java.lang.String serviceName)` Returns the handler's class or interfaces.
`protected java.lang.String`	`getMethodName(java.lang.String methodName)` Get the method name from the methodNode.
`RequestInterceptor`	`getRequestInterceptor()`
`protected java.lang.String`	`getServiceName(java.lang.String methodName)` Get the service name from the methodNode.
`protected ErrorResolver.JsonError`	`handleJsonNodeRequest(com.fasterxml.jackson.databind.JsonNode node, java.io.OutputStream output)` Handles the given `JsonNode` and writes the responses to the given `OutputStream`.
`int`	`handleRequest(java.io.InputStream input, java.io.OutputStream output)` Handles a single request from the given `InputStream`, that is to say that a single `JsonNode` is read from the stream and treated as a JSON-RPC request.
`void`	`setAllowExtraParams(boolean allowExtraParams)` Sets whether or not the server should allow superfluous parameters to method calls.
`void`	`setAllowLessParams(boolean allowLessParams)` Sets whether or not the server should allow less parameters than required to method calls (passing null for missing params).
`void`	`setBackwardsCompatible(boolean backwardsCompatible)` Sets whether or not the server should be backwards compatible to JSON-RPC 1.0.
`void`	`setConvertedParameterTransformer(ConvertedParameterTransformer convertedParameterTransformer)` Sets the `ConvertedParameterTransformer` instance that can be used to mutate the deserialized arguments passed to the service method during invocation.
`void`	`setErrorResolver(ErrorResolver errorResolver)` Sets the `ErrorResolver` used for resolving errors.
`void`	`setHttpStatusCodeProvider(HttpStatusCodeProvider httpStatusCodeProvider)` Sets the `HttpStatusCodeProvider` instance to use for HTTP error results.
`void`	`setInvocationListener(InvocationListener invocationListener)` Sets the `InvocationListener` instance that can be used to provide feedback for capturing method-invocation statistics.
`void`	`setRequestInterceptor(RequestInterceptor requestInterceptor)`
`void`	`setRethrowExceptions(boolean rethrowExceptions)` Sets whether or not the server should re-throw exceptions.
`void`	`setShouldLogInvocationErrors(boolean shouldLogInvocationErrors)` If true, then when errors arise in the invocation of JSON-RPC services, the error will be logged together with the underlying stack trace.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JSONRPC_CONTENT_TYPE
```
public static final java.lang.String JSONRPC_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - PARAMS
```
public static final java.lang.String PARAMS
```
    See Also:
    
    Constant Field Values
  - METHOD
```
public static final java.lang.String METHOD
```
    See Also:
    
    Constant Field Values
  - JSONRPC
```
public static final java.lang.String JSONRPC
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final java.lang.String ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE
```
public static final java.lang.String ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE
```
public static final java.lang.String ERROR_CODE
```
    See Also:
    
    Constant Field Values
  - DATA
```
public static final java.lang.String DATA
```
    See Also:
    
    Constant Field Values
  - RESULT
```
public static final java.lang.String RESULT
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_TYPE_NAME
```
public static final java.lang.String EXCEPTION_TYPE_NAME
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
  - CODE_OK
```
public static final int CODE_OK
```
    See Also:
    
    Constant Field Values
  - WEB_PARAM_ANNOTATION_CLASS_LOADER
```
public static final java.lang.String WEB_PARAM_ANNOTATION_CLASS_LOADER
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
  - NULL
```
public static final java.lang.String NULL
```
    See Also:
    
    Constant Field Values
  - httpStatusCodeProvider
```
protected HttpStatusCodeProvider httpStatusCodeProvider
```
- Constructor Detail
  - JsonRpcBasicServer
```
public JsonRpcBasicServer(com.fasterxml.jackson.databind.ObjectMapper mapper,
                          java.lang.Object handler)
```
    Creates the server with the given ObjectMapper delegating all calls to the given handler.
    
    Parameters:
    
    mapper - the ObjectMapper
    
    handler - the handler
  - JsonRpcBasicServer
```
public JsonRpcBasicServer(com.fasterxml.jackson.databind.ObjectMapper mapper,
                          java.lang.Object handler,
                          java.lang.Class<?> remoteInterface)
```
    Creates the server with the given ObjectMapper delegating all calls to the given handler Object but only methods available on the remoteInterface.
    
    Parameters:
    
    mapper - the ObjectMapper
    
    handler - the handler
    
    remoteInterface - the interface
  - JsonRpcBasicServer
```
public JsonRpcBasicServer(java.lang.Object handler,
                          java.lang.Class<?> remoteInterface)
```
    Creates the server with a default ObjectMapper delegating all calls to the given handler Object but only methods available on the remoteInterface.
    
    Parameters:
    
    handler - the handler
    
    remoteInterface - the interface
  - JsonRpcBasicServer
```
public JsonRpcBasicServer(java.lang.Object handler)
```
    Creates the server with a default ObjectMapper delegating all calls to the given handler.
    
    Parameters:
    
    handler - the handler
- Method Detail
  - getRequestInterceptor
```
public RequestInterceptor getRequestInterceptor()
```
  - setRequestInterceptor
```
public void setRequestInterceptor(RequestInterceptor requestInterceptor)
```
  - handleRequest
```
public int handleRequest(java.io.InputStream input,
                         java.io.OutputStream output)
                  throws java.io.IOException
```
    Handles a single request from the given InputStream, that is to say that a single JsonNode is read from the stream and treated as a JSON-RPC request. All responses are written to the given OutputStream.
    
    Parameters:
    
    input - the InputStream
    
    output - the OutputStream
    
    Returns:
    
    the error code, or 0 if none
    
    Throws:
    
    java.io.IOException - on error
  - getHandlerInterfaces
```
protected java.lang.Class<?>[] getHandlerInterfaces(java.lang.String serviceName)
```
    Returns the handler's class or interfaces. The variable serviceName is ignored in this class.
    
    Parameters:
    
    serviceName - the optional name of a service
    
    Returns:
    
    the class
  - handleJsonNodeRequest
```
protected ErrorResolver.JsonError handleJsonNodeRequest(com.fasterxml.jackson.databind.JsonNode node,
                                                        java.io.OutputStream output)
                                                 throws java.io.IOException
```
    Handles the given JsonNode and writes the responses to the given OutputStream.
    
    Parameters:
    
    node - the JsonNode
    
    output - the OutputStream
    
    Returns:
    
    the error code, or 0 if none
    
    Throws:
    
    java.io.IOException - on error
  - getServiceName
```
protected java.lang.String getServiceName(java.lang.String methodName)
```
    Get the service name from the methodNode. In this class, it is always null. Subclasses may parse the methodNode for service name.
    
    Parameters:
    
    methodName - the JsonNode for the method
    
    Returns:
    
    the name of the service, or null
  - getMethodName
```
protected java.lang.String getMethodName(java.lang.String methodName)
```
    Get the method name from the methodNode.
    
    Parameters:
    
    methodName - the JsonNode for the method
    
    Returns:
    
    the name of the method that should be invoked
  - getHandler
```
protected java.lang.Object getHandler(java.lang.String serviceName)
```
    Get the handler (object) that should be invoked to execute the specified RPC method. Used by subclasses to return handlers specific to a service.
    
    Parameters:
    
    serviceName - an optional service name
    
    Returns:
    
    the handler to invoke the RPC call against
  - setBackwardsCompatible
```
public void setBackwardsCompatible(boolean backwardsCompatible)
```
    Sets whether or not the server should be backwards compatible to JSON-RPC 1.0. This only includes the omission of the jsonrpc property on the request object, not the class hinting.
    
    Parameters:
    
    backwardsCompatible - the backwardsCompatible to set
  - setRethrowExceptions
```
public void setRethrowExceptions(boolean rethrowExceptions)
```
    Sets whether or not the server should re-throw exceptions.
    
    Parameters:
    
    rethrowExceptions - true or false
  - setAllowExtraParams
```
public void setAllowExtraParams(boolean allowExtraParams)
```
    Sets whether or not the server should allow superfluous parameters to method calls.
    
    Parameters:
    
    allowExtraParams - true or false
  - setAllowLessParams
```
public void setAllowLessParams(boolean allowLessParams)
```
    Sets whether or not the server should allow less parameters than required to method calls (passing null for missing params).
    
    Parameters:
    
    allowLessParams - the allowLessParams to set
  - setErrorResolver
```
public void setErrorResolver(ErrorResolver errorResolver)
```
    Sets the ErrorResolver used for resolving errors. Multiple ErrorResolvers can be used at once by using the MultipleErrorResolver.
    
    Parameters:
    
    errorResolver - the errorResolver to set
    
    See Also:
    
    MultipleErrorResolver
  - setInvocationListener
```
public void setInvocationListener(InvocationListener invocationListener)
```
    Sets the InvocationListener instance that can be used to provide feedback for capturing method-invocation statistics.
    
    Parameters:
    
    invocationListener - is the listener to set
  - setHttpStatusCodeProvider
```
public void setHttpStatusCodeProvider(HttpStatusCodeProvider httpStatusCodeProvider)
```
    Sets the HttpStatusCodeProvider instance to use for HTTP error results.
    
    Parameters:
    
    httpStatusCodeProvider - the status code provider to use for translating JSON-RPC error codes into HTTP status messages.
  - setConvertedParameterTransformer
```
public void setConvertedParameterTransformer(ConvertedParameterTransformer convertedParameterTransformer)
```
    Sets the ConvertedParameterTransformer instance that can be used to mutate the deserialized arguments passed to the service method during invocation.
    
    Parameters:
    
    convertedParameterTransformer - the transformer to set
  - setShouldLogInvocationErrors
```
public void setShouldLogInvocationErrors(boolean shouldLogInvocationErrors)
```
    If true, then when errors arise in the invocation of JSON-RPC services, the error will be logged together with the underlying stack trace. When false, no error will be logged. An alternative mechanism for logging invocation errors is to employ an implementation of InvocationListener.

Class JsonRpcBasicServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSONRPC_CONTENT_TYPE

PARAMS

METHOD

JSONRPC

ID

ERROR

ERROR_MESSAGE

ERROR_CODE

DATA

RESULT

EXCEPTION_TYPE_NAME

VERSION

CODE_OK

WEB_PARAM_ANNOTATION_CLASS_LOADER

NAME

NULL

httpStatusCodeProvider

Constructor Detail

JsonRpcBasicServer

JsonRpcBasicServer

JsonRpcBasicServer

JsonRpcBasicServer

Method Detail

getRequestInterceptor

setRequestInterceptor

handleRequest

getHandlerInterfaces

handleJsonNodeRequest

getServiceName

getMethodName

getHandler

setBackwardsCompatible

setRethrowExceptions

setAllowExtraParams

setAllowLessParams

setErrorResolver

setInvocationListener

setHttpStatusCodeProvider

setConvertedParameterTransformer

setShouldLogInvocationErrors