Package org.stellar.sdk.requests

Class EffectsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.EffectsRequestBuilder

public class EffectsRequestBuilder
extends RequestBuilder

Builds requests connected to effects.

Nested Class Summary

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

RequestBuilder.Order

Constructor Summary

Constructors

Constructor	Description
EffectsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
EffectsRequestBuilder	cursor(String token)	Sets cursor parameter on the request.
Page<EffectResponse>	execute()	Build and execute request.
static Page<EffectResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of EffectResponse.
EffectsRequestBuilder	forAccount(@NonNull String account)	Builds request to GET /accounts/{account}/effects
EffectsRequestBuilder	forLedger(long ledgerSeq)	Builds request to GET /ledgers/{ledgerSeq}/effects
EffectsRequestBuilder	forLiquidityPool(String liquidityPoolId)	Builds request to GET /liquidity_pools/{poolID}/effects
EffectsRequestBuilder	forOperation(long operationId)	Builds request to GET /operation/{operationId}/effects
EffectsRequestBuilder	forTransaction(@NonNull String transactionId)	Builds request to GET /transactions/{transactionId}/effects
EffectsRequestBuilder	limit(int number)	Sets limit parameter on the request.
EffectsRequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
SSEStream<EffectResponse>	stream(EventListener<EffectResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<EffectResponse>	stream(EventListener<EffectResponse> 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 Details

EffectsRequestBuilder

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

Method Details

forAccount

public EffectsRequestBuilder forAccount(@NonNull
 @NonNull String account)

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

Parameters:

account - Account for which to get effects

Returns:

this builder instance for chaining

See Also:

• Effects for Account

forLedger

public EffectsRequestBuilder forLedger(long ledgerSeq)

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

Parameters:

ledgerSeq - Ledger for which to get effects

Returns:

this builder instance for chaining

See Also:

• Effects for Ledger

forTransaction

public EffectsRequestBuilder forTransaction(@NonNull
 @NonNull String transactionId)

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

Parameters:

transactionId - Transaction ID for which to get effects

Returns:

this builder instance for chaining

See Also:

• Effect for Transaction

forLiquidityPool

public EffectsRequestBuilder forLiquidityPool(String liquidityPoolId)

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

Parameters:

liquidityPoolId - Liquidity pool for which to get effects

Returns:

this builder instance for chaining

See Also:

• Effects for Liquidity Pool

forOperation

public EffectsRequestBuilder forOperation(long operationId)

Builds request to GET /operation/{operationId}/effects

Parameters:

operationId - Operation ID for which to get effects

Returns:

this builder instance for chaining

See Also:

• Effect for Operation

execute

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

Requests specific uri and returns Page of EffectResponse. 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 EffectResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

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<EffectResponse> stream(EventListener<EffectResponse> 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 - EventListener implementation with EffectResponse 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<EffectResponse> stream(EventListener<EffectResponse> listener)

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

Parameters:

listener - the event listener to receive events

Returns:

an SSEStream for real-time event streaming

execute

public Page<EffectResponse> execute()

Build and execute request.

Returns:

Page of EffectResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkException

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.

cursor

public EffectsRequestBuilder cursor(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.

Returns:

this builder instance for chaining

See Also:

• Page documentation

limit

public EffectsRequestBuilder 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 - maximum number of records to return

Returns:

this builder instance for chaining

order

public EffectsRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order

Returns:

this builder instance for chaining