Caplin Systems - FXOrdersAdapter (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.trading.orders.FXOrdersAdapter

public class FXOrdersAdapter
extends Object

An FXOrdersAdpater services trading capabilities for Limit Orders. This includes single leg orders, as well as if-done, oco and if-done-oco multi-leg order types.

Typically, an FXOrdersAdapter will be set up as follows:

 FXOrdersAdapter adapter = new FXOrdersAdapter(dataSource);
 adapter.registerSubmissionListenerFactory(StrategyType.SINGLE.getName(), new MySingleOrderListenerFactory());
 adapter.registerSubmissionListenerFactory(StrategyType.IF_DONE.getName(), new MyIfDoneOrderListenerFactory());
 adapter.registerSubmissionListenerFactory(StrategyType.OCO.getName(), new MyOCOOrderListenerFactory());
 adapter.registerSubmissionListenerFactory(StrategyType.IF_DONE_OCO.getName(), new MyIfDoneOCOOrderListenerFactory());

Constructor Summary

Constructors
Constructor and Description
`FXOrdersAdapter(com.caplin.datasource.DataSource dataSource)` Constructs an `FXOrdersAdapter` that will utilise the specified DataSource and its configuration for communication with the motif.
`FXOrdersAdapter(TradeAdapter tradeAdapter)` Constructs the `FXOrdersAdapter` that will utilise the specified `TradeAdapter` and its configuration for communication with the motif.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addUserSessionListener(UserSessionListener listener)` Adds a listener that is notified whenever a user session is created and closed.
`void`	`registerBulkOrderActionListenerFactory(BulkOrderActionTradeListenerFactory factory)` Registers a factory that will be asked to create the `BulkOrderActionTradeListener` which will listen to bulk order action workflows initiated by the client.
`void`	`registerCancelationListenerFactory(OrderCancelationListenerFactory factory)` Registers a factory that will be asked to create the `OrderCancelationFactory` which will listen to order cancelation workflows initiated by the client.
`void`	`registerChangeActiveStateListenerFactory(OrderChangeActiveStateListenerFactory factory)` Registers a factory that will be asked to create the `OrderChangeActiveStateListener` which will listen to order activation workflows initiated by the client.
`void`	`registerEditStrategyListenerFactory(EditStrategyListenerFactory factory)` Registers a factory that will be asked to create the `EditStrategyListenerFactory` which will listen to Edit Strategy requests from the client.
`void`	`registerOrderSubmissionValidator(String strategyType, OrderSubmissionValidator validator)` Takes the strategy type as well as the validator; so for a particular strategy (e.g OCO) the validation can be overridden.
`void`	`registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory)` Registers a factory that will be asked to create the `StrategyDetailsRequestListenerFactory` which will listen to strategy detail requests from the client.
`void`	`registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory, com.caplin.datasource.namespace.Namespace namespace, SubjectParser<? extends StrategySubjectInfo> subjectParser)` Registers a factory and your own parser implementation that will be asked to create the `StrategyDetailsRequestListenerFactory` which will listen to strategy detail requests from the client.
`void`	`registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory, SubjectParser<? extends StrategySubjectInfo> subjectParser)` Deprecated. This requires the library to use the deprecated method `SubjectParser.getSubjectRegex()` and is therefore scheduled for removal. Use `registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory, Namespace, SubjectParser)` intead.
`void`	`registerSubmissionListenerFactory(OrderSubmissionListenerFactory<MotifOrderStrategy> listenerFactory)` Registers a factory that will listen to Limit Order submission workflows initiated from the client.
`void`	`registerSubmissionListenerFactory(String strategyType, OrderSubmissionListenerFactory<? extends MotifOrderStrategy> listenerFactory)` Registers a factory that will listen to Limit Order submission workflows initiated from the client for the strategy type specified.
`void`	`registerSubmissionListenerFactory(String strategyType, OrderSubmissionListenerFactory<? extends OrderStrategy> listenerFactory, OrderStrategyFactory<? extends OrderStrategy> strategyFactory)` Registers a factory that will listen to the Limit Order submission workflows initiated from the client for the strategy type specified.
`void`	`removeUserSessionListener(UserSessionListener listener)` Removes a listener `UserSessionListener` to stop receiving session events.

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

- Constructor Detail
  - FXOrdersAdapter
```
public FXOrdersAdapter(com.caplin.datasource.DataSource dataSource)
                throws IOException
```
    Constructs an FXOrdersAdapter that will utilise the specified DataSource and its configuration for communication with the motif.
    
    Parameters:
    
    dataSource - The DataSource that will be used to receive requests for Limit Orders.
    
    Throws:
    
    IOException - If an error occured when reading the configuration files for the adapter.
  - FXOrdersAdapter
```
public FXOrdersAdapter(TradeAdapter tradeAdapter)
```
    Constructs the FXOrdersAdapter that will utilise the specified TradeAdapter and its configuration for communication with the motif.
    
    Prefer this constructor if you will be implementing post allocations, pass the FXPostAllocationAdapter the same instance of TradeAdapter
    
    Parameters:
    
    tradeAdapter - The Trade
- Method Detail
  - addUserSessionListener
```
public void addUserSessionListener(UserSessionListener listener)
```
    Adds a listener that is notified whenever a user session is created and closed. Note that you can add multiple UserSessionListeners
    
    Parameters:
    
    listener - the listener to be notified of session lifecycle events.
  - removeUserSessionListener
```
public void removeUserSessionListener(UserSessionListener listener)
```
    Removes a listener UserSessionListener to stop receiving session events.
    
    Parameters:
    
    listener - the listener to be removed from receiving session lifecycle events.
  - registerSubmissionListenerFactory
```
public void registerSubmissionListenerFactory(OrderSubmissionListenerFactory<MotifOrderStrategy> listenerFactory)
```
    Registers a factory that will listen to Limit Order submission workflows initiated from the client.
    
    Parameters:
    
    listenerFactory - The factory that will be asked to create the OrderSubmissionListener
  registerSubmissionListenerFactory public void registerSubmissionListenerFactory(String strategyType, OrderSubmissionListenerFactory<? extends MotifOrderStrategy> listenerFactory) Registers a factory that will listen to Limit Order submission workflows initiated from the client for the strategy type specified. Parameters: strategyType - The strategy type that the factory will be associated with, see StrategyType for default values listenerFactory - The factory that will be asked to create the OrderSubmissionListener registerSubmissionListenerFactory public void registerSubmissionListenerFactory(String strategyType, OrderSubmissionListenerFactory<? extends OrderStrategy> listenerFactory, OrderStrategyFactory<? extends OrderStrategy> strategyFactory) Registers a factory that will listen to the Limit Order submission workflows initiated from the client for the strategy type specified. An OrderStrategyFactory is passed in, to delegate the job of creating the said strategy. If this is not a default strategy it is recommended that a you also a register a validator for the strategy afterward using registerOrderSubmissionValidator Parameters: strategyType - the The strategy type that the factories will be associated with, see StrategyType for default values listenerFactory - The factory that will be asked to create the OrderSubmissionListener strategyFactory - The factory that will be asked to create the OrderStrategy registerOrderSubmissionValidator public void registerOrderSubmissionValidator(String strategyType, OrderSubmissionValidator validator) Takes the strategy type as well as the validator; so for a particular strategy (e.g OCO) the validation can be overridden. Parameters: strategyType - The strategy type for which the validator will be asked to validate validator - The validator which will validate an OrderStrategy registerCancelationListenerFactory public void registerCancelationListenerFactory(OrderCancelationListenerFactory factory) Registers a factory that will be asked to create the OrderCancelationFactory which will listen to order cancelation workflows initiated by the client. Parameters: factory - The factory that will be asked to create the OrderCancelationListener registerChangeActiveStateListenerFactory public void registerChangeActiveStateListenerFactory(OrderChangeActiveStateListenerFactory factory) Registers a factory that will be asked to create the OrderChangeActiveStateListener which will listen to order activation workflows initiated by the client. Parameters: factory - The factory that will be asked to create the OrderChangeActiveStateListener registerBulkOrderActionListenerFactory public void registerBulkOrderActionListenerFactory(BulkOrderActionTradeListenerFactory factory) Registers a factory that will be asked to create the BulkOrderActionTradeListener which will listen to bulk order action workflows initiated by the client. Parameters: factory - The factory that will be asked to create the BulkOrderActionTradeListener registerStrategyDetailsRequestListenerFactory @Deprecated public void registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory, SubjectParser<? extends StrategySubjectInfo> subjectParser) Deprecated. This requires the library to use the deprecated method SubjectParser.getSubjectRegex() and is therefore scheduled for removal. Use registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory, Namespace, SubjectParser) intead. Registers a factory and your own parser implementation that will be asked to create the StrategyDetailsRequestListenerFactory which will listen to strategy detail requests from the client. Parameters: factory - The factory that will be asked to create the StrategyDetailsRequestListener instances. subjectParser - The parser that will be used SubjectParser registerStrategyDetailsRequestListenerFactory public void registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory, com.caplin.datasource.namespace.Namespace namespace, SubjectParser<? extends StrategySubjectInfo> subjectParser) Registers a factory and your own parser implementation that will be asked to create the StrategyDetailsRequestListenerFactory which will listen to strategy detail requests from the client. Parameters: factory - The factory that will be asked to create the StrategyDetailsRequestListener instances. namespace - A namespace representing the subject pattern that this StrategyDetailsRequestListenerFactory will handle requests for. subjectParser - The parser that will be used to convert subjects required by the front end into instances of the domain object StrategySubjectInfo. registerStrategyDetailsRequestListenerFactory public void registerStrategyDetailsRequestListenerFactory(StrategyDetailsRequestListenerFactory factory) Registers a factory that will be asked to create the StrategyDetailsRequestListenerFactory which will listen to strategy detail requests from the client. Parameters: factory - The factory that will be asked to create the StrategyDetailsRequestListenerFactory registerEditStrategyListenerFactory public void registerEditStrategyListenerFactory(EditStrategyListenerFactory factory) Registers a factory that will be asked to create the EditStrategyListenerFactory which will listen to Edit Strategy requests from the client. Parameters: factory - The factory that will be asked to create the EditStrategyListener

Class FXOrdersAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FXOrdersAdapter

FXOrdersAdapter

Method Detail

addUserSessionListener

removeUserSessionListener

registerSubmissionListenerFactory

registerSubmissionListenerFactory

registerSubmissionListenerFactory

registerOrderSubmissionValidator

registerCancelationListenerFactory

registerChangeActiveStateListenerFactory

registerBulkOrderActionListenerFactory

registerStrategyDetailsRequestListenerFactory

registerStrategyDetailsRequestListenerFactory

registerStrategyDetailsRequestListenerFactory

registerEditStrategyListenerFactory