org.iota.jota.connection

Class HttpConnector

java.lang.Object

org.iota.jota.connection.HttpConnector

All Implemented Interfaces:

Connection, IotaNodeApi

public class HttpConnector
extends Object
implements Connection

Field Summary

Fields inherited from interface org.iota.jota.connection.Connection

X_IOTA_API_VERSION_HEADER_NAME, X_IOTA_API_VERSION_HEADER_VALUE

Constructor Summary

Constructors

Constructor and Description
HttpConnector(okhttp3.OkHttpClient client, String protocol, String host) Creates an HTTP connector using the provided HTTP client, with the default port
HttpConnector(okhttp3.OkHttpClient client, String protocol, String host, int port) Creates an HTTP connector using the provided HTTP client
HttpConnector(okhttp3.OkHttpClient client, URL url) Creates an HTTP connector using the provided HTTP client
HttpConnector(String protocol, String host) Creates an HTTP connector using the default port by creating an OkHttpClient
HttpConnector(String protocol, String host, int port) Creates an HTTP connector using the default timeout by creating an OkHttpClient
HttpConnector(String protocol, String host, int port, int timeout) Creates an HTTP connector by creating an OkHttpClient
HttpConnector(URL url) Creates an HTTP connector using the default timeout by creating an OkHttpClient
HttpConnector(URL url, int timeout) Creates an HTTP connector by creating an OkHttpClient

Method Summary

Modifier and Type	Method and Description
AddNeighborsResponse	addNeighbors(IotaNeighborsRequest request) Add a list of neighbors to the node.
GetAttachToTangleResponse	attachToTangle(IotaAttachToTangleRequest request) Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work.
BroadcastTransactionsResponse	broadcastTransactions(IotaBroadcastTransactionRequest request) Broadcast a list of transactions to all neighbors.
CheckConsistencyResponse	checkConsistency(IotaCheckConsistencyRequest request) Checks the consistency of the subtangle described by the provided tails.
IotaCustomResponse	customRequest(IotaCustomRequest customRequest) Custom API call used to call IXI modules.
boolean	equals(Object obj)
FindTransactionResponse	findTransactions(IotaFindTransactionsRequest request) Find the transactions which match the specified input and return.
GetBalancesResponse	getBalances(IotaGetBalancesRequest request) It returns the confirmed balance which a list of addresses have at the latest confirmed milestone.
GetInclusionStateResponse	getInclusionStates(IotaGetInclusionStateRequest request) Get the inclusion states of a set of transactions.
GetNeighborsResponse	getNeighbors(IotaCommandRequest request) Get the list of neighbors from the node.
GetNodeInfoResponse	getNodeInfo(IotaCommandRequest request) Returns information about the node.
GetTipsResponse	getTips(IotaCommandRequest request) Get the list of latest tips (unconfirmed transactions).
GetTransactionsToApproveResponse	getTransactionsToApprove(IotaGetTransactionsToApproveRequest request) Tip selection which returns trunkTransaction and branchTransaction.
GetTrytesResponse	getTrytes(IotaGetTrytesRequest request) Returns the raw trytes data of a transaction.
int	hashCode()
InterruptAttachingToTangleResponse	interruptAttachingToTangle(IotaCommandRequest request) Interrupts and completely aborts the attachToTangle process.
boolean	isConnectedToSameNode(Connection other) A check if we are connected to the same node.
RemoveNeighborsResponse	removeNeighbors(IotaNeighborsRequest request) Removes a list of neighbors from the node.
boolean	start() Attempts to start the node connection
void	stop() Stops this connection
StoreTransactionsResponse	storeTransactions(IotaStoreTransactionsRequest request) Store transactions into the nodes local storage.
String	toString()
URL	url()
WereAddressesSpentFromResponse	wereAddressesSpentFrom(IotaWereAddressesSpentFromRequest request) Check if a list of addresses was ever spent from, in the current epoch, or in previous epochs.
protected static <T> retrofit2.Response<T>	wrapCheckedException(retrofit2.Call<T> call)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpConnector

public HttpConnector(URL url)

Creates an HTTP connector using the default timeout by creating an OkHttpClient

Parameters:

url - The URL we connect to

HttpConnector

public HttpConnector(String protocol,
                     String host)
              throws MalformedURLException

Creates an HTTP connector using the default port by creating an OkHttpClient

Parameters:

protocol - The protocol we use

host - The host we use (Domain and optional subdomain)

Throws:

MalformedURLException - if this is an invalid URL

HttpConnector

public HttpConnector(String protocol,
                     String host,
                     int port)
              throws MalformedURLException

Creates an HTTP connector using the default timeout by creating an OkHttpClient

Parameters:

protocol - The protocol we use

host - The host we use (Domain and optional subdomain)

port - The port we use

Throws:

MalformedURLException - if this is an invalid URL

HttpConnector

public HttpConnector(String protocol,
                     String host,
                     int port,
                     int timeout)
              throws MalformedURLException

Creates an HTTP connector by creating an OkHttpClient

Parameters:

protocol - The protocol we use

host - The host we use (Domain and optional subdomain)

port - The port we use

timeout - the connection timeout after a request is sent

Throws:

MalformedURLException - if this is an invalid URL

HttpConnector

public HttpConnector(URL url,
                     int timeout)

Creates an HTTP connector by creating an OkHttpClient

Parameters:

url - The URL we connect to

timeout - the connection timeout after a request is sent

HttpConnector

public HttpConnector(okhttp3.OkHttpClient client,
                     String protocol,
                     String host)
              throws MalformedURLException

Creates an HTTP connector using the provided HTTP client, with the default port

Parameters:

client - The client we use to send/receive/intercept

protocol - The protocol we use

host - The host we use (Domain and optional subdomain)

Throws:

MalformedURLException - if this is an invalid URL

HttpConnector

public HttpConnector(okhttp3.OkHttpClient client,
                     String protocol,
                     String host,
                     int port)
              throws MalformedURLException

Creates an HTTP connector using the provided HTTP client

Parameters:

client - The client we use to send/receive/intercept

protocol - The protocol we use

host - The host we use (Domain and optional subdomain)

port - The port we use

Throws:

MalformedURLException - if this is an invalid URL

HttpConnector

public HttpConnector(okhttp3.OkHttpClient client,
                     URL url)

Creates an HTTP connector using the provided HTTP client

Parameters:

client - The client we use to send/receive/intercept

url - The URL we connect to

Method Detail

url

public URL url()

Specified by:

url in interface Connection

Returns:

The node url this connection is connected to

start

public boolean start()

Description copied from interface: Connection

Attempts to start the node connection

Specified by:

start in interface Connection

Returns:

true if start was successful, otherwise false

stop

public void stop()

Description copied from interface: Connection

Stops this connection

Specified by:

stop in interface Connection

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isConnectedToSameNode

public boolean isConnectedToSameNode(Connection other)

Description copied from interface: Connection

A check if we are connected to the same node. Some nodes can be connected to the same, but have different options for sending (Version, timeout)

Specified by:

isConnectedToSameNode in interface Connection

Parameters:

other - The other connection

Returns:

true if it connects to the same node, otherwise false

toString

public String toString()

Overrides:

toString in class Object

wrapCheckedException

protected static <T> retrofit2.Response<T> wrapCheckedException(retrofit2.Call<T> call)
                                                         throws ArgumentException,
                                                                IllegalStateException,
                                                                IllegalAccessError

Throws:

ArgumentException

IllegalStateException

IllegalAccessError

getNodeInfo

public GetNodeInfoResponse getNodeInfo(IotaCommandRequest request)
                                throws ArgumentException

Description copied from interface: IotaNodeApi

Returns information about the node.

Specified by:

getNodeInfo in interface IotaNodeApi

Throws:

ArgumentException

getNeighbors

public GetNeighborsResponse getNeighbors(IotaCommandRequest request)
                                  throws ArgumentException

Description copied from interface: IotaNodeApi

Get the list of neighbors from the node.

Specified by:

getNeighbors in interface IotaNodeApi

Throws:

ArgumentException

addNeighbors

public AddNeighborsResponse addNeighbors(IotaNeighborsRequest request)
                                  throws ArgumentException

Description copied from interface: IotaNodeApi

Add a list of neighbors to the node.

Specified by:

addNeighbors in interface IotaNodeApi

Throws:

ArgumentException

removeNeighbors

public RemoveNeighborsResponse removeNeighbors(IotaNeighborsRequest request)
                                        throws ArgumentException

Description copied from interface: IotaNodeApi

Removes a list of neighbors from the node.

Specified by:

removeNeighbors in interface IotaNodeApi

Throws:

ArgumentException

getTips

public GetTipsResponse getTips(IotaCommandRequest request)
                        throws ArgumentException

Description copied from interface: IotaNodeApi

Get the list of latest tips (unconfirmed transactions).

Specified by:

getTips in interface IotaNodeApi

Throws:

ArgumentException

findTransactions

public FindTransactionResponse findTransactions(IotaFindTransactionsRequest request)
                                         throws ArgumentException

Description copied from interface: IotaNodeApi

Find the transactions which match the specified input and return.

Specified by:

findTransactions in interface IotaNodeApi

Throws:

ArgumentException

getInclusionStates

public GetInclusionStateResponse getInclusionStates(IotaGetInclusionStateRequest request)
                                             throws ArgumentException

Description copied from interface: IotaNodeApi

Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions.

Specified by:

getInclusionStates in interface IotaNodeApi

Throws:

ArgumentException

getTrytes

public GetTrytesResponse getTrytes(IotaGetTrytesRequest request)
                            throws ArgumentException

Description copied from interface: IotaNodeApi

Returns the raw trytes data of a transaction.

Specified by:

getTrytes in interface IotaNodeApi

Throws:

ArgumentException

getTransactionsToApprove

public GetTransactionsToApproveResponse getTransactionsToApprove(IotaGetTransactionsToApproveRequest request)
                                                          throws ArgumentException

Description copied from interface: IotaNodeApi

Tip selection which returns trunkTransaction and branchTransaction. The input value is the latest coordinator milestone, as provided through the getNodeInfo API call.

Specified by:

getTransactionsToApprove in interface IotaNodeApi

Throws:

ArgumentException

getBalances

public GetBalancesResponse getBalances(IotaGetBalancesRequest request)
                                throws ArgumentException

Description copied from interface: IotaNodeApi

It returns the confirmed balance which a list of addresses have at the latest confirmed milestone.

Specified by:

getBalances in interface IotaNodeApi

Throws:

ArgumentException

attachToTangle

public GetAttachToTangleResponse attachToTangle(IotaAttachToTangleRequest request)
                                         throws ArgumentException

Description copied from interface: IotaNodeApi

Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work.

Specified by:

attachToTangle in interface IotaNodeApi

Throws:

ArgumentException

interruptAttachingToTangle

public InterruptAttachingToTangleResponse interruptAttachingToTangle(IotaCommandRequest request)
                                                              throws ArgumentException

Description copied from interface: IotaNodeApi

Interrupts and completely aborts the attachToTangle process.

Specified by:

interruptAttachingToTangle in interface IotaNodeApi

Throws:

ArgumentException

broadcastTransactions

public BroadcastTransactionsResponse broadcastTransactions(IotaBroadcastTransactionRequest request)
                                                    throws ArgumentException

Description copied from interface: IotaNodeApi

Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle.

Specified by:

broadcastTransactions in interface IotaNodeApi

Throws:

ArgumentException

storeTransactions

public StoreTransactionsResponse storeTransactions(IotaStoreTransactionsRequest request)
                                            throws ArgumentException

Description copied from interface: IotaNodeApi

Store transactions into the nodes local storage. The trytes to be used for this call are returned by attachToTangle.

Specified by:

storeTransactions in interface IotaNodeApi

Throws:

ArgumentException

checkConsistency

public CheckConsistencyResponse checkConsistency(IotaCheckConsistencyRequest request)
                                          throws ArgumentException

Description copied from interface: IotaNodeApi

Checks the consistency of the subtangle described by the provided tails.

Specified by:

checkConsistency in interface IotaNodeApi

Throws:

ArgumentException

wereAddressesSpentFrom

public WereAddressesSpentFromResponse wereAddressesSpentFrom(IotaWereAddressesSpentFromRequest request)
                                                      throws ArgumentException

Description copied from interface: IotaNodeApi

Check if a list of addresses was ever spent from, in the current epoch, or in previous epochs.

Specified by:

wereAddressesSpentFrom in interface IotaNodeApi

Throws:

ArgumentException

customRequest

public IotaCustomResponse customRequest(IotaCustomRequest customRequest)

Description copied from interface: IotaNodeApi

Custom API call used to call IXI modules.

Specified by:

customRequest in interface IotaNodeApi