Package org.stellar.sdk

Class Server

java.lang.Object

org.stellar.sdk.Server

All Implemented Interfaces:

Closeable, AutoCloseable

public class Server
extends Object
implements Closeable

Main class used to connect to Horizon server.

Constructor Summary

Constructors

Constructor	Description
Server(String uri)
Server(String serverURI, okhttp3.OkHttpClient httpClient, okhttp3.OkHttpClient submitHttpClient)

Method Summary

Modifier and Type	Method	Description
AccountsRequestBuilder	accounts()	Returns AccountsRequestBuilder instance.
AssetsRequestBuilder	assets()	Returns AssetsRequestBuilder instance.
ClaimableBalancesRequestBuilder	claimableBalances()	Returns ClaimableBalancesRequestBuilder instance.
void	close()
EffectsRequestBuilder	effects()	Returns EffectsRequestBuilder instance.
FeeStatsRequestBuilder	feeStats()	Returns FeeStatsResponse instance.
okhttp3.OkHttpClient	getHttpClient()
okhttp3.OkHttpClient	getSubmitHttpClient()	submitHttpClient is used only for submitting transactions.
LedgersRequestBuilder	ledgers()	Returns LedgersRequestBuilder instance.
LiquidityPoolsRequestBuilder	liquidityPools()	Returns LiquidityPoolsRequestBuilder instance.
OffersRequestBuilder	offers()	Returns OffersRequestBuilder instance.
OperationsRequestBuilder	operations()	Returns OperationsRequestBuilder instance.
OrderBookRequestBuilder	orderBook()	Returns OrderBookRequestBuilder instance.
PaymentsRequestBuilder	payments()	Returns PaymentsRequestBuilder instance.
RootResponse	root()	Returns RootResponse.
void	setHttpClient(okhttp3.OkHttpClient httpClient)
void	setSubmitHttpClient(okhttp3.OkHttpClient submitHttpClient)	submitHttpClient is used only for submitting transactions.
StrictReceivePathsRequestBuilder	strictReceivePaths()	Returns StrictReceivePathsRequestBuilder instance.
StrictSendPathsRequestBuilder	strictSendPaths()	Returns StrictSendPathsRequestBuilder instance.
SubmitTransactionResponse	submitTransaction(FeeBumpTransaction transaction)	Submits a fee bump transaction to the network
SubmitTransactionResponse	submitTransaction(FeeBumpTransaction transaction, boolean skipMemoRequiredCheck)	Submits a fee bump transaction to the network
SubmitTransactionResponse	submitTransaction(Transaction transaction)	Submits a transaction to the network
SubmitTransactionResponse	submitTransaction(Transaction transaction, boolean skipMemoRequiredCheck)	Submits a transaction to the network
SubmitTransactionResponse	submitTransactionXdr(String transactionXdr)	Submits a base64 encoded transaction envelope to the network
TradeAggregationsRequestBuilder	tradeAggregations(Asset baseAsset, Asset counterAsset, long startTime, long endTime, long resolution, long offset)	Returns TradeAggregationsRequestBuilder instance.
TradesRequestBuilder	trades()	Returns TradesRequestBuilder instance.
TransactionsRequestBuilder	transactions()	Returns TransactionsRequestBuilder instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Server

public Server(String uri)

Server

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

Method Details

root

public RootResponse root()
                  throws IOException

Returns RootResponse.

Throws:

IOException

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 SubmitTransactionResponse submitTransactionXdr(String transactionXdr)
                                               throws IOException

Submits a base64 encoded transaction envelope to the network

Parameters:

transactionXdr - base64 encoded transaction envelope to submit to the network

Returns:

SubmitTransactionResponse

Throws:

SubmitTransactionTimeoutResponseException - When Horizon returns a Timeout or connection timeout occured.

SubmitTransactionUnknownResponseException - When unknown Horizon response is returned.

IOException

submitTransaction

public SubmitTransactionResponse submitTransaction(Transaction transaction,
 boolean skipMemoRequiredCheck)
                                            throws IOException,
AccountRequiresMemoException

Submits a transaction to the network

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

SubmitTransactionResponse

Throws:

SubmitTransactionTimeoutResponseException - When Horizon returns a Timeout or connection timeout occured.

SubmitTransactionUnknownResponseException - When unknown Horizon response is returned.

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

IOException

submitTransaction

public SubmitTransactionResponse submitTransaction(FeeBumpTransaction transaction,
 boolean skipMemoRequiredCheck)
                                            throws IOException,
AccountRequiresMemoException

Submits a fee bump transaction to the network

Parameters:

transaction - transaction to submit to the network

skipMemoRequiredCheck - set to true to skip memoRequiredCheck

Returns:

SubmitTransactionResponse

Throws:

SubmitTransactionTimeoutResponseException - When Horizon returns a Timeout or connection timeout occured.

SubmitTransactionUnknownResponseException - When unknown Horizon response is returned.

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

IOException

submitTransaction

public SubmitTransactionResponse submitTransaction(Transaction transaction)
                                            throws IOException,
AccountRequiresMemoException

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:

SubmitTransactionResponse

Throws:

SubmitTransactionTimeoutResponseException - When Horizon returns a Timeout or connection timeout occured.

SubmitTransactionUnknownResponseException - When unknown Horizon response is returned.

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

IOException

submitTransaction

public SubmitTransactionResponse submitTransaction(FeeBumpTransaction transaction)
                                            throws IOException,
AccountRequiresMemoException

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:

SubmitTransactionResponse

Throws:

SubmitTransactionTimeoutResponseException - When Horizon returns a Timeout or connection timeout occured.

SubmitTransactionUnknownResponseException - When unknown Horizon response is returned.

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

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

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.