org.stellar.sdk

Class Server

java.lang.Object

org.stellar.sdk.Server

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Server
extends java.lang.Object
implements java.io.Closeable

Main class used to connect to Horizon server.

Constructor Summary

Constructors

Constructor and Description
Server(java.lang.String uri) Constructs a new Server object with default HTTP clients.
Server(java.lang.String serverURI, okhttp3.OkHttpClient httpClient, okhttp3.OkHttpClient submitHttpClient) Constructs a new Server object with custom HTTP clients.

Method Summary

Modifier and Type	Method and Description
AccountsRequestBuilder	accounts()
AssetsRequestBuilder	assets()
ClaimableBalancesRequestBuilder	claimableBalances()
void	close()
EffectsRequestBuilder	effects()
FeeStatsRequestBuilder	feeStats()
okhttp3.OkHttpClient	getHttpClient()
okhttp3.OkHttpClient	getSubmitHttpClient() submitHttpClient is used only for submitting transactions.
LedgersRequestBuilder	ledgers()
LiquidityPoolsRequestBuilder	liquidityPools()
TransactionBuilderAccount	loadAccount(java.lang.String address) Fetches an account's most current state in the ledger, then creates and returns an Account object.
OffersRequestBuilder	offers()
OperationsRequestBuilder	operations()
OrderBookRequestBuilder	orderBook()
PaymentsRequestBuilder	payments()
RootRequestBuilder	root()
void	setHttpClient(okhttp3.OkHttpClient httpClient)
void	setSubmitHttpClient(okhttp3.OkHttpClient submitHttpClient) submitHttpClient is used only for submitting transactions.
StrictReceivePathsRequestBuilder	strictReceivePaths()
StrictSendPathsRequestBuilder	strictSendPaths()
TransactionResponse	submitTransaction(FeeBumpTransaction transaction) Submits a fee bump transaction to the network
TransactionResponse	submitTransaction(FeeBumpTransaction transaction, boolean skipMemoRequiredCheck) Submits a fee bump transaction to the network
TransactionResponse	submitTransaction(Transaction transaction) Submits a transaction to the network
TransactionResponse	submitTransaction(Transaction transaction, boolean skipMemoRequiredCheck) Submits a transaction to the network
SubmitTransactionAsyncResponse	submitTransactionAsync(FeeBumpTransaction transaction) Submits a base64 asynchronous transaction to the network.
SubmitTransactionAsyncResponse	submitTransactionAsync(FeeBumpTransaction transaction, boolean skipMemoRequiredCheck) Submits a base64 asynchronous transaction to the network.
SubmitTransactionAsyncResponse	submitTransactionAsync(Transaction transaction) Submits a base64 asynchronous transaction to the network.
SubmitTransactionAsyncResponse	submitTransactionAsync(Transaction transaction, boolean skipMemoRequiredCheck) Submits a base64 asynchronous transaction to the network.
TransactionResponse	submitTransactionXdr(java.lang.String transactionXdr) Submits a base64 encoded transaction envelope to the network
SubmitTransactionAsyncResponse	submitTransactionXdrAsync(java.lang.String transactionXdr) Submits a base64 asynchronous transaction to the network.
TradeAggregationsRequestBuilder	tradeAggregations(Asset baseAsset, Asset counterAsset, long startTime, long endTime, long resolution, long offset)
TradesRequestBuilder	trades()
TransactionsRequestBuilder	transactions()

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(java.lang.String uri)

Constructs a new Server object with default HTTP clients.

Parameters:

uri - The URI of the Horizon server.

Server

public Server(java.lang.String serverURI,
              okhttp3.OkHttpClient httpClient,
              okhttp3.OkHttpClient submitHttpClient)

Constructs a new Server object with custom HTTP clients.

Parameters:

serverURI - The URI of the Horizon server.

httpClient - The OkHttpClient to use for general requests.

submitHttpClient - The OkHttpClient to use for submitting transactions.

Method Detail

loadAccount

public TransactionBuilderAccount loadAccount(java.lang.String address)

Fetches an account's most current state in the ledger, then creates and returns an Account object.

Parameters:

address - The address of the account to load, muxed accounts are supported.

Returns:

Account object

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

root

public RootRequestBuilder root()

Returns:

RootRequestBuilder instance.

accounts

public AccountsRequestBuilder accounts()

Returns:

AccountsRequestBuilder instance.

assets

public AssetsRequestBuilder assets()

Returns:

AssetsRequestBuilder instance.

claimableBalances

public ClaimableBalancesRequestBuilder claimableBalances()

Returns:

ClaimableBalancesRequestBuilder instance.

effects

public EffectsRequestBuilder effects()

Returns:

EffectsRequestBuilder instance.

ledgers

public LedgersRequestBuilder ledgers()

Returns:

LedgersRequestBuilder instance.

offers

public OffersRequestBuilder offers()

Returns:

OffersRequestBuilder instance.

operations

public OperationsRequestBuilder operations()

Returns:

OperationsRequestBuilder instance.

feeStats

public FeeStatsRequestBuilder feeStats()

Returns:

FeeStatsResponse instance.

orderBook

public OrderBookRequestBuilder orderBook()

Returns:

OrderBookRequestBuilder instance.

trades

public TradesRequestBuilder trades()

Returns:

TradesRequestBuilder instance.

tradeAggregations

public TradeAggregationsRequestBuilder tradeAggregations(Asset baseAsset,
                                                         Asset counterAsset,
                                                         long startTime,
                                                         long endTime,
                                                         long resolution,
                                                         long offset)

Returns:

TradeAggregationsRequestBuilder instance.

strictReceivePaths

public StrictReceivePathsRequestBuilder strictReceivePaths()

Returns:

StrictReceivePathsRequestBuilder instance.

strictSendPaths

public StrictSendPathsRequestBuilder strictSendPaths()

Returns:

StrictSendPathsRequestBuilder instance.

payments

public PaymentsRequestBuilder payments()

Returns:

PaymentsRequestBuilder instance.

transactions

public TransactionsRequestBuilder transactions()

Returns:

TransactionsRequestBuilder instance.

liquidityPools

public LiquidityPoolsRequestBuilder liquidityPools()

Returns:

LiquidityPoolsRequestBuilder instance.

submitTransactionXdr

public TransactionResponse submitTransactionXdr(java.lang.String transactionXdr)

Submits a base64 encoded transaction envelope to the network

Parameters:

transactionXdr - base64 encoded transaction envelope to submit to the network

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

submitTransaction

public TransactionResponse submitTransaction(Transaction transaction,
                                             boolean skipMemoRequiredCheck)

Submits a transaction to the network

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

submitTransaction

public TransactionResponse submitTransaction(FeeBumpTransaction transaction,
                                             boolean skipMemoRequiredCheck)

Submits a fee bump transaction to the network

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

submitTransaction

public TransactionResponse submitTransaction(Transaction transaction)

Submits a transaction to the network

This function will always check if the destination account requires a memo in the transaction as defined in SEP-0029 If you want to skip this check, use submitTransaction(Transaction, boolean).

Parameters:

transaction - transaction to submit to the network.

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

submitTransaction

public TransactionResponse submitTransaction(FeeBumpTransaction transaction)

Submits a fee bump transaction to the network

This function will always check if the destination account requires a memo in the transaction as defined in SEP-0029 If you want to skip this check, use submitTransaction(Transaction, boolean).

Parameters:

transaction - transaction to submit to the network.

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

submitTransactionXdrAsync

public SubmitTransactionAsyncResponse submitTransactionXdrAsync(java.lang.String transactionXdr)

Submits a base64 asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

Parameters:

transactionXdr - base64 encoded transaction envelope to submit to the network

Returns:

SubmitTransactionAsyncResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

See Also:

Submit a Transaction Asynchronously

submitTransactionAsync

public SubmitTransactionAsyncResponse submitTransactionAsync(Transaction transaction,
                                                             boolean skipMemoRequiredCheck)

Submits a base64 asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

TransactionResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

See Also:

Submit a Transaction Asynchronously

submitTransactionAsync

public SubmitTransactionAsyncResponse submitTransactionAsync(FeeBumpTransaction transaction,
                                                             boolean skipMemoRequiredCheck)

Submits a base64 asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

SubmitTransactionAsyncResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

See Also:

Submit a Transaction Asynchronously

submitTransactionAsync

public SubmitTransactionAsyncResponse submitTransactionAsync(Transaction transaction)

Submits a base64 asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

This function will always check if the destination account requires a memo in the transaction as defined in SEP-0029 If you want to skip this check, use submitTransactionAsync(Transaction, boolean).

Parameters:

transaction - transaction to submit to the network.

Returns:

SubmitTransactionAsyncResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

See Also:

Submit a Transaction Asynchronously

submitTransactionAsync

public SubmitTransactionAsyncResponse submitTransactionAsync(FeeBumpTransaction transaction)

Submits a base64 asynchronous transaction to the network. Unlike the synchronous version, which blocks and waits for the transaction to be ingested in Horizon, this endpoint relays the response from core directly back to the user.

This function will always check if the destination account requires a memo in the transaction as defined in SEP-0029 If you want to skip this check, use submitTransactionAsync(Transaction, boolean).

Parameters:

transaction - transaction to submit to the network.

Returns:

SubmitTransactionAsyncResponse

Throws:

AccountRequiresMemoException - when a transaction is trying to submit an operation to an account which requires a memo.

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - if the request fails due to a bad request (4xx)

BadResponseException - if the request fails due to a bad response from the server (5xx)

TooManyRequestsException - if the request fails due to too many requests sent to the server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

See Also:

Submit a Transaction Asynchronously

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getHttpClient

public okhttp3.OkHttpClient getHttpClient()

setHttpClient

public void setHttpClient(okhttp3.OkHttpClient httpClient)

getSubmitHttpClient

public okhttp3.OkHttpClient getSubmitHttpClient()

submitHttpClient is used only for submitting transactions. The read timeout is longer.

setSubmitHttpClient

public void setSubmitHttpClient(okhttp3.OkHttpClient submitHttpClient)

submitHttpClient is used only for submitting transactions. The read timeout is longer.