Module com.tigerbeetle

Package com.tigerbeetle

Class Client

java.lang.Object

com.tigerbeetle.Client

All Implemented Interfaces:

AutoCloseable

public final class Client
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
Client(byte[] clusterID, String[] replicaAddresses)	Initializes an instance of TigerBeetle client.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the client, freeing all resources.
CreateAccountResultBatch	createAccounts(AccountBatch batch)	Submits a batch of new accounts to be created.
CompletableFuture<CreateAccountResultBatch>	createAccountsAsync(AccountBatch batch)	Submits a batch of new accounts to be created asynchronously.
CreateTransferResultBatch	createTransfers(TransferBatch batch)	Submits a batch of new transfers to be created.
CompletableFuture<CreateTransferResultBatch>	createTransfersAsync(TransferBatch batch)	Submits a batch of new transfers to be created asynchronously.
AccountBalanceBatch	getAccountBalances(AccountFilter filter)	Fetch the balance history from a given account.
CompletableFuture<AccountBalanceBatch>	getAccountBalancesAsync(AccountFilter filter)	Fetch the balance history from a given account asynchronously.
TransferBatch	getAccountTransfers(AccountFilter filter)	Fetch transfers from a given account.
CompletableFuture<TransferBatch>	getAccountTransfersAsync(AccountFilter filter)	Fetch transfers from a given account asynchronously.
byte[]	getClusterID()	Gets the cluster ID
AccountBatch	lookupAccounts(IdBatch batch)	Looks up a batch of accounts.
CompletableFuture<AccountBatch>	lookupAccountsAsync(IdBatch batch)	Looks up a batch of accounts asynchronously.
TransferBatch	lookupTransfers(IdBatch batch)	Looks up a batch of transfers.
CompletableFuture<TransferBatch>	lookupTransfersAsync(IdBatch batch)	Looks up a batch of transfers asynchronously.
AccountBatch	queryAccounts(QueryFilter filter)	Query accounts.
CompletableFuture<AccountBatch>	queryAccountsAsync(QueryFilter filter)	Query accounts asynchronously.
TransferBatch	queryTransfers(QueryFilter filter)	Query transfers.
CompletableFuture<TransferBatch>	queryTransfersAsync(QueryFilter filter)	Query transfers asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(byte[] clusterID,
              String[] replicaAddresses)

Initializes an instance of TigerBeetle client. This class is thread-safe and for optimal performance, a single instance should be shared between multiple concurrent tasks.

Multiple clients can be instantiated in case of connecting to more than one TigerBeetle cluster.

Parameters:

clusterID -

replicaAddresses -

Throws:

InitializationException - if an error occurred initializing this client. See InitializationStatus for more details.

NullPointerException - if clusterID is null.

IllegalArgumentException - if clusterID is not a UInt128.

IllegalArgumentException - if replicaAddresses is empty or presented in incorrect format.

NullPointerException - if replicaAddresses is null or any element in the array is null.

Method Detail

getClusterID

public byte[] getClusterID()

Gets the cluster ID

Returns:

clusterID

createAccounts

public CreateAccountResultBatch createAccounts(AccountBatch batch)

Submits a batch of new accounts to be created.

Parameters:

batch - a batch containing all accounts to be created.

Returns:

a read-only batch describing the result.

Throws:

RequestException - refer to PacketStatus for more details.

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

createAccountsAsync

public CompletableFuture<CreateAccountResultBatch> createAccountsAsync(AccountBatch batch)

Submits a batch of new accounts to be created asynchronously.

Parameters:

batch - a batch containing all accounts to be created.

Returns:

a CompletableFuture to be completed.

Throws:

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

See Also:

createAccounts(AccountBatch)

lookupAccounts

public AccountBatch lookupAccounts(IdBatch batch)

Looks up a batch of accounts.

Parameters:

batch - an batch containing all account ids.

Returns:

a read-only batch containing all accounts found.

Throws:

RequestException - refer to PacketStatus for more details.

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

lookupAccountsAsync

public CompletableFuture<AccountBatch> lookupAccountsAsync(IdBatch batch)

Looks up a batch of accounts asynchronously.

Parameters:

batch - a batch containing all account ids.

Returns:

a CompletableFuture to be completed.

Throws:

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

See Also:

lookupAccounts(com.tigerbeetle.IdBatch)

createTransfers

public CreateTransferResultBatch createTransfers(TransferBatch batch)

Submits a batch of new transfers to be created.

Parameters:

batch - a batch containing all transfers to be created.

Returns:

a read-only batch describing the result.

Throws:

RequestException - refer to PacketStatus for more details.

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

createTransfersAsync

public CompletableFuture<CreateTransferResultBatch> createTransfersAsync(TransferBatch batch)

Submits a batch of new transfers to be created asynchronously.

Parameters:

batch - a batch containing all transfers to be created.

Returns:

a CompletableFuture to be completed.

Throws:

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

lookupTransfers

public TransferBatch lookupTransfers(IdBatch batch)

Looks up a batch of transfers.

Parameters:

batch - a batch containing all transfer ids.

Returns:

a read-only batch containing all transfers found.

Throws:

RequestException - refer to PacketStatus for more details.

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

lookupTransfersAsync

public CompletableFuture<TransferBatch> lookupTransfersAsync(IdBatch batch)

Looks up a batch of transfers asynchronously.

Parameters:

batch - a batch containing all transfer ids.

Returns:

a CompletableFuture to be completed.

Throws:

IllegalArgumentException - if batch is empty.

NullPointerException - if batch is null.

IllegalStateException - if this client is closed.

See Also:

lookupTransfers(IdBatch)

getAccountTransfers

public TransferBatch getAccountTransfers(AccountFilter filter)

Fetch transfers from a given account.

Parameters:

filter - a AccountFilter containing all query parameters.

Returns:

a read-only batch containing all transfers that match the query parameters.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

getAccountTransfers(AccountFilter)

getAccountTransfersAsync

public CompletableFuture<TransferBatch> getAccountTransfersAsync(AccountFilter filter)

Fetch transfers from a given account asynchronously.

Parameters:

filter - a AccountFilter containing all query parameters.

Returns:

a CompletableFuture to be completed.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

getAccountTransfers(AccountFilter)

getAccountBalances

public AccountBalanceBatch getAccountBalances(AccountFilter filter)

Fetch the balance history from a given account.

Parameters:

filter - a AccountFilter containing all query parameters.

Returns:

a read-only batch containing all balances that match the query parameters.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

getAccountBalances(AccountFilter)

getAccountBalancesAsync

public CompletableFuture<AccountBalanceBatch> getAccountBalancesAsync(AccountFilter filter)

Fetch the balance history from a given account asynchronously.

Parameters:

filter - a AccountFilter containing all query parameters.

Returns:

a CompletableFuture to be completed.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

getAccountBalances(AccountFilter)

queryAccounts

public AccountBatch queryAccounts(QueryFilter filter)

Query accounts.

Parameters:

filter - a QueryFilter containing all query parameters.

Returns:

a read-only batch containing all accounts that match the query parameters.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

queryAccountsAsync

public CompletableFuture<AccountBatch> queryAccountsAsync(QueryFilter filter)

Query accounts asynchronously.

Parameters:

filter - a QueryFilter containing all query parameters.

Returns:

a CompletableFuture to be completed.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

queryAccounts(QueryFilter)

queryTransfers

public TransferBatch queryTransfers(QueryFilter filter)

Query transfers.

Parameters:

filter - a QueryFilter containing all query parameters.

Returns:

a read-only batch containing all transfers that match the query parameters.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

queryTransfersAsync

public CompletableFuture<TransferBatch> queryTransfersAsync(QueryFilter filter)

Query transfers asynchronously.

Parameters:

filter - a QueryFilter containing all query parameters.

Returns:

a CompletableFuture to be completed.

Throws:

NullPointerException - if filter is null.

IllegalStateException - if this client is closed.

See Also:

queryTransfers(QueryFilter)

close

public void close()

Closes the client, freeing all resources.

This method causes the current thread to wait for all ongoing requests to finish.

Specified by:

close in interface AutoCloseable

See Also:

AutoCloseable.close()