ClientImpl (Client Libraries 2.4.0 API)

java.lang.Object
- org.marketcetera.client.ClientImpl

All Implemented Interfaces:

javax.jms.ExceptionListener, Client

Direct Known Subclasses:

RpcClientImpl
```
public class ClientImpl
extends Object
implements Client, javax.jms.ExceptionListener
```
The implementation of Client that connects to the server.

Since:

1.0.0

Version:

$Id: ClientImpl.java 16888 2014-04-22 18:32:36Z colin $

Author:

anshul@marketcetera.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ClientImpl.BrokerStatusReceiver

class ClientImpl.TradeMessageReceiver

Nested Classes
Modifier and Type	Class and Description
`class`	`ClientImpl.BrokerStatusReceiver`
`class`	`ClientImpl.TradeMessageReceiver`

Field Summary

Fields
Modifier and Type Field and Description

protected ClientParameters mParameters

Fields
Modifier and Type	Field and Description
`protected ClientParameters`	`mParameters`

Constructor Summary

Constructors
Constructor and Description

ClientImpl(ClientParameters inParameters)
Creates an instance given the parameters and connects to the server.

Constructors
Constructor and Description
`ClientImpl(ClientParameters inParameters)` Creates an instance given the parameters and connects to the server.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBrokerStatusListener(BrokerStatusListener listener)` Adds a broker status listener, which receives all the broker status changes sent out by the server.
`void`	`addExceptionListener(ExceptionListener inListener)` Adds an exception listener.
`void`	`addReport(FIXMessageWrapper inReport, BrokerID inBrokerID, Hierarchy inHierarchy)` Adds the given report to the system data flow.
`void`	`addReportListener(ReportListener inListener)` Adds a report listener.
`void`	`addServerStatusListener(ServerStatusListener listener)` Adds a server connection status listener, which receives all the server connection status changes.
`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.
`Date`	`getLastConnectTime()` Returns the last time the client was successfully connected or reconnected to the server.
`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.
`ClientParameters`	`getParameters()` Returns the parameters that client is using to connect to the server.
`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 id, boolean useCache)` Returns the information of the user with the given ID.
`protected void`	`heartbeat()` Executes a heartbeat.
`boolean`	`isCredentialsMatch(String inUsername, char[] inPassword)` Returns true if the supplied user name, password match the credentials used to connect to the server.
`boolean`	`isServerAlive()` Returns true if client has a live connection to the server.
`void`	`onException(javax.jms.JMSException e)`
`void`	`reconnect()` Disconnects the connection to the server and reconnects back using the same properties as were supplied when creating this instance.
`void`	`reconnect(ClientParameters inParameters)` Disconnects the connection to the server and reconnects back using the properties supplied to this method.
`protected void`	`reconnectWebServices()` Reconnects the web service.
`void`	`removeBrokerStatusListener(BrokerStatusListener listener)` Removes a broker status listener that was previously added via `Client.addBrokerStatusListener(BrokerStatusListener)`.
`void`	`removeExceptionListener(ExceptionListener inListener)` Removes exception listener that was previously added via `Client.addExceptionListener(java.beans.ExceptionListener)`.
`void`	`removeReportListener(ReportListener inListener)` Removes a report listener that was previously added via `Client.addReportListener(ReportListener)`.
`void`	`removeServerStatusListener(ServerStatusListener listener)` Removes a server connection status listener that was previously added via `Client.addServerStatusListener(ServerStatusListener)`.
`Instrument`	`resolveSymbol(String inSymbol)` Resolves the given symbol to an `Instrument`.
`void`	`sendOrder(OrderCancel inOrderCancel)` Sends the supplied order to the server.
`void`	`sendOrder(OrderReplace inOrderReplace)` Sends the supplied order to the server.
`void`	`sendOrder(OrderSingle inOrderSingle)` Sends the supplied order to the server.
`void`	`sendOrderRaw(FIXOrder inFIXOrder)` Sends the supplied FIX Message Order to the server.
`void`	`setUserData(Properties inProperties)` Sets the user data associated with the current user.
`protected void`	`startJms()` Starts the JMS connection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mParameters
```
protected volatile ClientParameters mParameters
```
- Constructor Detail
  - ClientImpl
```
public ClientImpl(ClientParameters inParameters)
           throws ConnectionException
```
    Creates an instance given the parameters and connects to the server.
    
    Parameters:
    inParameters - the parameters to connect to the server, cannot be null.
    
    Throws:
    
    ConnectionException - if there were errors connecting to the server.
- Method Detail
  - sendOrder
```
public void sendOrder(OrderSingle inOrderSingle)
               throws ConnectionException,
                      OrderValidationException
```
    Description copied from interface: Client
    
    Sends the supplied order to the server.
    
    Specified by:
    
    sendOrder in interface Client
    
    Parameters:
    inOrderSingle - The order to send.
    
    Throws:
    
    ConnectionException - if there were connection errors sending the order out to the server.
    
    OrderValidationException - if the order didn't have complete or consistent data to be sent to the server.
  - sendOrder
```
public void sendOrder(OrderReplace inOrderReplace)
               throws ConnectionException,
                      OrderValidationException
```
    Description copied from interface: Client
    
    Sends the supplied order to the server.
    
    Specified by:
    
    sendOrder in interface Client
    
    Parameters:
    inOrderReplace - The order to send.
    
    Throws:
    
    ConnectionException - if there were connection errors sending the order out to the server.
    
    OrderValidationException - if the orders didn't have complete or consistent data to be sent to the server.
  - sendOrder
```
public void sendOrder(OrderCancel inOrderCancel)
               throws ConnectionException,
                      OrderValidationException
```
    Description copied from interface: Client
    
    Sends the supplied order to the server.
    
    Specified by:
    
    sendOrder in interface Client
    
    Parameters:
    inOrderCancel - The order to send.
    
    Throws:
    
    ConnectionException - if there were connection errors sending the order out to the server.
    
    OrderValidationException - if the orders didn't have complete or consistent data to be sent to the server.
  - sendOrderRaw
```
public void sendOrderRaw(FIXOrder inFIXOrder)
                  throws ConnectionException,
                         OrderValidationException
```
    Description copied from interface: Client
    
    Sends the supplied FIX Message Order to the server.
    When supplying raw FIX Message, a brokerID has to be supplied
    
    Specified by:
    
    sendOrderRaw in interface Client
    
    Parameters:
    inFIXOrder - the raw FIX Order to send.
    
    Throws:
    
    ConnectionException - if there were connection errors sending the order to the server.
    
    OrderValidationException - if the supplied message was not of a type that's supported by the system.
  - addReportListener
```
public void addReportListener(ReportListener inListener)
```
    Description copied from interface: Client
    
    Adds a report listener. The report listener receives all the reports sent out by the server.
    If the same listener is added more than once, it will receive notifications as many times as it's been added.
    The listeners are notified in the reverse order of their addition.
    
    Specified by:
    
    addReportListener in interface Client
    
    Parameters:
    inListener - The listener instance that should be supplied the reports.
  - removeReportListener
```
public void removeReportListener(ReportListener inListener)
```
    Description copied from interface: Client
    
    Removes a report listener that was previously added via Client.addReportListener(ReportListener). If the listener was added more than once, only its most recently added occurrence will be removed.
    
    Specified by:
    
    removeReportListener in interface Client
    
    Parameters:
    inListener - The listener instance that should no longer be receiving the reports.
  - addBrokerStatusListener
```
public void addBrokerStatusListener(BrokerStatusListener listener)
```
    Description copied from interface: Client
    
    Adds a broker status listener, which receives all the broker status changes sent out by the server.
    If the same listener is added more than once, it will receive notifications as many times as it has been added.
    
    The listeners are notified in the reverse order of their addition.
    
    Specified by:
    
    addBrokerStatusListener in interface Client
    
    Parameters:
    listener - The listener which should be supplied the broker status changes.
  - removeBrokerStatusListener
```
public void removeBrokerStatusListener(BrokerStatusListener listener)
```
    Description copied from interface: Client
    
    Removes a broker status listener that was previously added via Client.addBrokerStatusListener(BrokerStatusListener).
    If the listener was added more than once, only its most recently added instance will be removed.
    
    Specified by:
    
    removeBrokerStatusListener in interface Client
    
    Parameters:
    listener - The listener which should stop receiving broker status changes.
  - addServerStatusListener
```
public void addServerStatusListener(ServerStatusListener listener)
```
    Description copied from interface: Client
    
    Adds a server connection status listener, which receives all the server connection status changes.
    If the same listener is added more than once, it will receive notifications as many times as it has been added.
    
    The listeners are notified in the reverse order of their addition.
    
    Specified by:
    
    addServerStatusListener in interface Client
    
    Parameters:
    listener - The listener which should be supplied the server connection status changes.
  - removeServerStatusListener
```
public void removeServerStatusListener(ServerStatusListener listener)
```
    Description copied from interface: Client
    
    Removes a server connection status listener that was previously added via Client.addServerStatusListener(ServerStatusListener).
    If the listener was added more than once, only its most recently added instance will be removed.
    
    Specified by:
    
    removeServerStatusListener in interface Client
    
    Parameters:
    listener - The listener which should stop receiving server connection status changes.
  - 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
    
    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.
  - 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
    
    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.
  - 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
    
    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.
  - 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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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.
  - getBrokersStatus
```
public BrokersStatus getBrokersStatus()
                               throws ConnectionException
```
    Description copied from interface: Client
    
    Returns the server's broker status.
    
    Specified by:
    
    getBrokersStatus in interface Client
    
    Returns:
    The status.
    
    Throws:
    
    ConnectionException - Thrown if the operation cannot be completed.
  - getUserInfo
```
public UserInfo getUserInfo(UserID id,
                   boolean useCache)
                     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
    
    Parameters:
    id - The user ID.
    useCache - True if the local cache should be used.
    
    Returns:
    The information.
    
    Throws:
    
    ConnectionException - Thrown if the operation cannot be completed.
  - 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
    
    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
    
    Parameters:
    inReport - an ExecutionReportImpl value
    
    Throws:
    
    ConnectionException - if an error occurs connecting to the server
  - 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
  - reconnect
```
public void reconnect()
               throws ConnectionException
```
    Description copied from interface: Client
    
    Disconnects the connection to the server and reconnects back using the same properties as were supplied when creating this instance.
    
    Specified by:
    
    reconnect in interface Client
    
    Throws:
    
    ConnectionException - if there were errors reconnecting.
  - reconnect
```
public void reconnect(ClientParameters inParameters)
               throws ConnectionException
```
    Description copied from interface: Client
    
    Disconnects the connection to the server and reconnects back using the properties supplied to this method.
    
    Specified by:
    
    reconnect in interface Client
    
    Parameters:
    inParameters - The parameters to use when reconnecting to the server. These parameters are stored so that subsequent invocations of Client.reconnect() will use these parameters instead of the ones that were supplied when creating this instance.
    
    Throws:
    
    ConnectionException - if there were errors reconnecting.
  - addExceptionListener
```
public void addExceptionListener(ExceptionListener inListener)
```
    Description copied from interface: Client
    
    Adds an exception listener. The exception listeners are notified whenever the client encounters connectivity issues when communicating with the server.
    The listeners are notified only when connectivity issues are encountered when sending or receiving messages, ie. when any of the send*() methods are invoked, or when the client receives a message and encounters errors processing it before delivering it to ReportListener or BrokerStatusListener, or when client heartbeats cannot reach the server.
    If the same listener is added more than once, it will receive notifications as many times as it's been added.
    The listeners are notified in the reverse order of their addition.
    
    Specified by:
    
    addExceptionListener in interface Client
    
    Parameters:
    inListener - the listener instance.
  - removeExceptionListener
```
public void removeExceptionListener(ExceptionListener inListener)
```
    Description copied from interface: Client
    
    Removes exception listener that was previously added via Client.addExceptionListener(java.beans.ExceptionListener). The listener will stop receiving exception notifications after this method returns. If the listener was added more than once, only its most recently added occurrence will be removed.
    
    Specified by:
    
    removeExceptionListener in interface Client
    
    Parameters:
    inListener - The exception listener that should no longer
  - getParameters
```
public ClientParameters getParameters()
```
    Description copied from interface: Client
    
    Returns the parameters that client is using to connect to the server.
    
    Specified by:
    
    getParameters in interface Client
    
    Returns:
    the parameters used by the client to connect to the server.
  - getLastConnectTime
```
public Date getLastConnectTime()
```
    Description copied from interface: Client
    
    Returns the last time the client was successfully connected or reconnected to the server.
    
    Specified by:
    
    getLastConnectTime in interface Client
    
    Returns:
    the last time the client was successfully connected or reconnected to the server.
  - isCredentialsMatch
```
public boolean isCredentialsMatch(String inUsername,
                         char[] inPassword)
```
    Description copied from interface: Client
    
    Returns true if the supplied user name, password match the credentials used to connect to the server.
    This method returns false if the client is not connected to the server.
    
    Specified by:
    
    isCredentialsMatch in interface Client
    
    Parameters:
    inUsername - the username
    inPassword - the password
    
    Returns:
    true, if the supplied credentials match the ones used to authenticate to the server and the client is connected to the server, false otherwise.
  - isServerAlive
```
public boolean isServerAlive()
```
    Description copied from interface: Client
    
    Returns true if client has a live connection to the server.
    
    Specified by:
    
    isServerAlive in interface Client
    
    Returns:
    true, if the connection to the server is alive.
  - 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
    
    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
    
    Parameters:
    inProperties - a Properties value
    
    Throws:
    
    ConnectionException - if an error occurs connecting to the server
  - 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
    
    Parameters:
    inSymbol - a String value
    
    Returns:
    an Instrument value
    
    Throws:
    
    ConnectionException - if an error occurs connecting to 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
    
    Returns:
    a List<ReportBaseImpl> 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
    
    Parameters:
    inOrderID - an OrderID value
    
    Returns:
    an OrderID value
  - onException
```
public void onException(javax.jms.JMSException e)
```
    Specified by:
    
    onException in interface javax.jms.ExceptionListener
  - getNextServerID
```
protected String getNextServerID()
                          throws RemoteException
```
    Fetches the next orderID base from server.
    
    Returns:
    the next orderID base from server.
    
    Throws:
    
    RemoteException - if there were communication errors.
  - connectWebServices
```
protected void connectWebServices()
                           throws I18NException,
                                  RemoteException
```
    Connects the web services.
    
    Throws:
    
    I18NException - if an error occurs connecting
    
    RemoteException - if an error occurs connecting
  - closeWebServices
```
protected void closeWebServices()
                         throws RemoteException
```
    Closes the web service.
    
    Throws:
    
    RemoteException - if an error occurs closing
  - reconnectWebServices
```
protected void reconnectWebServices()
                             throws RemoteException
```
    Reconnects the web service.
    
    Throws:
    
    RemoteException - if an error occurs reconnecting
  - connectJms
```
protected void connectJms()
                   throws JAXBException
```
    Connects the JMS service.
    
    Throws:
    
    JAXBException - if an error occurs connecting to the JMS service
  - heartbeat
```
protected void heartbeat()
                  throws RemoteException
```
    Executes a heartbeat.
    
    Throws:
    
    RemoteException - if the heartbeat cannot be executed
  - getSessionId
```
protected SessionId getSessionId()
```
    Gets the session ID value.
    
    Returns:
    a SessionId value
  - startJms
```
protected void startJms()
                 throws JAXBException
```
    Starts the JMS connection.
    
    Throws:
    
    JAXBException - if an error occurs starting the JMS connection

Class ClientImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mParameters

Constructor Detail

ClientImpl

Method Detail

sendOrder

sendOrder

sendOrder

sendOrderRaw

addReportListener

removeReportListener

addBrokerStatusListener

removeBrokerStatusListener

addServerStatusListener

removeServerStatusListener

getReportsSince

getEquityPositionAsOf

getAllEquityPositionsAsOf

getCurrencyPositionAsOf

getAllCurrencyPositionsAsOf

getAllFuturePositionsAsOf

getFuturePositionAsOf

getOptionPositionAsOf

getAllOptionPositionsAsOf

getOptionPositionsAsOf

getUnderlying

getOptionRoots

getBrokersStatus

getUserInfo

addReport

deleteReport

close

reconnect

reconnect

addExceptionListener

removeExceptionListener

getParameters

getLastConnectTime

isCredentialsMatch

isServerAlive

getUserData

setUserData

resolveSymbol

getOpenOrders

findRootOrderIdFor

onException

getNextServerID

connectWebServices

closeWebServices

reconnectWebServices

connectJms

heartbeat

getSessionId

startJms