Package org.stellar.sdk.federation

Class FederationServer

java.lang.Object

org.stellar.sdk.federation.FederationServer

public class FederationServer
extends Object

FederationServer handles a network connection to a federation server instance and exposes an interface for requests to that instance.

For resolving a stellar address without knowing which federation server to query use Federation.resolve(String).

See Also:

• Federation docs

Constructor Summary

Constructors

Constructor	Description
FederationServer(String serverUri, String domain)	Creates a new FederationServer instance.
FederationServer(URI serverUri, String domain)	Creates a new FederationServer instance.

Method Summary

Modifier and Type	Method	Description
static FederationServer	createForDomain(String domain)	Creates a FederationServer instance for a given domain.
String	getDomain()	Returns a domain this server is responsible for.
okhttp3.HttpUrl	getServerUri()	Returns a federation server URI.
FederationResponse	resolveAddress(String address)	Resolves a stellar address using a given federation server.

Methods inherited from class java.lang.Object

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

Constructor Details

FederationServer

public FederationServer(URI serverUri,
 String domain)

Creates a new FederationServer instance.

Parameters:

serverUri - Federation Server URI

domain - Domain name this federation server is responsible for

Throws:

FederationServerInvalidException - Federation server is invalid (malformed URL, not HTTPS, etc.)

FederationServer

public FederationServer(String serverUri,
 String domain)

Creates a new FederationServer instance.

Parameters:

serverUri - Federation Server URI

domain - Domain name this federation server is responsible for

Throws:

FederationServerInvalidException - Federation server is invalid (malformed URL, not HTTPS, etc.)

Method Details

createForDomain

public static FederationServer createForDomain(String domain)

Creates a FederationServer instance for a given domain. It tries to find a federation server URL in stellar.toml file.

Parameters:

domain - Domain to find a federation server for

Returns:

FederationServer

Throws:

ConnectionErrorException - Connection problems

NoFederationServerException - Stellar.toml does not contain federation server info

FederationServerInvalidException - Federation server is invalid (malformed URL, not HTTPS, etc.)

StellarTomlNotFoundInvalidException - Stellar.toml file was not found or was malformed.

See Also:

• Stellar.toml docs

resolveAddress

public FederationResponse resolveAddress(String address)

Resolves a stellar address using a given federation server.

Parameters:

address - Stellar addres, like bob*stellar.org

Returns:

FederationResponse

Throws:

MalformedAddressException - Address is malformed

ConnectionErrorException - Connection problems

NotFoundException - Stellar address not found by federation server

ServerErrorException - Federation server responded with error

getServerUri

public okhttp3.HttpUrl getServerUri()

Returns a federation server URI.

getDomain

public String getDomain()

Returns a domain this server is responsible for.