BatchRequestBuilder (inveed-jsonrpc-client 0.0.1 API)

java.lang.Object
- net.inveed.jsonrpc.client.builder.AbstractBuilder
- - net.inveed.jsonrpc.client.builder.BatchRequestBuilder<K,V>

```
public class BatchRequestBuilder<K,V>
extends AbstractBuilder
```
Fluent builder of batch JSON-RPC requests. It provides facility to create a list of requests, set expected response types, execute the JSON-RPC request and process the JSON-RPC response. Return type is a map of responses (Java objects) by request ids. In cases of errors it throws JsonRpcBatchException with detailed status of success and failed requests. It delegates JSON processing to Jackson ObjectMapper and actual request performing to Transport.

Field Summary
- Fields inherited from class net.inveed.jsonrpc.client.builder.AbstractBuilder
  ERROR, ID, JSONRPC, mapper, METHOD, PARAMS, RESULT, transport, VERSION_2_0

Constructor Summary

Constructors
Constructor and Description
`BatchRequestBuilder(Transport transport, com.fasterxml.jackson.databind.ObjectMapper mapper)` Creates a new batch request builder in an initial state
`BatchRequestBuilder(Transport transport, com.fasterxml.jackson.databind.ObjectMapper mapper, List<com.fasterxml.jackson.databind.node.ObjectNode> requests, Map<Object,com.fasterxml.jackson.databind.JavaType> returnTypes, Class<K> keysType, com.fasterxml.jackson.databind.JavaType returnType)` Creates a new batch request builder as a part of a chain

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchRequestBuilder<K,V>`	`add(int id, String method, Map<String,?> params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(int id, String method, Map<String,?> params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(int id, String method, Map<String,?> params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`BatchRequestBuilder<K,V>`	`add(int id, String method, Object... params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(int id, String method, Object[] params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(int id, String method, Object[] params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Map<String,?> params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Map<String,?> params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Map<String,?> params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Object... params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Object[] params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(long id, String method, Object[] params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`BatchRequestBuilder<K,V>`	`add(String method, Map<String,?> params)` Adds a new notification request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(String method, Object... params)` Adds a new notification request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Map<String,?> params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Map<String,?> params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Map<String,?> params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Object... params)` Adds a new request without specifying a return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Object[] params, Class<?> responseType)` Adds a new request with a return type
`BatchRequestBuilder<K,V>`	`add(String id, String method, Object[] params, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)` Adds a new request with a complex return type
`Map<K,V>`	`execute()` Validates, executes the request and process response
`<NK> BatchRequestBuilder<NK,V>`	`keysType(Class<NK> keysClass)` Sets type of request keys.
`<NV> BatchRequestBuilder<K,NV>`	`returnType(Class<NV> valuesClass)` Sets an expected response type of requests.
`<NV> BatchRequestBuilder<K,NV>`	`returnType(com.fasterxml.jackson.core.type.TypeReference<NV> tr)` Sets an expected complex response type of requests.

Methods inherited from class net.inveed.jsonrpc.client.builder.AbstractBuilder
arrayParams, objectParams, request

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

Constructor Detail

BatchRequestBuilder
```
public BatchRequestBuilder(Transport transport,
                           com.fasterxml.jackson.databind.ObjectMapper mapper)
```
Creates a new batch request builder in an initial state

Parameters:

transport - transport for request performing

mapper - mapper for JSON processing

BatchRequestBuilder

public BatchRequestBuilder(Transport transport,
                           com.fasterxml.jackson.databind.ObjectMapper mapper,
                           List<com.fasterxml.jackson.databind.node.ObjectNode> requests,
                           Map<Object,com.fasterxml.jackson.databind.JavaType> returnTypes,
                           Class<K> keysType,
                           com.fasterxml.jackson.databind.JavaType returnType)

Creates a new batch request builder as a part of a chain

Parameters:: transport - transport for request performing; mapper - mapper for JSON processing; requests - new requests; returnTypes - new return types; keysType - new key type; returnType - new values type

Method Detail

add

public BatchRequestBuilder<K,V> add(long id,
                                    String method,
                                    Object... params)

Adds a new request without specifying a return type

Parameters:: id - request id as a long value; method - request method; params - request params as an array
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(int id,
                                    String method,
                                    Object... params)

Adds a new request without specifying a return type

Parameters:: id - request id as an int value; method - request method; params - request params as an array
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(String id,
                                    String method,
                                    Object... params)

Adds a new request without specifying a return type

Parameters:: id - request id as a text value; method - request method; params - request params as an array
Returns:: the current builder

add
```
public BatchRequestBuilder<K,V> add(String method,
                                    Object... params)
```
Adds a new notification request without specifying a return type

Parameters:

method - request method

params - request params as an array

Returns:

the current builder

add

public BatchRequestBuilder<K,V> add(long id,
                                    String method,
                                    Map<String,?> params)

Adds a new request without specifying a return type

Parameters:: id - request id as a long value; method - request method; params - request params as a map of parameter names to values
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(int id,
                                    String method,
                                    Map<String,?> params)

Adds a new request without specifying a return type

Parameters:: id - request id as an int value; method - request method; params - request params as a map of parameter names to values
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(String id,
                                    String method,
                                    Map<String,?> params)

Adds a new request without specifying a return type

Parameters:: id - request id as a text value; method - request method; params - request params as a map of parameter names to values
Returns:: the current builder

add
```
public BatchRequestBuilder<K,V> add(String method,
                                    Map<String,?> params)
```
Adds a new notification request without specifying a return type

Parameters:

method - request method

params - request params as an array

Returns:

the current builder

add

public BatchRequestBuilder<K,V> add(long id,
                                    String method,
                                    Object[] params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as a long value; method - request method; params - request params as an array; responseType - expected response type
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(int id,
                                    String method,
                                    Object[] params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as an int value; method - request method; params - request params as an array; responseType - expected response type
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(String id,
                                    String method,
                                    Object[] params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as a text value; method - request method; params - request params as an array; responseType - expected response type
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(long id,
                                    String method,
                                    Map<String,?> params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as a long value; method - request method; params - request params as a map of parameter names to values; responseType - expected response type
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(int id,
                                    String method,
                                    Map<String,?> params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as an int value; method - request method; params - request params as a map of parameter names to values; responseType - expected response type
Returns:: the current builder

add

public BatchRequestBuilder<K,V> add(String id,
                                    String method,
                                    Map<String,?> params,
                                    Class<?> responseType)

Adds a new request with a return type

Parameters:: id - request id as a text value; method - request method; params - request params as a map of parameter names to values; responseType - expected response type
Returns:: the current builder