com.googlecode.jsonrpc4j

Class JsonRpcMultiServer

java.lang.Object

com.googlecode.jsonrpc4j.JsonRpcBasicServer

com.googlecode.jsonrpc4j.JsonRpcServer

com.googlecode.jsonrpc4j.JsonRpcMultiServer

public class JsonRpcMultiServer
extends JsonRpcServer

A multiple service dispatcher that supports JSON-RPC "method" names that use dot-notation to select a server endpoint. For example:

 {
    "jsonrpc": "2.0",
    "method": "service.method",
    "params": {"foo", "bar"},
    "id": 1
 }
 

An example of using this class is: JsonRpcMultiServer rpcServer = new JsonRpcMultiServer(); rpcServer.addService("Foo", new FooService()) .addService("Bar", new BarService()); A client can then call a test(String, String) method on the Foo service like this:

 {
    "jsonrpc": "2.0",
    "method": "Foo.test",
    "params": ["some", "thing"],
    "id": 1
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_SEPARATOR

Fields inherited from class com.googlecode.jsonrpc4j.JsonRpcBasicServer

ACCEPT_ENCODING, CODE_OK, CONTENT_ENCODING, DATA, ERROR, ERROR_CODE, ERROR_MESSAGE, EXCEPTION_TYPE_NAME, httpStatusCodeProvider, ID, JSONRPC, JSONRPC_CONTENT_TYPE, METHOD, NAME, NULL, PARAMS, RESULT, VERSION, WEB_PARAM_ANNOTATION_CLASS_LOADER

Constructor Summary

Constructors

Constructor and Description
JsonRpcMultiServer()
JsonRpcMultiServer(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
JsonRpcMultiServer	addService(java.lang.String name, java.lang.Object handler)
JsonRpcMultiServer	addService(java.lang.String name, java.lang.Object handler, java.lang.Class<?> remoteInterface)
protected java.lang.Object	getHandler(java.lang.String serviceName) Get the handler (object) that should be invoked to execute the specified RPC method based on the specified service name.
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, stripping off the service name.
char	getSeparator()
protected java.lang.String	getServiceName(java.lang.String methodName) Get the service name from the methodNode.
void	setSeparator(char separator)

Methods inherited from class com.googlecode.jsonrpc4j.JsonRpcServer

handle, handle, setContentType

Methods inherited from class com.googlecode.jsonrpc4j.JsonRpcBasicServer

getRequestInterceptor, handleJsonNodeRequest, handleRequest, setAllowExtraParams, setAllowLessParams, setBackwardsCompatible, setConvertedParameterTransformer, setErrorResolver, setHttpStatusCodeProvider, setInvocationListener, setRequestInterceptor, setRethrowExceptions, setShouldLogInvocationErrors

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

JsonRpcMultiServer

public JsonRpcMultiServer()

JsonRpcMultiServer

public JsonRpcMultiServer(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

addService

public JsonRpcMultiServer addService(java.lang.String name,
                                     java.lang.Object handler)

addService

public JsonRpcMultiServer addService(java.lang.String name,
                                     java.lang.Object handler,
                                     java.lang.Class<?> remoteInterface)

getSeparator

public char getSeparator()

setSeparator

public void setSeparator(char separator)

getHandlerInterfaces

protected java.lang.Class<?>[] getHandlerInterfaces(java.lang.String serviceName)

Returns the handler's class or interfaces. The serviceName is used to look up a registered handler.

Overrides:

getHandlerInterfaces in class JsonRpcBasicServer

Parameters:

serviceName - the optional name of a service

Returns:

the class

getServiceName

protected java.lang.String getServiceName(java.lang.String methodName)

Get the service name from the methodNode. JSON-RPC methods with the form Service.method will result in "Service" being returned in this case.

Overrides:

getServiceName in class JsonRpcBasicServer

Parameters:

methodName - method name

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, stripping off the service name.

Overrides:

getMethodName in class JsonRpcBasicServer

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 based on the specified service name.

Overrides:

getHandler in class JsonRpcBasicServer

Parameters:

serviceName - the service name

Returns:

the handler to invoke the RPC call against