com.marketfactory.api

Class MFAdmin

java.lang.Object

com.marketfactory.api.MFClient

com.marketfactory.api.MFAdmin

public class MFAdmin
extends MFClient

An API admin which contains a MFClient for function forwarding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MFAdmin.RiskLimit Admin interface: group limit, optionally for a specific feed and market.
static class	MFAdmin.RiskMarketPosition Admin interface: Use this if interested in market position rather than RiskUsage's net open position.
static class	MFAdmin.RiskUsage Admin interface: user state.

Nested classes/interfaces inherited from class com.marketfactory.api.MFClient

MFClient.OrderArgs, MFClient.PingTime, MFClient.TimeStats

Field Summary

Fields

Modifier and Type	Field and Description
protected MFAdmin.RiskLimit[]	_riskLimits
protected long	_riskTimestamp
protected MFAdmin.RiskUsage[]	_riskUsages
protected java.util.List<com.marketfactory.api.TradeLimitDataMessage>	_tradeLimitDataQueue
protected java.util.Map<java.lang.String,java.lang.String[]>	_userGroupChains
static int	FEED_ALL
static int	FEED_NULL Pair with marketID to reference individual currencies.
static int	MARKET_ALL
static long	SETTL_DATE_CASH
static long	SETTL_DATE_SUM

Constructor Summary

Constructors

Constructor and Description
MFAdmin(java.lang.String _username, java.lang.String _password, java.lang.String _hostname1, int _port1) Create a new admin object.
MFAdmin(java.lang.String _username, java.lang.String _password, java.lang.String _hostname1, int _port1, java.lang.String _hostname2, int _port2) Create a new admin object (with failover).

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	addUpdateType(java.lang.String id, boolean doReplace)
APIResult	allowClientsToConnect() Admin interface: Call this method to allow monitored API clients to connect.
protected static java.lang.String	delUpdateType(java.lang.String id)
protected static java.lang.String	getLimitID(java.lang.String mfUser, java.lang.String group, int feedID, int marketID)
MFAdmin.RiskLimit[]	getRiskLimits() Admin interface: limits registered by server process.
MFAdmin.RiskMarketPosition[]	getRiskMarketPositions() Admin interface: Returns array of derived RiskMarketPositions rather than RiskUsage.
long	getRiskTimestamp() Admin interface: timestamp of last constraint update from server process.
MFAdmin.RiskUsage[]	getRiskUsage() Admin interface: full risk usage view held by server process.
java.util.Map<java.lang.String,java.lang.String[]>	getUserGroupChains() Admin interface: linear list of groups to which each user belongs.
void	handle(com.marketfactory.api.TradeLimitDataMessage msg)
APIResult	lockUser(java.lang.String clRequestID, java.lang.String username, boolean locked) Admin interface: Lock / unlock user accounts.
static MFAdmin	open(java.lang.String user, java.lang.String pass, java.lang.String host, int port) A convenience method which creates a new client object, attempts to connect to Whisperer, and cleans up and throws an exception if we could not connect.
static MFAdmin	open(java.lang.String user, java.lang.String pass, java.lang.String _hostname1, int _port1, java.lang.String _hostname2, int _port2) A convenience method which creates a new client object, attempts to connect to Whisperer, and cleans up and throws an exception if we could not connect.
APIResult	run(MFAdminHandler handler) Run a loop that will continuously dispatch incoming messages to a _handler implementation.
APIResult	run(MFHandler _handler) Run a loop that will continuously dispatch incoming messages to a _handler implementation.
APIResult	setRisk(java.lang.String clRequestID, boolean doReplace, MFAdmin.RiskUsage... usages)
APIResult	setRisk(java.lang.String clRequestID, MFAdmin.RiskLimit... limits) Admin interface: publish incremental set of limits.
APIResult	setRisk(java.lang.String clRequestID, MFAdmin.RiskLimit[] limits, MFAdmin.RiskUsage[] usages, boolean isSnapshot) Admin interface: publish incremental/snapshot set of limits and usage.
APIResult	setRisk(java.lang.String clRequestID, MFAdmin.RiskLimit[] limits, MFAdmin.RiskUsage[] usages, boolean isSnapshot, boolean doReplace)
APIResult	setRisk(java.lang.String clRequestID, MFAdmin.RiskUsage... usages) Admin interface: publish incremental set of risk usage.

Methods inherited from class com.marketfactory.api.MFClient

cancelAll, cancelAll, cancelOrder, cancelOrder, cancelOrder, close, connect, enableDebugMetrics, getFeedByID, getFeedByName, getFeeds, getHostname, getLastPingTimes, getMarketByID, getMarketByName, getPort, getSequenceID, getSignature, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, isConnected, isRunning, join, log, log, modifyOrder, processEvents, registerMarketComb, replay, requestSnapshot, send, setDebug, setStickySubscriptions, setStickySubscriptions, setUseHeartbeat, stop, submitOrder, submitOrder, submitOrder, submitOrder, subscribeAllMD, subscribeMD, subscribeMD, subscribeOF, subscribeOF, test, unregisterMarketComb, unsubscribeAll, unsubscribeMD, unsubscribeMD, unsubscribeOF, unsubscribeOF

Methods inherited from class java.lang.Object

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

Field Detail

_userGroupChains

protected java.util.Map<java.lang.String,java.lang.String[]> _userGroupChains

_riskLimits

protected MFAdmin.RiskLimit[] _riskLimits

_riskUsages

protected MFAdmin.RiskUsage[] _riskUsages

_riskTimestamp

protected long _riskTimestamp

_tradeLimitDataQueue

protected java.util.List<com.marketfactory.api.TradeLimitDataMessage> _tradeLimitDataQueue

FEED_NULL

public static final int FEED_NULL

Pair with marketID to reference individual currencies.

See Also:

Constant Field Values

FEED_ALL

public static final int FEED_ALL

See Also:

Constant Field Values

MARKET_ALL

public static final int MARKET_ALL

See Also:

Constant Field Values

SETTL_DATE_SUM

public static final long SETTL_DATE_SUM

See Also:

Constant Field Values

SETTL_DATE_CASH

public static final long SETTL_DATE_CASH

See Also:

Constant Field Values

Constructor Detail

MFAdmin

public MFAdmin(java.lang.String _username,
               java.lang.String _password,
               java.lang.String _hostname1,
               int _port1)

Create a new admin object. A new client still needs to be connected (see connect()).

MFAdmin

public MFAdmin(java.lang.String _username,
               java.lang.String _password,
               java.lang.String _hostname1,
               int _port1,
               java.lang.String _hostname2,
               int _port2)

Create a new admin object (with failover). A new client still needs to be connected (see connect()).

Method Detail

run

public APIResult run(MFHandler _handler)

Description copied from class: MFClient

Run a loop that will continuously dispatch incoming messages to a _handler implementation. This method returns some time after a request to stop is made using stop(), or if an error occurs (e.g. the connection is broken). A zero return value indicates a normal exit via a stop request. If the connection is broken and the client succesfully fails over to a secondary server, this dispatcher does not return; onDisconnect() and onConnect() are invoked to let the handler know that this occurred. If the reconnection attempt is not successful, the dispatcher will return an error code. Every call to run() must be preceded by a successful connect() -- this call is made for you, but only once, when a client is obtained via open(). Note: this should not be invoked by _handler.

Overrides:

run in class MFClient

run

public APIResult run(MFAdminHandler handler)

Run a loop that will continuously dispatch incoming messages to a _handler implementation. This method returns some time after a request to stop is made using stop(), or if an error occurs (e.g. the connection is broken). A zero return value indicates a normal exit via a stop request. If the connection is broken and the client succesfully fails over to a secondary server, this dispatcher does not return; onDisconnect() and onConnect() are invoked to let the handler know that this occurred. If the reconnection attempt is not successful, the dispatcher will return an error code. Every call to run() must be preceded by a successful connect() -- this call is made for you, but only once, when a client is obtained via open(). Note: this should not be invoked by _handler.

open

public static MFAdmin open(java.lang.String user,
                           java.lang.String pass,
                           java.lang.String host,
                           int port)
                    throws java.io.IOException

A convenience method which creates a new client object, attempts to connect to Whisperer, and cleans up and throws an exception if we could not connect. Otherwise the new client object is returned;

Throws:

java.io.IOException

open

public static MFAdmin open(java.lang.String user,
                           java.lang.String pass,
                           java.lang.String _hostname1,
                           int _port1,
                           java.lang.String _hostname2,
                           int _port2)
                    throws java.io.IOException

A convenience method which creates a new client object, attempts to connect to Whisperer, and cleans up and throws an exception if we could not connect. Otherwise the new client object is returned;

Throws:

java.io.IOException

getLimitID

protected static java.lang.String getLimitID(java.lang.String mfUser,
                                             java.lang.String group,
                                             int feedID,
                                             int marketID)

addUpdateType

protected static java.lang.String addUpdateType(java.lang.String id,
                                                boolean doReplace)

delUpdateType

protected static java.lang.String delUpdateType(java.lang.String id)

handle

public void handle(com.marketfactory.api.TradeLimitDataMessage msg)

Overrides:

handle in class MFClient

allowClientsToConnect

public APIResult allowClientsToConnect()

Admin interface: Call this method to allow monitored API clients to connect. An MFAdmin must remain connected and have called this method for monitored clients to function.

lockUser

public APIResult lockUser(java.lang.String clRequestID,
                          java.lang.String username,
                          boolean locked)

Admin interface: Lock / unlock user accounts. This is a more granular, subordinate, version of allowClientsToConnect().

setRisk

public APIResult setRisk(java.lang.String clRequestID,
                         MFAdmin.RiskLimit[] limits,
                         MFAdmin.RiskUsage[] usages,
                         boolean isSnapshot)

Admin interface: publish incremental/snapshot set of limits and usage. A full snapshot must be sent prior to allowClientsToConnect() so NOP calculations are not stale.

Parameters:

clRequestID -

limits -

usages -

isSnapshot -

Returns:

the send results

setRisk

public APIResult setRisk(java.lang.String clRequestID,
                         MFAdmin.RiskLimit[] limits,
                         MFAdmin.RiskUsage[] usages,
                         boolean isSnapshot,
                         boolean doReplace)

setRisk

public APIResult setRisk(java.lang.String clRequestID,
                         MFAdmin.RiskLimit... limits)

Admin interface: publish incremental set of limits. Group limits may be selectively updated, deferring to previous values/defaults if desired. If a group is subject to multiple limits, the most restrictive limit will always be preferred.

setRisk

public APIResult setRisk(java.lang.String clRequestID,
                         MFAdmin.RiskUsage... usages)

Admin interface: publish incremental set of risk usage. User state may be selectively updated based on current activity. Users only have a single state, to which the server will incorporate unacknowledged/pending orders.

setRisk

public APIResult setRisk(java.lang.String clRequestID,
                         boolean doReplace,
                         MFAdmin.RiskUsage... usages)

getRiskLimits

public MFAdmin.RiskLimit[] getRiskLimits()

Admin interface: limits registered by server process. May include server defaults and other limits not explicitly initialized from an admin instance.

getRiskUsage

public MFAdmin.RiskUsage[] getRiskUsage()

Admin interface: full risk usage view held by server process. Will reflect the last set of usages received by the server, incorporating unacknowledged/pending orders. Will only include groups that have been modified by admin or trade activity.

getRiskMarketPositions

public MFAdmin.RiskMarketPosition[] getRiskMarketPositions()

Admin interface: Returns array of derived RiskMarketPositions rather than RiskUsage. The results are abridged to show current position without being broken down by date.

getRiskTimestamp

public long getRiskTimestamp()

Admin interface: timestamp of last constraint update from server process.

getUserGroupChains

public java.util.Map<java.lang.String,java.lang.String[]> getUserGroupChains()

Admin interface: linear list of groups to which each user belongs. (each entry is a direct child of the next group in the list.) Ex: {ApiUser1: [ApiUser1, Client1, Root] GuiUser1: [GuiUser1, Client1, Root]}