org.stellar.sdk.requests

Class OperationsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.OperationsRequestBuilder

public class OperationsRequestBuilder
extends RequestBuilder

Builds requests connected to operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor and Description
OperationsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method and Description
OperationsRequestBuilder	cursor(java.lang.String token) Sets cursor parameter on the request.
Page<OperationResponse>	execute() Build and execute request.
static Page<OperationResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri) Requests specific uri and returns Page of OperationResponse.
OperationsRequestBuilder	forAccount(@NonNull java.lang.String account) Builds request to GET /accounts/{account}/operations
OperationsRequestBuilder	forClaimableBalance(@NonNull java.lang.String claimableBalance) Builds request to GET /claimable_balances/{claimable_balance_id}/operations
OperationsRequestBuilder	forLedger(long ledgerSeq) Builds request to GET /ledgers/{ledgerSeq}/operations
OperationsRequestBuilder	forLiquidityPool(java.lang.String liquidityPoolId) Builds request to GET /liquidity_pools/{poolID}/operations
OperationsRequestBuilder	forTransaction(@NonNull java.lang.String transactionId) Builds request to GET /transactions/{transactionId}/operations
OperationsRequestBuilder	includeFailed(boolean value) Adds a parameter defining whether to include operations of failed transactions.
OperationsRequestBuilder	includeTransactions(boolean include) Adds a parameter defining whether to include transactions in the response.
OperationsRequestBuilder	limit(int number) Sets limit parameter on the request.
OperationResponse	operation(okhttp3.HttpUrl uri) Requests specific uri and returns OperationResponse.
OperationResponse	operation(long operationId) Requests GET /operations/{operationId}
OperationsRequestBuilder	order(RequestBuilder.Order direction) Sets order parameter on the request.
SSEStream<OperationResponse>	stream(EventListener<OperationResponse> listener) An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<OperationResponse>	stream(EventListener<OperationResponse> listener, long reconnectTimeout) Allows to stream SSE events from horizon.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationsRequestBuilder

public OperationsRequestBuilder(okhttp3.OkHttpClient httpClient,
                                okhttp3.HttpUrl serverURI)

Method Detail

operation

public OperationResponse operation(okhttp3.HttpUrl uri)

Requests specific uri and returns OperationResponse. This method is helpful for getting the links.

Returns:

OperationResponse

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.

operation

public OperationResponse operation(long operationId)

Requests GET /operations/{operationId}

Parameters:

operationId - Operation to fetch

Returns:

OperationResponse

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.

See Also:

Operation Details

forAccount

public OperationsRequestBuilder forAccount(@NonNull
                                           @NonNull java.lang.String account)

Builds request to GET /accounts/{account}/operations

Parameters:

account - Account for which to get operations

See Also:

Operations for Account

forClaimableBalance

public OperationsRequestBuilder forClaimableBalance(@NonNull
                                                    @NonNull java.lang.String claimableBalance)

Builds request to GET /claimable_balances/{claimable_balance_id}/operations

Parameters:

claimableBalance - Claimable Balance for which to get operations

See Also:

Operations for ClaimableBalance

forLedger

public OperationsRequestBuilder forLedger(long ledgerSeq)

Builds request to GET /ledgers/{ledgerSeq}/operations

Parameters:

ledgerSeq - Ledger for which to get operations

See Also:

Operations for Ledger

forTransaction

public OperationsRequestBuilder forTransaction(@NonNull
                                               @NonNull java.lang.String transactionId)

Builds request to GET /transactions/{transactionId}/operations

Parameters:

transactionId - Transaction ID for which to get operations

See Also:

Operations for Transaction

forLiquidityPool

public OperationsRequestBuilder forLiquidityPool(java.lang.String liquidityPoolId)

Builds request to GET /liquidity_pools/{poolID}/operations

Parameters:

liquidityPoolId - Liquidity pool for which to get operations

See Also:

Operations for Liquidity Pool

includeFailed

public OperationsRequestBuilder includeFailed(boolean value)

Adds a parameter defining whether to include operations of failed transactions. By default only operations of successful transactions are returned.

Parameters:

value - Set to true to include operations of failed transactions.

includeTransactions

public OperationsRequestBuilder includeTransactions(boolean include)

Adds a parameter defining whether to include transactions in the response. By default transaction data is not included.

Parameters:

include - Set to true to include transaction data in the operations response.

execute

public static Page<OperationResponse> execute(okhttp3.OkHttpClient httpClient,
                                              okhttp3.HttpUrl uri)

Requests specific uri and returns Page of OperationResponse. This method is helpful for getting the next set of results.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of OperationResponse

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.

stream

public SSEStream<OperationResponse> stream(EventListener<OperationResponse> listener,
                                           long reconnectTimeout)

Allows to stream SSE events from horizon. Certain endpoints in Horizon can be called in streaming mode using Server-Sent Events. This mode will keep the connection to horizon open and horizon will continue to return responses as ledgers close.

Parameters:

listener - OperationResponse implementation with OperationResponse type

reconnectTimeout - Custom stream connection timeout in ms

Returns:

EventSource object, so you can close() connection when not needed anymore

See Also:

Server-Sent Events, Response Format documentation

stream

public SSEStream<OperationResponse> stream(EventListener<OperationResponse> listener)

An overloaded version of stream(EventListener, long) with default reconnect timeout.

execute

public Page<OperationResponse> execute()

Build and execute request.

Returns:

Page of OperationResponse

Throws:

TooManyRequestsException - when too many requests were sent to the Horizon server.

ConnectionErrorException - if the request fails due to an IOException, including but not limited to a timeout, connection failure etc.

cursor

public OperationsRequestBuilder cursor(java.lang.String token)

Description copied from class: RequestBuilder

Sets cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Overrides:

cursor in class RequestBuilder

Parameters:

token - A cursor is a value that points to a specific location in a collection of resources.

See Also:

Page documentation

limit

public OperationsRequestBuilder limit(int number)

Description copied from class: RequestBuilder

Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Overrides:

limit in class RequestBuilder

Parameters:

number - maxium number of records to return

order

public OperationsRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order