com.xeiam.xchange

Class BaseExchange

java.lang.Object

com.xeiam.xchange.BaseExchange

All Implemented Interfaces:

Exchange

Direct Known Subclasses:

ANXExchange, BitbayExchange, BitcoinAverageExchange, BitcoinChartsExchange, BitcoindeExchange, BitcoiniumExchange, BitcurexExchange, BitfinexExchange, BitKonanExchange, BitMarketExchange, BitsoExchange, BitstampExchange, BittrexExchange, BleutradeExchange, BlockchainExchange, Btc38Exchange, BTCCentralExchange, BTCEExchange, BTCTradeExchange, BTERExchange, CampBXExchange, CexIOExchange, CleverCoinExchange, CoinbaseExchange, CoinbaseExExchange, CoinfloorExchange, CoinmateExchange, CointraderExchange, CryptonitExchange, CryptsyExchange, EmpoExExchange, HitbtcExchange, IndependentReserveExchange, ItBitExchange, JubiExchange, KrakenExchange, LakeBTCExchange, LoyalbitExchange, MercadoBitcoinExchange, MeXBTExchange, OERExchange, OkCoinExchange, PoloniexExchange, QuoineExchange, RippleExchange, TaurusExchange, TheRockExchange, VircurexExchange, VirtExExchange, YacunaExchange

public abstract class BaseExchange
extends Object
implements Exchange

Field Summary

Fields

Modifier and Type	Field and Description
protected ExchangeSpecification	exchangeSpecification
protected org.slf4j.Logger	logger
protected ExchangeMetaData	metaData
protected PollingAccountService	pollingAccountService
protected PollingMarketDataService	pollingMarketDataService
protected PollingTradeService	pollingTradeService
protected StreamingExchangeService	streamingExchangeService

Constructor Summary

Constructors

Constructor and Description
BaseExchange()

Method Summary

Modifier and Type	Method and Description
void	applySpecification(ExchangeSpecification exchangeSpecification) Applies any exchange specific parameters
ExchangeSpecification	getExchangeSpecification()
ExchangeMetaData	getMetaData() The MetaData defining some semi-static properties of an exchange such as currency pairs, trading fees, etc.
String	getMetaDataFileName(ExchangeSpecification exchangeSpecification)
PollingAccountService	getPollingAccountService() An account service typically provides access to the user's private exchange data
PollingMarketDataService	getPollingMarketDataService() A market data service typically consists of a regularly updated list of the available prices for the various symbols
PollingTradeService	getPollingTradeService() An trade service typically provides access to trading functionality
StreamingExchangeService	getStreamingExchangeService(ExchangeStreamingConfiguration configuration) A market data service typically consists of a regularly updated list of the available prices for the various symbols
protected void	initServices()
protected void	loadExchangeMetaData(InputStream is)
protected void	loadMetaData(InputStream is)
protected <T> T	loadMetaData(InputStream is, Class<T> type)
void	remoteInit() Initialize this instance with the remote meta data.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xeiam.xchange.Exchange

getDefaultExchangeSpecification, getNonceFactory

Field Detail

logger

protected final org.slf4j.Logger logger

exchangeSpecification

protected ExchangeSpecification exchangeSpecification

metaData

protected ExchangeMetaData metaData

pollingMarketDataService

protected PollingMarketDataService pollingMarketDataService

pollingTradeService

protected PollingTradeService pollingTradeService

pollingAccountService

protected PollingAccountService pollingAccountService

streamingExchangeService

protected StreamingExchangeService streamingExchangeService

Constructor Detail

BaseExchange

public BaseExchange()

Method Detail

applySpecification

public void applySpecification(ExchangeSpecification exchangeSpecification)

Description copied from interface: Exchange

Applies any exchange specific parameters

Specified by:

applySpecification in interface Exchange

Parameters:

exchangeSpecification - The ExchangeSpecification

initServices

protected void initServices()

remoteInit

public void remoteInit()
                throws IOException,
                       ExchangeException

Description copied from interface: Exchange

Initialize this instance with the remote meta data. Most exchanges require this method to be called before Exchange.getMetaData(). Some exchanges require it before using some of their services.

Specified by:

remoteInit in interface Exchange

Throws:

IOException

ExchangeException

loadMetaData

protected void loadMetaData(InputStream is)

loadMetaData

protected <T> T loadMetaData(InputStream is,
                             Class<T> type)

loadExchangeMetaData

protected void loadExchangeMetaData(InputStream is)

getMetaDataFileName

public String getMetaDataFileName(ExchangeSpecification exchangeSpecification)

getExchangeSpecification

public ExchangeSpecification getExchangeSpecification()

Specified by:

getExchangeSpecification in interface Exchange

Returns:

The ExchangeSpecification in use for this exchange

getMetaData

public ExchangeMetaData getMetaData()

Description copied from interface: Exchange

The MetaData defining some semi-static properties of an exchange such as currency pairs, trading fees, etc.

Specified by:

getMetaData in interface Exchange

Returns:

getPollingMarketDataService

public PollingMarketDataService getPollingMarketDataService()

Description copied from interface: Exchange

A market data service typically consists of a regularly updated list of the available prices for the various symbols

This is the non-streaming (blocking) version of the service

Specified by:

getPollingMarketDataService in interface Exchange

Returns:

The exchange's market data service

getPollingTradeService

public PollingTradeService getPollingTradeService()

Description copied from interface: Exchange

An trade service typically provides access to trading functionality

Typically access is restricted by a secret API key and/or username password authentication which are usually provided in the ExchangeSpecification

Specified by:

getPollingTradeService in interface Exchange

Returns:

The exchange's polling trade service

getPollingAccountService

public PollingAccountService getPollingAccountService()

Description copied from interface: Exchange

An account service typically provides access to the user's private exchange data

Typically access is restricted by a secret API key and/or username password authentication which are usually provided in the ExchangeSpecification

Specified by:

getPollingAccountService in interface Exchange

Returns:

The exchange's polling account service

getStreamingExchangeService

public StreamingExchangeService getStreamingExchangeService(ExchangeStreamingConfiguration configuration)

Description copied from interface: Exchange

A market data service typically consists of a regularly updated list of the available prices for the various symbols

This is the streaming (non-blocking and event driven) version of the service, and requires an application to provide a suitable implementation of the listener to allow event callbacks to take place.

Specified by:

getStreamingExchangeService in interface Exchange

Parameters:

configuration - The exchange-specific configuration to be applied after creation

Returns:

The exchange's "push" market data service

toString

public String toString()

Overrides:

toString in class Object