Package org.stellar.sdk.requests

Class StrictReceivePathsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.StrictReceivePathsRequestBuilder

public class StrictReceivePathsRequestBuilder
extends RequestBuilder

Builds requests to the Horizon /paths/strict-receive endpoint.

Finds payment paths where the destination amount is fixed. Specify either a source account or a set of source assets, along with the destination asset and amount, to discover available payment paths.

See Also:

• Horizon API reference

Nested Class Summary

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

RequestBuilder.Order

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrictReceivePathsRequestBuilder	destinationAccount(String account)	Sets the destination account for the path payment.
StrictReceivePathsRequestBuilder	destinationAmount(String amount)	Sets the fixed destination amount the recipient should receive.
StrictReceivePathsRequestBuilder	destinationAsset(Asset asset)	Sets the asset the recipient wants to receive.
Page<PathResponse>	execute()	Build and execute request.
static Page<PathResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)	Requests specific uri and returns Page of PathResponse.
StrictReceivePathsRequestBuilder	sourceAccount(String account)	Sets the source account whose assets will be used as the starting point for path finding.
StrictReceivePathsRequestBuilder	sourceAssets(List<Asset> assets)	Sets the source assets to consider as the starting point for path finding.

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

cursor, limit, order, setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Details

StrictReceivePathsRequestBuilder

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

Method Details

destinationAccount

public StrictReceivePathsRequestBuilder destinationAccount(String account)

Sets the destination account for the path payment.

Parameters:

account - the destination account ID

Returns:

this builder instance for chaining

sourceAccount

public StrictReceivePathsRequestBuilder sourceAccount(String account)

Sets the source account whose assets will be used as the starting point for path finding. Mutually exclusive with sourceAssets(List).

Parameters:

account - the source account ID

Returns:

this builder instance for chaining

Throws:

IllegalArgumentException - if source_assets has already been set

sourceAssets

public StrictReceivePathsRequestBuilder sourceAssets(List<Asset> assets)

Sets the source assets to consider as the starting point for path finding. Mutually exclusive with sourceAccount(String).

Parameters:

assets - the list of source assets

Returns:

this builder instance for chaining

Throws:

IllegalArgumentException - if source_account has already been set

destinationAmount

public StrictReceivePathsRequestBuilder destinationAmount(String amount)

Sets the fixed destination amount the recipient should receive.

Parameters:

amount - the destination amount

Returns:

this builder instance for chaining

destinationAsset

public StrictReceivePathsRequestBuilder destinationAsset(Asset asset)

Sets the asset the recipient wants to receive.

Parameters:

asset - the destination asset

Returns:

this builder instance for chaining

execute

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

Requests specific uri and returns Page of PathResponse.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of PathResponse

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.

execute

public Page<PathResponse> execute()

Build and execute request.

Returns:

Page of PathResponse

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.