Package org.stellar.sdk.requests

Class StrictSendPathsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.StrictSendPathsRequestBuilder

public class StrictSendPathsRequestBuilder
extends RequestBuilder

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

Finds payment paths where the source amount is fixed. Specify either a destination account or a set of destination assets, along with the source 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
StrictSendPathsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
StrictSendPathsRequestBuilder	destinationAccount(String account)	Sets the destination account whose assets will be accepted as the end point for path finding.
StrictSendPathsRequestBuilder	destinationAssets(List<Asset> assets)	Sets the destination assets to consider as the end point for path finding.
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.
StrictSendPathsRequestBuilder	sourceAmount(String amount)	Sets the fixed source amount the sender wants to spend.
StrictSendPathsRequestBuilder	sourceAsset(Asset asset)	Sets the asset the sender wants to send.

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

StrictSendPathsRequestBuilder

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

Method Details

destinationAccount

public StrictSendPathsRequestBuilder destinationAccount(String account)

Sets the destination account whose assets will be accepted as the end point for path finding. Mutually exclusive with destinationAssets(List).

Parameters:

account - the destination account ID

Returns:

this builder instance for chaining

Throws:

IllegalArgumentException - if destination_assets has already been set

destinationAssets

public StrictSendPathsRequestBuilder destinationAssets(List<Asset> assets)

Sets the destination assets to consider as the end point for path finding. Mutually exclusive with destinationAccount(String).

Parameters:

assets - the list of destination assets

Returns:

this builder instance for chaining

Throws:

IllegalArgumentException - if destination_account has already been set

sourceAmount

public StrictSendPathsRequestBuilder sourceAmount(String amount)

Sets the fixed source amount the sender wants to spend.

Parameters:

amount - the source amount

Returns:

this builder instance for chaining

sourceAsset

public StrictSendPathsRequestBuilder sourceAsset(Asset asset)

Sets the asset the sender wants to send.

Parameters:

asset - the source 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.