com.googlecode.jsonrpc4j

Class JsonRpcHttpClient

java.lang.Object

com.googlecode.jsonrpc4j.JsonRpcClient

com.googlecode.jsonrpc4j.JsonRpcHttpClient

All Implemented Interfaces:

IJsonRpcClient

public class JsonRpcHttpClient
extends JsonRpcClient
implements IJsonRpcClient

A JSON-RPC client that uses the HTTP protocol.

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.jsonrpc4j.JsonRpcClient

JsonRpcClient.RequestListener

Constructor Summary

Constructors

Constructor and Description
JsonRpcHttpClient(com.fasterxml.jackson.databind.ObjectMapper mapper, java.net.URL serviceUrl, java.util.Map<java.lang.String,java.lang.String> headers) Creates the JsonRpcHttpClient bound to the given serviceUrl.
JsonRpcHttpClient(java.net.URL serviceUrl) Creates the JsonRpcHttpClient bound to the given serviceUrl.
JsonRpcHttpClient(java.net.URL serviceUrl, java.util.Map<java.lang.String,java.lang.String> headers) Creates the JsonRpcHttpClient bound to the given serviceUrl.

Method Summary

Modifier and Type	Method and Description
java.net.Proxy	getConnectionProxy()
int	getConnectionTimeoutMillis()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
int	getReadTimeoutMillis()
java.net.URL	getServiceUrl()
void	invoke(java.lang.String methodName, java.lang.Object argument) Invokes the given method with the given argument.
<T> T	invoke(java.lang.String methodName, java.lang.Object argument, java.lang.Class<T> clazz) Invokes the given method with the given arguments and returns an object of the given type, or null if void.
<T> T	invoke(java.lang.String methodName, java.lang.Object argument, java.lang.Class<T> clazz, java.util.Map<java.lang.String,java.lang.String> extraHeaders) Invokes the given method with the given arguments and returns an object of the given type, or null if void.
java.lang.Object	invoke(java.lang.String methodName, java.lang.Object argument, java.lang.reflect.Type returnType) Invokes the given method with the given arguments and returns an object of the given type, or null if void.
java.lang.Object	invoke(java.lang.String methodName, java.lang.Object argument, java.lang.reflect.Type returnType, java.util.Map<java.lang.String,java.lang.String> extraHeaders) Invokes the given method with the given arguments and returns an object of the given type, or null if void.
void	setConnectionProxy(java.net.Proxy connectionProxy)
void	setConnectionTimeoutMillis(int connectionTimeoutMillis)
void	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
void	setHostNameVerifier(javax.net.ssl.HostnameVerifier hostNameVerifier)
void	setReadTimeoutMillis(int readTimeoutMillis)
void	setServiceUrl(java.net.URL serviceUrl)
void	setSslContext(javax.net.ssl.SSLContext sslContext)

Methods inherited from class com.googlecode.jsonrpc4j.JsonRpcClient

createRequest, createRequest, getAdditionalJsonContent, getObjectMapper, handleErrorResponse, hasError, invoke, invokeAndReadResponse, invokeAndReadResponse, invokeAndReadResponse, invokeNotification, readResponse, readResponse, readResponse, readResponse, setAdditionalJsonContent, setExceptionResolver, setRequestListener, writeNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRpcHttpClient

public JsonRpcHttpClient(java.net.URL serviceUrl,
                         java.util.Map<java.lang.String,java.lang.String> headers)

Creates the JsonRpcHttpClient bound to the given serviceUrl. The headers provided in the headers map are added to every request made to the serviceUrl.

Parameters:

serviceUrl - the service end-point URL

headers - the headers

JsonRpcHttpClient

public JsonRpcHttpClient(com.fasterxml.jackson.databind.ObjectMapper mapper,
                         java.net.URL serviceUrl,
                         java.util.Map<java.lang.String,java.lang.String> headers)

Creates the JsonRpcHttpClient bound to the given serviceUrl. The headers provided in the headers map are added to every request made to the serviceUrl.

Parameters:

mapper - the ObjectMapper to use for json<->java conversion

serviceUrl - the service end-point URL

headers - the headers

JsonRpcHttpClient

public JsonRpcHttpClient(java.net.URL serviceUrl)

Creates the JsonRpcHttpClient bound to the given serviceUrl. The headers provided in the headers map are added to every request made to the serviceUrl.

Parameters:

serviceUrl - the service end-point URL

Method Detail

invoke

public void invoke(java.lang.String methodName,
                   java.lang.Object argument)
            throws java.lang.Throwable

Invokes the given method with the given argument.

Specified by:

invoke in interface IJsonRpcClient

Parameters:

methodName - the name of the method to invoke

argument - the argument to the method

Throws:

java.lang.Throwable - on error

invoke

public java.lang.Object invoke(java.lang.String methodName,
                               java.lang.Object argument,
                               java.lang.reflect.Type returnType)
                        throws java.lang.Throwable

Invokes the given method with the given arguments and returns an object of the given type, or null if void.

Specified by:

invoke in interface IJsonRpcClient

Parameters:

methodName - the name of the method to invoke

argument - the argument to the method

returnType - the return type

Returns:

the return value

Throws:

java.lang.Throwable - on error

invoke

public java.lang.Object invoke(java.lang.String methodName,
                               java.lang.Object argument,
                               java.lang.reflect.Type returnType,
                               java.util.Map<java.lang.String,java.lang.String> extraHeaders)
                        throws java.lang.Throwable

Invokes the given method with the given arguments and returns an object of the given type, or null if void.

Specified by:

invoke in interface IJsonRpcClient

Parameters:

methodName - the name of the method to invoke

argument - the argument to the method

returnType - the return type

extraHeaders - extra headers to add to the request

Returns:

the return value

Throws:

java.lang.Throwable - on error

invoke

public <T> T invoke(java.lang.String methodName,
                    java.lang.Object argument,
                    java.lang.Class<T> clazz)
             throws java.lang.Throwable

Invokes the given method with the given arguments and returns an object of the given type, or null if void.

Specified by:

invoke in interface IJsonRpcClient

Type Parameters:

T - the return type

Parameters:

methodName - the name of the method to invoke

argument - the argument to the method

clazz - the return type

Returns:

the return value

Throws:

java.lang.Throwable - on error

invoke

public <T> T invoke(java.lang.String methodName,
                    java.lang.Object argument,
                    java.lang.Class<T> clazz,
                    java.util.Map<java.lang.String,java.lang.String> extraHeaders)
             throws java.lang.Throwable

Invokes the given method with the given arguments and returns an object of the given type, or null if void.

Specified by:

invoke in interface IJsonRpcClient

Type Parameters:

T - the return type

Parameters:

methodName - the name of the method to invoke

argument - the argument to the method

clazz - the return type

extraHeaders - extra headers to add to the request

Returns:

the return value

Throws:

java.lang.Throwable - on error

getServiceUrl

public java.net.URL getServiceUrl()

Returns:

the serviceUrl

setServiceUrl

public void setServiceUrl(java.net.URL serviceUrl)

Parameters:

serviceUrl - the serviceUrl to set

getConnectionProxy

public java.net.Proxy getConnectionProxy()

Returns:

the connectionProxy

setConnectionProxy

public void setConnectionProxy(java.net.Proxy connectionProxy)

Parameters:

connectionProxy - the connectionProxy to set

getConnectionTimeoutMillis

public int getConnectionTimeoutMillis()

Returns:

the connectionTimeoutMillis

setConnectionTimeoutMillis

public void setConnectionTimeoutMillis(int connectionTimeoutMillis)

Parameters:

connectionTimeoutMillis - the connectionTimeoutMillis to set

getReadTimeoutMillis

public int getReadTimeoutMillis()

Returns:

the readTimeoutMillis

setReadTimeoutMillis

public void setReadTimeoutMillis(int readTimeoutMillis)

Parameters:

readTimeoutMillis - the readTimeoutMillis to set

getHeaders

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

Returns:

the headers

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Parameters:

headers - the headers to set

setSslContext

public void setSslContext(javax.net.ssl.SSLContext sslContext)

Parameters:

sslContext - the sslContext to set

setHostNameVerifier

public void setHostNameVerifier(javax.net.ssl.HostnameVerifier hostNameVerifier)

Parameters:

hostNameVerifier - the hostNameVerifier to set