org.marketcetera.client.rpc

Class RpcClientImpl

java.lang.Object

org.marketcetera.client.ClientImpl

org.marketcetera.client.rpc.RpcClientImpl

All Implemented Interfaces:

ExceptionListener, Client

@ThreadSafe
public class RpcClientImpl
extends ClientImpl

Provides an RPC implementation of Client.

This client replaces the web services component of the standard client, not the JMS component.

Since:

2.4.0

Version:

$Id: RpcClientImpl.java 16952 2014-10-10 22:43:57Z colin $

Author:

Colin DuPlantis

Nested Class Summary

Nested classes/interfaces inherited from class org.marketcetera.client.ClientImpl

ClientImpl.BrokerStatusReceiver, ClientImpl.TradeMessageReceiver

Field Summary

Fields inherited from class org.marketcetera.client.ClientImpl

mParameters

Constructor Summary

Constructors

Constructor and Description
RpcClientImpl(ClientParameters inParameters) Create a new RpcClientImpl instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addReport(FIXMessageWrapper inReport, BrokerID inBrokerID, Hierarchy inHierarchy) Adds the given report to the system data flow.
void	close() Closes the connection to the server.
protected void	closeWebServices() Closes the web service.
protected void	connectJms() Connects the JMS service.
protected void	connectWebServices() Connects the web services.
void	deleteReport(ExecutionReportImpl inReport) Removes the given report from the persistent report store.
OrderID	findRootOrderIdFor(OrderID inOrderID) Find the root order ID for the order chain of the given order ID.
Map<PositionKey<Currency>,BigDecimal>	getAllCurrencyPositionsAsOf(Date inDate) Returns all open currency positions based on reports, generated and received on or before the supplied date in UTC.
Map<PositionKey<Equity>,BigDecimal>	getAllEquityPositionsAsOf(Date inDate) Returns all open equity positions based on reports, generated and received on or before the supplied date in UTC.
Map<PositionKey<Future>,BigDecimal>	getAllFuturePositionsAsOf(Date inDate) Returns all open future positions based on reports, generated and received on or before the supplied date in UTC.
Map<PositionKey<Option>,BigDecimal>	getAllOptionPositionsAsOf(Date inDate) Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each option instrument on or before the supplied date in UTC and which are visible to the given user.
BrokersStatus	getBrokersStatus() Returns the server's broker status.
BigDecimal	getCurrencyPositionAsOf(Date inDate, Currency inCurrency) Returns the position of the supplied currency based on reports, generated and received on or before the supplied date in UTC.
BigDecimal	getEquityPositionAsOf(Date inDate, Equity inEquity) Returns the position of the supplied equity based on reports, generated and received on or before the supplied date in UTC.
BigDecimal	getFuturePositionAsOf(Date inDate, Future inFuture) Returns the position of the supplied future based on reports, generated and received on or before the supplied date in UTC.
protected String	getNextServerID() Fetches the next orderID base from server.
List<ReportBaseImpl>	getOpenOrders() Gets all open orders visible to the current user.
BigDecimal	getOptionPositionAsOf(Date inDate, Option inOption) Gets the current aggregate position for the option instrument based on execution reports received on or before the supplied date in UTC, and which are visible to the given user.
Map<PositionKey<Option>,BigDecimal>	getOptionPositionsAsOf(Date inDate, String... inSymbols) Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each option instrument on or before the supplied date in UTC, and which are visible to the given user.
Collection<String>	getOptionRoots(String inUnderlying) Returns the collection of known option roots for the underlying symbol.
ReportBase[]	getReportsSince(Date inDate) Returns all the reports (execution report and order cancel rejects) generated and received by the server since the supplied date in UTC.
protected SessionId	getSessionId() Gets the session ID value.
String	getUnderlying(String inOptionRoot) Returns the underlying symbol for the supplied option root, if a mapping is found for it.
Properties	getUserData() Gets the user data associated with the current user.
UserInfo	getUserInfo(UserID inId, boolean inUseCache) Returns the information of the user with the given ID.
protected void	heartbeat() Executes a heartbeat.
protected void	reconnectWebServices() Reconnects the web service.
Instrument	resolveSymbol(String inSymbol) Resolves the given symbol to an Instrument.
void	setUserData(Properties inProperties) Sets the user data associated with the current user.
protected void	startJms() Starts the JMS connection.

Methods inherited from class org.marketcetera.client.ClientImpl

addBrokerStatusListener, addExceptionListener, addReportListener, addServerStatusListener, getLastConnectTime, getParameters, isCredentialsMatch, isServerAlive, onException, reconnect, reconnect, removeBrokerStatusListener, removeExceptionListener, removeReportListener, removeServerStatusListener, sendOrder, sendOrder, sendOrder, sendOrderRaw

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcClientImpl

public RpcClientImpl(ClientParameters inParameters)
              throws ConnectionException

Create a new RpcClientImpl instance.

Parameters:

inParameters - a ClientParameters value

Throws:

ConnectionException - if an error occurs connecting to the RPC client

Method Detail

getAllEquityPositionsAsOf

public Map<PositionKey<Equity>,BigDecimal> getAllEquityPositionsAsOf(Date inDate)
                                                              throws ConnectionException

Description copied from interface: Client

Returns all open equity positions based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getAllEquityPositionsAsOf in interface Client

Overrides:

getAllEquityPositionsAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

Returns:

the open equity positions. Includes non-zero positions only.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getEquityPositionAsOf

public BigDecimal getEquityPositionAsOf(Date inDate,
                               Equity inEquity)
                                 throws ConnectionException

Description copied from interface: Client

Returns the position of the supplied equity based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getEquityPositionAsOf in interface Client

Overrides:

getEquityPositionAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

inEquity - The equity. Cannot be null.

Returns:

the current position of the equity.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getCurrencyPositionAsOf

public BigDecimal getCurrencyPositionAsOf(Date inDate,
                                 Currency inCurrency)
                                   throws ConnectionException

Description copied from interface: Client

Returns the position of the supplied currency based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getCurrencyPositionAsOf in interface Client

Overrides:

getCurrencyPositionAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

inCurrency - The currency. Cannot be null.

Returns:

the current position of the currency.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getAllCurrencyPositionsAsOf

public Map<PositionKey<Currency>,BigDecimal> getAllCurrencyPositionsAsOf(Date inDate)
                                                                  throws ConnectionException

Description copied from interface: Client

Returns all open currency positions based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getAllCurrencyPositionsAsOf in interface Client

Overrides:

getAllCurrencyPositionsAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

Returns:

the open currency positions. Includes non-zero positions only.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getAllFuturePositionsAsOf

public Map<PositionKey<Future>,BigDecimal> getAllFuturePositionsAsOf(Date inDate)
                                                              throws ConnectionException

Description copied from interface: Client

Returns all open future positions based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getAllFuturePositionsAsOf in interface Client

Overrides:

getAllFuturePositionsAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

Returns:

the open future positions. Includes non-zero positions only.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getFuturePositionAsOf

public BigDecimal getFuturePositionAsOf(Date inDate,
                               Future inFuture)
                                 throws ConnectionException

Description copied from interface: Client

Returns the position of the supplied future based on reports, generated and received on or before the supplied date in UTC.

Specified by:

getFuturePositionAsOf in interface Client

Overrides:

getFuturePositionAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

inFuture - The future. Cannot be null.

Returns:

the current position of the future.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getOptionPositionAsOf

public BigDecimal getOptionPositionAsOf(Date inDate,
                               Option inOption)
                                 throws ConnectionException

Description copied from interface: Client

Gets the current aggregate position for the option instrument based on execution reports received on or before the supplied date in UTC, and which are visible to the given user.

Buy trades result in positive positions. All other kinds of trades result in negative positions.

Specified by:

getOptionPositionAsOf in interface Client

Overrides:

getOptionPositionAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

inOption - the option instrument

Returns:

the aggregate position for the option.

Throws:

ConnectionException - if there were errors retrieving the position.

getAllOptionPositionsAsOf

public Map<PositionKey<Option>,BigDecimal> getAllOptionPositionsAsOf(Date inDate)
                                                              throws ConnectionException

Description copied from interface: Client

Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each option instrument on or before the supplied date in UTC and which are visible to the given user.

Buy trades result in positive positions. All other kinds of trades result in negative positions.

Specified by:

getAllOptionPositionsAsOf in interface Client

Overrides:

getAllOptionPositionsAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

Returns:

the position map.

Throws:

ConnectionException - if there were errors retrieving the position map.

getOptionPositionsAsOf

public Map<PositionKey<Option>,BigDecimal> getOptionPositionsAsOf(Date inDate,
                                                         String... inSymbols)
                                                           throws ConnectionException

Description copied from interface: Client

Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each option instrument on or before the supplied date in UTC, and which are visible to the given user.

Buy trades result in positive positions. All other kinds of trades result in negative positions.

Specified by:

getOptionPositionsAsOf in interface Client

Overrides:

getOptionPositionsAsOf in class ClientImpl

Parameters:

inDate - the date in UTC. Cannot be null.

inSymbols - the list of option root symbols.

Returns:

the position map.

Throws:

ConnectionException - if there were errors retrieving the position map.

getUnderlying

public String getUnderlying(String inOptionRoot)
                     throws ConnectionException

Description copied from interface: Client

Returns the underlying symbol for the supplied option root, if a mapping is found for it. Null otherwise.

The mapping is retrieved from the server the first time an option root symbol is specified. The value returned by the server is cached on the client for all subsequent invocations for the same root symbol. All the cached values are cleared when the client is closed.

Specified by:

getUnderlying in interface Client

Overrides:

getUnderlying in class ClientImpl

Parameters:

inOptionRoot - The option root symbol.

Returns:

The underlying symbol for the supplied option root. null, if no mapping was found.

Throws:

ConnectionException - if there were errors retrieving the underlying symbol.

getOptionRoots

public Collection<String> getOptionRoots(String inUnderlying)
                                  throws ConnectionException

Description copied from interface: Client

Returns the collection of known option roots for the underlying symbol.

The mapping is retrieved from the server the first time an underlying symbol is specified. The value returned by the server is cached on the client for all subsequent invocations for the same underlying symbol. All the cached values are cleared when the client is closed.

Specified by:

getOptionRoots in interface Client

Overrides:

getOptionRoots in class ClientImpl

Parameters:

inUnderlying - The underlying symbol.

Returns:

The sorted collection of option roots if mappings are found for the option root, null otherwise.

Throws:

ConnectionException - if there were errors retrieving the option roots.

resolveSymbol

public Instrument resolveSymbol(String inSymbol)
                         throws ConnectionException

Description copied from interface: Client

Resolves the given symbol to an Instrument.

Specified by:

resolveSymbol in interface Client

Overrides:

resolveSymbol in class ClientImpl

Parameters:

inSymbol - a String value

Returns:

an Instrument value

Throws:

ConnectionException - if an error occurs connecting to the server

findRootOrderIdFor

public OrderID findRootOrderIdFor(OrderID inOrderID)

Description copied from interface: Client

Find the root order ID for the order chain of the given order ID.

Specified by:

findRootOrderIdFor in interface Client

Overrides:

findRootOrderIdFor in class ClientImpl

Parameters:

inOrderID - an OrderID value

Returns:

an OrderID value

addReport

public void addReport(FIXMessageWrapper inReport,
             BrokerID inBrokerID,
             Hierarchy inHierarchy)
               throws ConnectionException

Description copied from interface: Client

Adds the given report to the system data flow.

Reports added this way will be added to the system data bus. Reports will be persisted and become part of the system record. All clients will receive this report.

This will affect reported positions

.

Specified by:

addReport in interface Client

Overrides:

addReport in class ClientImpl

Parameters:

inReport - a FIXMessageWrapper value

inBrokerID - a BrokerID value

inHierarchy - a Hierarchy value

Throws:

ConnectionException - if an error occurs connecting to the server

deleteReport

public void deleteReport(ExecutionReportImpl inReport)
                  throws ConnectionException

Description copied from interface: Client

Removes the given report from the persistent report store.

Reports removed this way will not be added to the system data bus and no clients will receive this report.

This will affect reported positions

.

Specified by:

deleteReport in interface Client

Overrides:

deleteReport in class ClientImpl

Parameters:

inReport - an ExecutionReportImpl value

Throws:

ConnectionException - if an error occurs connecting to the server

getUserData

public Properties getUserData()
                       throws ConnectionException

Description copied from interface: Client

Gets the user data associated with the current user.

Specified by:

getUserData in interface Client

Overrides:

getUserData in class ClientImpl

Returns:

a Properties value

Throws:

ConnectionException - if an error occurs connecting to the server

setUserData

public void setUserData(Properties inProperties)
                 throws ConnectionException

Description copied from interface: Client

Sets the user data associated with the current user.

Specified by:

setUserData in interface Client

Overrides:

setUserData in class ClientImpl

Parameters:

inProperties - a Properties value

Throws:

ConnectionException - if an error occurs connecting to the server

getUserInfo

public UserInfo getUserInfo(UserID inId,
                   boolean inUseCache)
                     throws ConnectionException

Description copied from interface: Client

Returns the information of the user with the given ID. A local cache can be used to avoid frequent server roundtrips, but it may return stale information. The cache is updated whether or not it was used for retrieval.

All cached values are cleared when the client is closed.

Specified by:

getUserInfo in interface Client

Overrides:

getUserInfo in class ClientImpl

Parameters:

inId - The user ID.

inUseCache - True if the local cache should be used.

Returns:

The information.

Throws:

ConnectionException - Thrown if the operation cannot be completed.

getReportsSince

public ReportBase[] getReportsSince(Date inDate)
                             throws ConnectionException

Description copied from interface: Client

Returns all the reports (execution report and order cancel rejects) generated and received by the server since the supplied date in UTC.

Specified by:

getReportsSince in interface Client

Overrides:

getReportsSince in class ClientImpl

Parameters:

inDate - The date in UTC. Cannot be null.

Returns:

All the reports since the supplied date, may be empty.

Throws:

ConnectionException - if there were connection errors fetching data from the server.

getOpenOrders

public List<ReportBaseImpl> getOpenOrders()
                                   throws ConnectionException

Description copied from interface: Client

Gets all open orders visible to the current user.

Specified by:

getOpenOrders in interface Client

Overrides:

getOpenOrders in class ClientImpl

Returns:

a List<ReportBaseImpl> value

Throws:

ConnectionException - if an error occurs connecting to the server

getBrokersStatus

public BrokersStatus getBrokersStatus()
                               throws ConnectionException

Description copied from interface: Client

Returns the server's broker status.

Specified by:

getBrokersStatus in interface Client

Overrides:

getBrokersStatus in class ClientImpl

Returns:

The status.

Throws:

ConnectionException - Thrown if the operation cannot be completed.

close

public void close()

Description copied from interface: Client

Closes the connection to the server. The behavior of any of the methods of this class after this method is invoked is undefined.

Specified by:

close in interface Client

Overrides:

close in class ClientImpl

getNextServerID

protected String getNextServerID()
                          throws RemoteException

Description copied from class: ClientImpl

Fetches the next orderID base from server.

Overrides:

getNextServerID in class ClientImpl

Returns:

the next orderID base from server.

Throws:

RemoteException - if there were communication errors.

heartbeat

protected void heartbeat()
                  throws RemoteException

Description copied from class: ClientImpl

Executes a heartbeat.

Overrides:

heartbeat in class ClientImpl

Throws:

RemoteException - if the heartbeat cannot be executed

getSessionId

protected SessionId getSessionId()

Description copied from class: ClientImpl

Gets the session ID value.

Overrides:

getSessionId in class ClientImpl

Returns:

a SessionId value

connectWebServices

protected void connectWebServices()
                           throws I18NException,
                                  RemoteException

Description copied from class: ClientImpl

Connects the web services.

Overrides:

connectWebServices in class ClientImpl

Throws:

I18NException - if an error occurs connecting

RemoteException - if an error occurs connecting

reconnectWebServices

protected void reconnectWebServices()
                             throws RemoteException

Description copied from class: ClientImpl

Reconnects the web service.

Overrides:

reconnectWebServices in class ClientImpl

Throws:

RemoteException - if an error occurs reconnecting

closeWebServices

protected void closeWebServices()
                         throws RemoteException

Description copied from class: ClientImpl

Closes the web service.

Overrides:

closeWebServices in class ClientImpl

Throws:

RemoteException - if an error occurs closing

connectJms

protected void connectJms()
                   throws JAXBException

Description copied from class: ClientImpl

Connects the JMS service.

Overrides:

connectJms in class ClientImpl

Throws:

JAXBException - if an error occurs connecting to the JMS service

startJms

protected void startJms()
                 throws JAXBException

Description copied from class: ClientImpl

Starts the JMS connection.

Overrides:

startJms in class ClientImpl

Throws:

JAXBException - if an error occurs starting the JMS connection