RpcQueryNode (jNano 2.20.0 API)

java.lang.Object
- uk.oczadly.karl.jnano.rpc.RpcQueryNode

```
public class RpcQueryNode
extends Object
```
This class is used to connect to an external Nano node endpoint, to which requests and queries can be sent.
To use this class, set the endpoint address and port in the constructor, or use the provided RpcQueryNode.Builder class for additional configuration parameters). To make a request, first create a request object that inherits from RpcRequest, specifying any parameters within the request's constructor. Now pass this request object to one of the processRequest methods within this class, and use the returned RpcResponse object to access the response data.

The asynchronous processing methods (processRequestAsync) support the options to take a callback object (QueryCallback) as a parameter, or to return a Future object. Asynchronous requests will be processed on threads issued by the ExecutorService specified within this class.

Below is an example of a synchronous query which creates a new account from a provided wallet ID:
```
  try {
      // Configure a connection to localhost:7076
      RpcQueryNode node = new RpcQueryNode();

      // Construct the request (and pass query arguments)
      RequestAccountCreate request = new RequestAccountCreate(
              "B4ECF585D887B590907949C41F73BB11AA0BD4FD98563CC5D810EF26FAAD948E"); // Wallet ID

      // Send request to the node synchronously and retrieve response
      ResponseAccount response = node.processRequest(request);

      // Output new account to console
      System.out.println("New account: " + response.getAccountAddress());
  } catch (RpcException | IOException e) {
      e.printStackTrace();
  }
 
```
See Also:

RpcServiceProviders, RpcQueryNode.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RpcQueryNode.Builder
This builder class allows you to customize and create new instances of the RpcQueryNode class.

Nested Classes
Modifier and Type	Class	Description
`static class`	`RpcQueryNode.Builder`	This builder class allows you to customize and create new instances of the `RpcQueryNode` class.

Constructor Summary

Constructors
Constructor	Description
`RpcQueryNode()`	Constructs a new RPC communications object via `http` on localhost (`::1`) on port .
`RpcQueryNode(int port)`	Constructs a new RPC communications object via `http` on localhost (`::1`) on the specified port.
`RpcQueryNode(String address, int port)`	Constructs a new RPC communications object via `http` on the specified host address and port.
`RpcQueryNode(URL url)`	Constructs a new RPC communications object via the specified protocol, host address and port.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RpcQueryNode.Builder`	`builder()`	Returns a new builder object for constructing `RpcQueryNode` objects.
`int`	`getDefaultTimeout()`
`ExecutorService`	`getExecutorService()`
`RpcRequestExecutor`	`getRequestExecutor()`
`RpcRequestSerializer`	`getRequestSerializer()`
`RpcResponseDeserializer`	`getResponseDeserializer()`
`<Q extends RpcRequest<R>,R extends RpcResponse> R`	`processRequest(Q request)`	Sends a query request to the node via RPC with the default timeout.
`<Q extends RpcRequest<R>,R extends RpcResponse> R`	`processRequest(Q request, int timeout)`	Sends a query request to the node via RPC with the specified timeout.
`<Q extends RpcRequest<R>,R extends RpcResponse> Future<R>`	`processRequestAsync(Q request)`	Sends an asynchronous query request to the node via RPC with the default timeout.
`<Q extends RpcRequest<R>,R extends RpcResponse> Future<R>`	`processRequestAsync(Q request, int timeout)`	Sends an asynchronous query request to the node via RPC with the specified timeout.
`<Q extends RpcRequest<R>,R extends RpcResponse> Future<R>`	`processRequestAsync(Q request, int timeout, QueryCallback<? super Q,? super R> callback)`	Sends an asynchronous query request to the node via RPC with the specified timeout.
`<Q extends RpcRequest<R>,R extends RpcResponse> Future<R>`	`processRequestAsync(Q request, QueryCallback<? super Q,? super R> callback)`	Sends an asynchronous query request to the node via RPC with the default timeout.
`String`	`processRequestRaw(String jsonRequest, int timeout)`	Sends a raw JSON query to the RPC server, and then returns the raw JSON response.
`<R extends RpcResponse> R`	`processRequestRaw(String jsonRequest, int timeout, Class<R> responseClass)`	Sends a raw JSON query to the RPC server, and then returns an object in the specified class containing the deserialized response data.

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

- Constructor Detail
  - RpcQueryNode
```
public RpcQueryNode()
```
    Constructs a new RPC communications object via http on localhost (::1) on port .
  - RpcQueryNode
```
public RpcQueryNode(int port)
```
    Constructs a new RPC communications object via http on localhost (::1) on the specified port.
    
    Parameters:
    
    port - the endpoint port number
    
    See Also:
    
    RpcQueryNode.Builder
  - RpcQueryNode
```
public RpcQueryNode(String address,
                    int port)
```
    Constructs a new RPC communications object via http on the specified host address and port.
    
    Parameters:
    
    address - the endpoint address or hostname
    
    port - the endpoint port number
    
    See Also:
    
    RpcQueryNode.Builder
  - RpcQueryNode
```
public RpcQueryNode(URL url)
```
    Constructs a new RPC communications object via the specified protocol, host address and port. The protocol of the URL must be either http or https.
    
    Parameters:
    
    url - the endpoint URL of the node (protocol, address and port)
    
    See Also:
    
    RpcQueryNode.Builder
- Method Detail
  - getDefaultTimeout
```
public final int getDefaultTimeout()
```
    Returns:
    
    the default timeout period in milliseconds, or 0 if timeouts are disabled
  - getRequestSerializer
```
public final RpcRequestSerializer getRequestSerializer()
```
    Returns:
    
    the RpcRequestSerializer which converts request objects into a String format
  - getResponseDeserializer
```
public final RpcResponseDeserializer getResponseDeserializer()
```
    Returns:
    
    the RpcRequestDeserializer which converts the returned String into a response class
  - getRequestExecutor
```
public final RpcRequestExecutor getRequestExecutor()
```
    Returns:
    
    the RpcRequestExecutor which submits the request to the external node
  - getExecutorService
```
public final ExecutorService getExecutorService()
```
    Returns:
    
    the ExecutorService used to process asynchronous queries
  - processRequest
```
public <Q extends RpcRequest<R>,R extends RpcResponse> R processRequest(Q request)
                                                                 throws IOException,
                                                                        RpcException
```
    Sends a query request to the node via RPC with the default timeout.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    Returns:
    
    the successful reponse from the node
    
    Throws:
    
    IOException - if an error occurs with the connection to the node
    
    RpcException - if the node returns a non-successful response
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequest
```
public <Q extends RpcRequest<R>,R extends RpcResponse> R processRequest(Q request,
                                                                        int timeout)
                                                                 throws IOException,
                                                                        RpcException
```
    Sends a query request to the node via RPC with the specified timeout.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    timeout - the timeout for the request in milliseconds, or zero for infinite
    
    Returns:
    
    the successful reponse from the node
    
    Throws:
    
    IOException - if an error occurs with the connection to the node
    
    RpcException - if the node returns a non-successful response
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequestAsync
```
public <Q extends RpcRequest<R>,R extends RpcResponse> Future<R> processRequestAsync(Q request)
```
    Sends an asynchronous query request to the node via RPC with the default timeout. This method is non-blocking, and will queue the request up to be processed in a separate worker thread. The returned Future object should be used to retrieve the status or result of the request at a later time, and will encapsulate any IOException or RpcException exceptions thrown during the process.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    Returns:
    
    a future instance representing the response data/exception
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequestAsync
```
public <Q extends RpcRequest<R>,R extends RpcResponse> Future<R> processRequestAsync(Q request,
                                                                                     int timeout)
```
    Sends an asynchronous query request to the node via RPC with the specified timeout. This method is non-blocking, and will queue the request up to be processed in a separate worker thread. The returned Future object should be used to retrieve the status or result of the request at a later time, and will encapsulate any IOException or RpcException exceptions thrown during the process.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    timeout - the timeout for the request in milliseconds, or zero for infinite
    
    Returns:
    
    a future instance representing the response data/exception
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequestAsync
```
public <Q extends RpcRequest<R>,R extends RpcResponse> Future<R> processRequestAsync(Q request,
                                                                                     QueryCallback<? super Q,? super R> callback)
```
    Sends an asynchronous query request to the node via RPC with the default timeout. This method is non-blocking, and will queue the request up to be processed in a separate worker thread. In conjunction with the receiving callback instance, the returned Future object may be used to retrieve the status or result of the request at a later time, and will encapsulate any IOException or RpcException exceptions thrown during the process.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    callback - the callback to execute after the request has completed (or null for no callback)
    
    Returns:
    
    a future instance representing the response data/exception
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequestAsync
```
public <Q extends RpcRequest<R>,R extends RpcResponse> Future<R> processRequestAsync(Q request,
                                                                                     int timeout,
                                                                                     QueryCallback<? super Q,? super R> callback)
```
    Sends an asynchronous query request to the node via RPC with the specified timeout. This method is non-blocking, and will queue the request up to be processed in a separate worker thread. In conjunction with the receiving callback instance, the returned Future object may be used to retrieve the status or result of the request at a later time, and will encapsulate any IOException or RpcException exceptions thrown during the process.
    
    Type Parameters:
    
    Q - the request type
    
    R - the response type
    
    Parameters:
    
    request - the query request to send to the node
    
    timeout - the timeout for the request in milliseconds, or zero for infinite
    
    callback - the callback to execute after the request has completed (or null for no callback)
    
    Returns:
    
    a future instance representing the response data/exception
    
    See Also:
    
    See the GitHub wiki for a list of supported request operations.
  - processRequestRaw
```
public <R extends RpcResponse> R processRequestRaw(String jsonRequest,
                                                   int timeout,
                                                   Class<R> responseClass)
                                            throws IOException,
                                                   RpcException
```
    Sends a raw JSON query to the RPC server, and then returns an object in the specified class containing the deserialized response data.
    
    Type Parameters:
    
    R - the response type
    
    Parameters:
    
    jsonRequest - the JSON query to send to the node
    
    timeout - the timeout for the request in milliseconds, or zero for infinite
    
    responseClass - the class to deserialize the response data into
    
    Returns:
    
    the response received from the node, contained in an object of the specified class
    
    Throws:
    
    IOException - if an error occurs with the connection to the node
    
    RpcException - if the node returns a non-successful response
  - processRequestRaw
```
public String processRequestRaw(String jsonRequest,
                                int timeout)
                         throws IOException
```
    Sends a raw JSON query to the RPC server, and then returns the raw JSON response.
    Note that this method will not deserialize the resulting JSON, or parse it for errors reported by the node. You will need to implement this functionality yourself, or use the alternate processRequestRaw(String, int, Class) method.
    
    Parameters:
    
    jsonRequest - the JSON query to send to the node
    
    timeout - the timeout for the request in milliseconds, or zero for infinite
    
    Returns:
    
    the JSON response received from the node
    
    Throws:
    
    IOException - if an error occurs with the connection to the node
  - builder
```
public static RpcQueryNode.Builder builder()
```
    Returns a new builder object for constructing RpcQueryNode objects.
    
    Returns:
    
    a new builder object

Class RpcQueryNode

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RpcQueryNode

RpcQueryNode

RpcQueryNode

RpcQueryNode

Method Detail

getDefaultTimeout

getRequestSerializer

getResponseDeserializer

getRequestExecutor

getExecutorService

processRequest

processRequest

processRequestAsync

processRequestAsync

processRequestAsync

processRequestAsync

processRequestRaw

processRequestRaw

builder