org.marketcetera.client

Interface Service

All Superinterfaces:

org.marketcetera.util.ws.stateful.ServiceBase, org.marketcetera.util.ws.stateless.StatelessServiceBase

public interface Service
extends org.marketcetera.util.ws.stateful.ServiceBase

The application's web services.

Since:

1.0.0

Version:

$Id: Service.java 17374 2017-04-07 19:53:35Z colin $

Author:

tlerios@marketcetera.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROKER_STATUS_TOPIC The topic on which the client receives broker status notifications.
static String	MARKET_DATA_REQUEST_TOPIC the queue on which the client receives server market data requests
static String	REPLY_TOPIC_PREFIX The prefix of the topic on which the client receives server replies.
static String	REQUEST_QUEUE The queue on which the client places orders for the server.

Method Summary

Modifier and Type	Method and Description
void	addReport(org.marketcetera.util.ws.stateful.ClientContext inContext, FIXMessageWrapper inReport, BrokerID inBrokerID, Hierarchy inHierarchy) Adds the given report to the system data flow.
void	deleteReport(org.marketcetera.util.ws.stateful.ClientContext inContext, ExecutionReportImpl inReport) Removes the given report from the persistent report store.
org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Currency>,BigDecimal>	getAllCurrencyPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date) Returns all the open positions for currency instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Equity>,BigDecimal>	getAllEquityPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date) Returns all the open positions for equity instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Future>,BigDecimal>	getAllFuturePositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext inContext, org.marketcetera.util.ws.wrappers.DateWrapper inDate) Returns all the open positions for future instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Option>,BigDecimal>	getAllOptionPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date) Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each tuple on or before the supplied date in UTC, and which are visible to the given user.
BrokersStatus	getBrokersStatus(org.marketcetera.util.ws.stateful.ClientContext context) Returns the server's broker status to the client with the given context.
BigDecimal	getCurrencyPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date, Currency currency) Returns the position of the supplied currency instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
BigDecimal	getEquityPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date, Equity equity) Returns the position of the supplied equity instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
BigDecimal	getFuturePositionAsOf(org.marketcetera.util.ws.stateful.ClientContext inContext, org.marketcetera.util.ws.wrappers.DateWrapper inDate, Future inFuture) Returns the position of the supplied future instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.
String	getNextOrderID(org.marketcetera.util.ws.stateful.ClientContext context) Returns the next server order ID to the client with the given context.
List<ReportBaseImpl>	getOpenOrders(org.marketcetera.util.ws.stateful.ClientContext inContext) Gets the list of open orders visible to the current user.
BigDecimal	getOptionPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date, Option option) 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.
org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Option>,BigDecimal>	getOptionPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date, String... rootSymbols) Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each tuple on or before the supplied date in UTC, and which are visible to the given user.
Collection<String>	getOptionRoots(org.marketcetera.util.ws.stateful.ClientContext context, String inUnderlying) Returns the collection of known option roots for the underlying symbol.
ReportBaseImpl[]	getReportsSince(org.marketcetera.util.ws.stateful.ClientContext context, org.marketcetera.util.ws.wrappers.DateWrapper date) Returns all the reports (execution report and order cancel rejects) generated and received by the server since the supplied date to the client with the given context.
OrderID	getRootOrderIdFor(org.marketcetera.util.ws.stateful.ClientContext inServiceContext, OrderID inOrderID) Gets the order ID of the root order in the given order chain.
String	getUnderlying(org.marketcetera.util.ws.stateful.ClientContext context, String optionRoot) Returns the underlying symbol for the supplied option root, if a mapping is found for it.
String	getUserData(org.marketcetera.util.ws.stateful.ClientContext inContext) Gets the user data associated with the current user.
UserInfo	getUserInfo(org.marketcetera.util.ws.stateful.ClientContext context, UserID id) Returns the information of the user with the given ID to the client with the given context.
void	heartbeat(org.marketcetera.util.ws.stateful.ClientContext context) Sends a heartbeat to the server.
Instrument	resolveSymbol(org.marketcetera.util.ws.stateful.ClientContext inContext, String inSymbol) Resolves the given symbol to an instrument.
void	setUserData(org.marketcetera.util.ws.stateful.ClientContext inContext, String inData) Sets the user data associated with the current user.

Field Detail

REPLY_TOPIC_PREFIX

static final String REPLY_TOPIC_PREFIX

The prefix of the topic on which the client receives server replies.

See Also:

Constant Field Values

BROKER_STATUS_TOPIC

static final String BROKER_STATUS_TOPIC

The topic on which the client receives broker status notifications.

See Also:

Constant Field Values

REQUEST_QUEUE

static final String REQUEST_QUEUE

The queue on which the client places orders for the server.

See Also:

Constant Field Values

MARKET_DATA_REQUEST_TOPIC

static final String MARKET_DATA_REQUEST_TOPIC

the queue on which the client receives server market data requests

See Also:

Constant Field Values

Method Detail

getBrokersStatus

BrokersStatus getBrokersStatus(org.marketcetera.util.ws.stateful.ClientContext context)
                        throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the server's broker status to the client with the given context.

Parameters:

context - The context.

Returns:

The status.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getUserInfo

UserInfo getUserInfo(org.marketcetera.util.ws.stateful.ClientContext context,
                     UserID id)
              throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the information of the user with the given ID to the client with the given context.

Parameters:

context - The context.

id - The user ID.

Returns:

The information.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getReportsSince

ReportBaseImpl[] getReportsSince(org.marketcetera.util.ws.stateful.ClientContext context,
                                 org.marketcetera.util.ws.wrappers.DateWrapper date)
                          throws org.marketcetera.util.ws.wrappers.RemoteException

Returns all the reports (execution report and order cancel rejects) generated and received by the server since the supplied date to the client with the given context.

Parameters:

context - The context.

date - The date, in UTC.

Returns:

The reports.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getEquityPositionAsOf

BigDecimal getEquityPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                 org.marketcetera.util.ws.wrappers.DateWrapper date,
                                 Equity equity)
                          throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the position of the supplied equity instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

context - The context.

date - The date, in UTC.

equity - The equity instrument.

Returns:

The position.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getAllEquityPositionsAsOf

org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Equity>,BigDecimal> getAllEquityPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                                                                                       org.marketcetera.util.ws.wrappers.DateWrapper date)
                                                                                                throws org.marketcetera.util.ws.wrappers.RemoteException

Returns all the open positions for equity instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

context - The context.

date - The date, in UTC.

Returns:

The open positions.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getCurrencyPositionAsOf

BigDecimal getCurrencyPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                   org.marketcetera.util.ws.wrappers.DateWrapper date,
                                   Currency currency)
                            throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the position of the supplied currency instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

context - The context.

date - The date, in UTC.

currency - The currency instrument.

Returns:

The position.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getAllCurrencyPositionsAsOf

org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Currency>,BigDecimal> getAllCurrencyPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                                                                                           org.marketcetera.util.ws.wrappers.DateWrapper date)
                                                                                                    throws org.marketcetera.util.ws.wrappers.RemoteException

Returns all the open positions for currency instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

context - The context.

date - The date, in UTC.

Returns:

The open positions.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getFuturePositionAsOf

BigDecimal getFuturePositionAsOf(org.marketcetera.util.ws.stateful.ClientContext inContext,
                                 org.marketcetera.util.ws.wrappers.DateWrapper inDate,
                                 Future inFuture)
                          throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the position of the supplied future instrument based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

inContext - The context.

inDate - The date, in UTC.

inFuture - The equity instrument.

Returns:

The position.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getAllFuturePositionsAsOf

org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Future>,BigDecimal> getAllFuturePositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext inContext,
                                                                                                       org.marketcetera.util.ws.wrappers.DateWrapper inDate)
                                                                                                throws org.marketcetera.util.ws.wrappers.RemoteException

Returns all the open positions for future instruments based on reports, generated and received on or before the supplied date in UTC to the client with the given context.

Parameters:

inContext - The context.

inDate - The date, in UTC.

Returns:

The open positions.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getOptionPositionAsOf

BigDecimal getOptionPositionAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                 org.marketcetera.util.ws.wrappers.DateWrapper date,
                                 Option option)
                          throws org.marketcetera.util.ws.wrappers.RemoteException

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.

Parameters:

context - The context.

date - The date, in UTC.

option - The option instrument.

Returns:

The position.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getAllOptionPositionsAsOf

org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Option>,BigDecimal> getAllOptionPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                                                                                       org.marketcetera.util.ws.wrappers.DateWrapper date)
                                                                                                throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the aggregate position of each option (option,account,actor) tuple based on all reports received for each tuple 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.

Parameters:

context - The context.

date - The date, in UTC.

Returns:

The open positions.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getOptionPositionsAsOf

org.marketcetera.util.ws.wrappers.MapWrapper<PositionKey<Option>,BigDecimal> getOptionPositionsAsOf(org.marketcetera.util.ws.stateful.ClientContext context,
                                                                                                    org.marketcetera.util.ws.wrappers.DateWrapper date,
                                                                                                    String... rootSymbols)
                                                                                             throws org.marketcetera.util.ws.wrappers.RemoteException

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

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

Parameters:

context - The context.

date - The date, in UTC.

rootSymbols - The option root symbols.

Returns:

The open positions.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getNextOrderID

String getNextOrderID(org.marketcetera.util.ws.stateful.ClientContext context)
               throws org.marketcetera.util.ws.wrappers.RemoteException

Returns the next server order ID to the client with the given context.

Parameters:

context - The context.

Returns:

The next order ID.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getUnderlying

String getUnderlying(org.marketcetera.util.ws.stateful.ClientContext context,
                     String optionRoot)
              throws org.marketcetera.util.ws.wrappers.RemoteException

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

Parameters:

context - The context.

optionRoot - The option root symbol.

Returns:

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

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getOptionRoots

Collection<String> getOptionRoots(org.marketcetera.util.ws.stateful.ClientContext context,
                                  String inUnderlying)
                           throws org.marketcetera.util.ws.wrappers.RemoteException

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

Parameters:

context - The context.

inUnderlying - The underlying symbol.

Returns:

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

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

heartbeat

void heartbeat(org.marketcetera.util.ws.stateful.ClientContext context)
        throws org.marketcetera.util.ws.wrappers.RemoteException

Sends a heartbeat to the server.

Parameters:

context - The context.

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - Thrown if the operation cannot be completed.

getUserData

String getUserData(org.marketcetera.util.ws.stateful.ClientContext inContext)
            throws org.marketcetera.util.ws.wrappers.RemoteException

Gets the user data associated with the current user.

Parameters:

inContext - a ClientContent value

Returns:

a String value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if the operation cannot be completed

setUserData

void setUserData(org.marketcetera.util.ws.stateful.ClientContext inContext,
                 String inData)
          throws org.marketcetera.util.ws.wrappers.RemoteException

Sets the user data associated with the current user.

Parameters:

inContext - a ClientContent value

inData - a String value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if the operation cannot be completed

addReport

void addReport(org.marketcetera.util.ws.stateful.ClientContext inContext,
               FIXMessageWrapper inReport,
               BrokerID inBrokerID,
               Hierarchy inHierarchy)
        throws org.marketcetera.util.ws.wrappers.RemoteException

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

.

Parameters:

inContext - a ClientContent value

inReport - a FIXMessageWrapper value

inBrokerID - a BrokerID value

inHierarchy - a Hierarchy value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if an error occurs

deleteReport

void deleteReport(org.marketcetera.util.ws.stateful.ClientContext inContext,
                  ExecutionReportImpl inReport)
           throws org.marketcetera.util.ws.wrappers.RemoteException

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

.

Parameters:

inContext - a ClientContent value

inReport - an ExecutionReportImpl value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if an error occurs

resolveSymbol

Instrument resolveSymbol(org.marketcetera.util.ws.stateful.ClientContext inContext,
                         String inSymbol)
                  throws org.marketcetera.util.ws.wrappers.RemoteException

Resolves the given symbol to an instrument.

Parameters:

inContext - a ClientContext value

inSymbol - a String value

Returns:

an Instrument value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if an error occurs

getOpenOrders

List<ReportBaseImpl> getOpenOrders(org.marketcetera.util.ws.stateful.ClientContext inContext)
                            throws org.marketcetera.util.ws.wrappers.RemoteException

Gets the list of open orders visible to the current user.

Parameters:

inContext - a ClientContext value

Returns:

a List<ReportBaseImpl> value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if an error occurs

getRootOrderIdFor

OrderID getRootOrderIdFor(org.marketcetera.util.ws.stateful.ClientContext inServiceContext,
                          OrderID inOrderID)
                   throws org.marketcetera.util.ws.wrappers.RemoteException

Gets the order ID of the root order in the given order chain.

Parameters:

inServiceContext - a ClientContext value

inOrderID - an OrderID value

Returns:

an OrderID value

Throws:

org.marketcetera.util.ws.wrappers.RemoteException - if an error occurs