com.googlecode.jsonrpc4j

Class JsonRpcClient

java.lang.Object

com.googlecode.jsonrpc4j.JsonRpcClient

Direct Known Subclasses:

JsonRpcHttpClient, JsonRpcRestClient

public class JsonRpcClient
extends java.lang.Object

A JSON-RPC client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JsonRpcClient.RequestListener Provides access to the jackson ObjectNodes that represent the JSON-RPC requests and responses.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
JsonRpcClient() Creates a client that uses the default ObjectMapper to map to and from JSON and Java objects.
JsonRpcClient(com.fasterxml.jackson.databind.ObjectMapper mapper) Creates a client that uses the given ObjectMapper to map to and from JSON and Java objects.

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.node.ObjectNode	createRequest(java.lang.String methodName, java.lang.Object argument)
com.fasterxml.jackson.databind.node.ObjectNode	createRequest(java.lang.String methodName, java.lang.Object argument, java.lang.String id)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalJsonContent()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Returns the ObjectMapper that the client is using for JSON marshalling.
protected void	handleErrorResponse(com.fasterxml.jackson.databind.node.ObjectNode jsonObject)
protected boolean	hasError(com.fasterxml.jackson.databind.node.ObjectNode jsonObject)
void	invoke(java.lang.String methodName, java.lang.Object argument, java.io.OutputStream output) Invokes the given method on the remote service passing the given argument.
<T> T	invokeAndReadResponse(java.lang.String methodName, java.lang.Object argument, java.lang.Class<T> clazz, java.io.OutputStream output, java.io.InputStream input) Invokes the given method on the remote service passing the given arguments, a generated id and reads a response.
<T> T	invokeAndReadResponse(java.lang.String methodName, java.lang.Object argument, java.lang.Class<T> clazz, java.io.OutputStream output, java.io.InputStream input, java.lang.String id) Invokes the given method on the remote service passing the given arguments and reads a response.
java.lang.Object	invokeAndReadResponse(java.lang.String methodName, java.lang.Object argument, java.lang.reflect.Type returnType, java.io.OutputStream output, java.io.InputStream input) Invokes the given method on the remote service passing the given arguments, a generated id and reads a response.
void	invokeNotification(java.lang.String methodName, java.lang.Object argument, java.io.OutputStream output) Invokes the given method on the remote service passing the given argument without reading or expecting a return response.
<T> T	readResponse(java.lang.Class<T> clazz, java.io.InputStream input) Reads a JSON-PRC response from the server.
<T> T	readResponse(java.lang.Class<T> clazz, java.io.InputStream input, java.lang.String id) Reads a JSON-PRC response from the server.
java.lang.Object	readResponse(java.lang.reflect.Type returnType, java.io.InputStream input) Reads a JSON-PRC response from the server.
protected java.lang.Object	readResponse(java.lang.reflect.Type returnType, com.fasterxml.jackson.databind.JsonNode jsonObject)
void	setAdditionalJsonContent(java.util.Map<java.lang.String,java.lang.Object> additionalJsonContent)
void	setExceptionResolver(ExceptionResolver exceptionResolver)
void	setRequestIDGenerator(RequestIDGenerator requestIDGenerator) Set the RequestIDGenerator
void	setRequestListener(JsonRpcClient.RequestListener requestListener) Sets the JsonRpcClient.RequestListener.
void	writeNotification(java.lang.String methodName, java.lang.Object argument, java.io.OutputStream output) Writes a JSON-RPC notification to the given OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

JsonRpcClient

public JsonRpcClient()

Creates a client that uses the default ObjectMapper to map to and from JSON and Java objects.

JsonRpcClient

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

Creates a client that uses the given ObjectMapper to map to and from JSON and Java objects.

Parameters:

mapper - the ObjectMapper

Method Detail

getAdditionalJsonContent

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalJsonContent()

setAdditionalJsonContent

public void setAdditionalJsonContent(java.util.Map<java.lang.String,java.lang.Object> additionalJsonContent)

setRequestListener

public void setRequestListener(JsonRpcClient.RequestListener requestListener)

Sets the JsonRpcClient.RequestListener.

Parameters:

requestListener - the JsonRpcClient.RequestListener

setRequestIDGenerator

public void setRequestIDGenerator(RequestIDGenerator requestIDGenerator)

Set the RequestIDGenerator

Parameters:

requestIDGenerator - the RequestIDGenerator

invokeAndReadResponse

public <T> T invokeAndReadResponse(java.lang.String methodName,
                                   java.lang.Object argument,
                                   java.lang.Class<T> clazz,
                                   java.io.OutputStream output,
                                   java.io.InputStream input)
                            throws java.lang.Throwable

Invokes the given method on the remote service passing the given arguments, a generated id and reads a response.

Type Parameters:

T - the expected return type

Parameters:

methodName - the method to invoke

argument - the argument to pass to the method

clazz - the expected return type

output - the OutputStream to write to

input - the InputStream to read from

Returns:

the returned Object

Throws:

java.lang.Throwable - on error

See Also:

writeRequest(String, Object, OutputStream, String)

invokeAndReadResponse

public java.lang.Object invokeAndReadResponse(java.lang.String methodName,
                                              java.lang.Object argument,
                                              java.lang.reflect.Type returnType,
                                              java.io.OutputStream output,
                                              java.io.InputStream input)
                                       throws java.lang.Throwable

Invokes the given method on the remote service passing the given arguments, a generated id and reads a response.

Parameters:

methodName - the method to invoke

argument - the argument to pass to the method

returnType - the expected return type

output - the OutputStream to write to

input - the InputStream to read from

Returns:

the returned Object

Throws:

java.lang.Throwable - on error

See Also:

writeRequest(String, Object, OutputStream, String)

handleErrorResponse

protected void handleErrorResponse(com.fasterxml.jackson.databind.node.ObjectNode jsonObject)
                            throws java.lang.Throwable

Throws:

java.lang.Throwable

hasError

protected boolean hasError(com.fasterxml.jackson.databind.node.ObjectNode jsonObject)

invokeAndReadResponse

public <T> T invokeAndReadResponse(java.lang.String methodName,
                                   java.lang.Object argument,
                                   java.lang.Class<T> clazz,
                                   java.io.OutputStream output,
                                   java.io.InputStream input,
                                   java.lang.String id)
                            throws java.lang.Throwable

Invokes the given method on the remote service passing the given arguments and reads a response.

Type Parameters:

T - the expected return type

Parameters:

methodName - the method to invoke

argument - the argument to pass to the method

clazz - the expected return type

output - the OutputStream to write to

input - the InputStream to read from

id - id to send with the JSON-RPC request

Returns:

the returned Object

Throws:

java.lang.Throwable - if there is an error while reading the response

See Also:

writeRequest(String, Object, OutputStream, String)

invoke

public void invoke(java.lang.String methodName,
                   java.lang.Object argument,
                   java.io.OutputStream output)
            throws java.io.IOException

Invokes the given method on the remote service passing the given argument. An id is generated automatically. To read the response readResponse(Type, InputStream) must be subsequently called.

Parameters:

methodName - the method to invoke

argument - the arguments to pass to the method

output - the OutputStream to write to

Throws:

java.io.IOException - on error

See Also:

writeRequest(String, Object, OutputStream, String)

invokeNotification

public void invokeNotification(java.lang.String methodName,
                               java.lang.Object argument,
                               java.io.OutputStream output)
                        throws java.io.IOException

Invokes the given method on the remote service passing the given argument without reading or expecting a return response.

Parameters:

methodName - the method to invoke

argument - the argument to pass to the method

output - the OutputStream to write to

Throws:

java.io.IOException - on error

See Also:

writeRequest(String, Object, OutputStream, String)

readResponse

public <T> T readResponse(java.lang.Class<T> clazz,
                          java.io.InputStream input)
                   throws java.lang.Throwable

Reads a JSON-PRC response from the server. This blocks until a response is received.

Type Parameters:

T - the expected return type

Parameters:

clazz - the expected return type

input - the InputStream to read from

Returns:

the object returned by the JSON-RPC response

Throws:

java.lang.Throwable - on error

readResponse

public java.lang.Object readResponse(java.lang.reflect.Type returnType,
                                     java.io.InputStream input)
                              throws java.lang.Throwable

Reads a JSON-PRC response from the server. This blocks until a response is received.

Parameters:

returnType - the expected return type

input - the InputStream to read from

Returns:

the object returned by the JSON-RPC response

Throws:

java.lang.Throwable - on error

readResponse

public <T> T readResponse(java.lang.Class<T> clazz,
                          java.io.InputStream input,
                          java.lang.String id)
                   throws java.lang.Throwable

Reads a JSON-PRC response from the server. This blocks until a response is received. If an id is given, responses that do not correspond, are disregarded.

Type Parameters:

T - the expected return type

Parameters:

clazz - the expected return type

input - the InputStream to read from

id - The id used to compare the response with

Returns:

the object returned by the JSON-RPC response

Throws:

java.lang.Throwable - on error

createRequest

protected com.fasterxml.jackson.databind.node.ObjectNode createRequest(java.lang.String methodName,
                                                                       java.lang.Object argument)

createRequest

public com.fasterxml.jackson.databind.node.ObjectNode createRequest(java.lang.String methodName,
                                                                    java.lang.Object argument,
                                                                    java.lang.String id)

writeNotification

public void writeNotification(java.lang.String methodName,
                              java.lang.Object argument,
                              java.io.OutputStream output)
                       throws java.io.IOException

Writes a JSON-RPC notification to the given OutputStream.

Parameters:

methodName - the method to invoke

argument - the method argument

output - the OutputStream to write to

Throws:

java.io.IOException - on error

See Also:

writeRequest(String, Object, OutputStream, String)

readResponse

protected java.lang.Object readResponse(java.lang.reflect.Type returnType,
                                        com.fasterxml.jackson.databind.JsonNode jsonObject)
                                 throws java.lang.Throwable

Throws:

java.lang.Throwable

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns the ObjectMapper that the client is using for JSON marshalling.

Returns:

the ObjectMapper

setExceptionResolver

public void setExceptionResolver(ExceptionResolver exceptionResolver)

Parameters:

exceptionResolver - the exceptionResolver to set