Package org.stellar.sdk.federation

Class Federation

java.lang.Object

org.stellar.sdk.federation.Federation

public class Federation
extends Object

Helper class for resolving Stellar addresses

See Also:

• Federation

Constructor Summary

Constructors

Constructor	Description
Federation()	Creates a new Federation instance with a default OkHttpClient.
Federation(okhttp3.OkHttpClient httpClient)	Creates a new Federation instance.

Method Summary

Modifier and Type	Method	Description
FederationResponse	resolveAccountId(String accountId, String domain)	Resolves the given Stellar account ID to federation record if the user was found for a given Stellar account ID.
FederationResponse	resolveAddress(String address)	Resolves the given address to federation record if the user was found for a given Stellar address.

Methods inherited from class java.lang.Object

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

Constructor Details

Federation

public Federation(okhttp3.OkHttpClient httpClient)

Creates a new Federation instance.

Parameters:

httpClient - OkHttpClient

Federation

public Federation()

Creates a new Federation instance with a default OkHttpClient.

Method Details

resolveAddress

public FederationResponse resolveAddress(String address)

Resolves the given address to federation record if the user was found for a given Stellar address.

Parameters:

address - Stellar address (e.g. `bob*stellar.org`).

Returns:

FederationResponse

Throws:

IllegalArgumentException - Address is malformed

NetworkException - All the exceptions below are subclasses of NetworkError

NotFoundException - Stellar address not found in the federation server

StellarTomlNotFoundInvalidException - Stellar.toml file not found or invalid

NoFederationServerException - No federation server defined in stellar.toml file

FederationServerInvalidException - Federation server is invalid

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.

resolveAccountId

public FederationResponse resolveAccountId(String accountId,
 String domain)

Resolves the given Stellar account ID to federation record if the user was found for a given Stellar account ID.

Parameters:

accountId - Stellar account ID. (e.g. `GAVHK7L...`)

domain - The domain to get the federation server URI from. (e.g. `example.com`)

Returns:

FederationResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

NotFoundException - Stellar address not found in the federation server

StellarTomlNotFoundInvalidException - Stellar.toml file not found or invalid

FederationServerInvalidException - Federation server is invalid

NoFederationServerException - No federation server defined in stellar.toml file

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.