Package com.caplin.motif.fx.ret.orders.config

Class OrderConfigurationBuilder

java.lang.Object

com.caplin.motif.fx.ret.orders.config.OrderConfigurationBuilder

public class OrderConfigurationBuilder
extends Object

This class produces a OrderConfiguration which can be used to instantiate an OrderAdapter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADAPTER_NAME

Constructor Summary

Constructors

Constructor	Description
OrderConfigurationBuilder()	This class produces a OrderConfiguration which can be used to instantiate a LimitOrderAdapter.
OrderConfigurationBuilder(ConfigurationLoader configurationLoader)

Method Summary

Modifier and Type	Method	Description
OrderConfiguration	build()	Creates an instance of OrderConfiguration which can be used to instantiate a OrderAdapter.
OrderConfigurationBuilder	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.
OrderConfigurationBuilder	setAdapterConfigurationListener(AdapterConfigurationListener listener)	Sets a custom AdapterConfigurationListener to load custom configurations.
OrderConfigurationBuilder	setConfigurationLoader(ConfigurationLoader configurationLoader)	Sets a custom ConfigurationLoader to replace the OrderAdapter's default behaviour.
OrderConfigurationBuilder	setCustomFieldValuesFactory(CustomFieldValuesFactory<MotifOrderStrategy,OrderProperties> customFieldValuesFactory)	Sets a custom CustomFieldValuesFactory used to create custom CustomFieldValues objects for orders.
OrderConfigurationBuilder	setCustomFieldValuesSerialiser(CustomFieldValuesSerialiser customFieldValuesSerialiser)	Sets a custom CustomFieldValuesSerialiser used to serialise/deserialise CustomFieldValues objects.
OrderConfigurationBuilder	setDataSource(com.caplin.datasource.DataSource dataSource)	Sets a custom DataSource to extend the OrderAdapter's default behaviour.
OrderConfigurationBuilder	setInstrumentProvider(InstrumentProvider instrumentProvider)	Sets a InstrumentProvider to replace the OrderAdapter's default behaviour.
OrderConfigurationBuilder	setNotificationManager(NotificationManager notificationManager)	Set a NotificationManager used to initialise notification components.
OrderConfigurationBuilder	setOrderAuditTrailListener(OrderAuditTrailListener auditTrailListener)	Deprecated.
OrderConfigurationBuilder	setOrderConnectionPoolPreprocessor(OrderConnectionPoolPreprocessor preProcessor)	Set a OrderConnectionPoolPreprocessor to preprocess the order connections for the connection pool.
OrderConfigurationBuilder	setOrderConnectionRequestRouter(OrderConnectionRequestRouter router)	Sets a custom OrderConnectionRequestRouter to override the OrderAdapter's default behaviour.
OrderConfigurationBuilder	setOrderCustomFieldsFactory(OrderCustomFieldsFactory orderCustomFieldsFactory)	Set a custom OrderCustomFieldsFactory to override the OrderAdapters' default OrderCustomFieldsFactory.
OrderConfigurationBuilder	setOrderEditor(OrderEditor orderEditor)	Sets a custom OrderEditor to override the OrderAdapter's default PerStrategyOrderEditor.
OrderConfigurationBuilder	setOrderFactory(OrderFactory orderFactory)	Sets a custom OrderFactory to override the OrderAdapter's default OrderFactory.
OrderConfigurationBuilder	setOrderFieldsGenerator(OrderFieldsGenerator orderFieldsGenerator)	Deprecated. This has been deprecated as you should not modify or remove fields from the Toolkit's default field set.
OrderConfigurationBuilder	setOrderPermissionFactory(OrderPermissionFactory orderPermissionFactory)	Sets a custom OrderPermissionFactory to extend the OrderAdapter's default behaviour in populating the order blotter, edit orders and see order strategy details.
OrderConfigurationBuilder	setStrategyDetailsGenerator(StrategyDetailsGenerator strategyDetailsGenerator)	Sets a custom StrategyDetailsGenerator to replace the OrderAdapter's default behaviour.
void	setTimezoneOverrides(Map<String,String> timezoneOverrides)	RET does not use standard timezone strings (the standard list can be found: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) RET instead has a list of its own timezone strings.
OrderConfigurationBuilder	setUserManager(UserManager userManager)	Sets a custom UserManager to override the OrderAdapter's default UserManager.

Methods inherited from class java.lang.Object

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

Field Details

ADAPTER_NAME

public static final String ADAPTER_NAME

See Also:

• Constant Field Values

Constructor Details

OrderConfigurationBuilder

public OrderConfigurationBuilder()
                          throws ConfigurationLoaderException

This class produces a OrderConfiguration which can be used to instantiate a LimitOrderAdapter.

Throws:

ConfigurationLoaderException

OrderConfigurationBuilder

public OrderConfigurationBuilder(ConfigurationLoader configurationLoader)

Method Details

setTimezoneOverrides

public void setTimezoneOverrides(Map<String,String> timezoneOverrides)

RET does not use standard timezone strings (the standard list can be found: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) RET instead has a list of its own timezone strings. The adapter maps the default RET strings to actual timezones.

If your RET is configured with more ret timezones, you may provide additional mappings between those ret timezones and tz timezones, if needed.

Parameters:

timezoneOverrides - A map containing timezone overrides, the key is RET, and the value is a standard timezone String. All keys/values must be unique across keys+values

setOrderFieldsGenerator

@Deprecated
public OrderConfigurationBuilder setOrderFieldsGenerator(OrderFieldsGenerator orderFieldsGenerator)

Deprecated.

This has been deprecated as you should not modify or remove fields from the Toolkit's default field set. The preferred solution to update or remove fields would be using Transformer, and to add additional fields via the OrderCustomFieldsFactory extension point. This method may be removed in a future version of the Toolkit.

Sets a custom OrderFieldsGenerator to override the OrderAdapter's default OrderFieldsGenerator. The OrderFieldsGenerator allows the user to generate fields to be sent for a blotter record. The custom OrderFieldsGenerator can change, add, remove fields on the record.

Parameters:

orderFieldsGenerator - A custom OrderFieldsGenerator

See Also:

• setOrderCustomFieldsFactory(OrderCustomFieldsFactory)

setOrderCustomFieldsFactory

public OrderConfigurationBuilder setOrderCustomFieldsFactory(OrderCustomFieldsFactory orderCustomFieldsFactory)

Set a custom OrderCustomFieldsFactory to override the OrderAdapters' default OrderCustomFieldsFactory. The OrderCustomFieldsFactory allows the user to receive fields to be sent for a blotter record. The custom OrderCustomFieldsFactory can add more fields on the record.

Parameters:

orderCustomFieldsFactory - - A custom OrderCustomFieldsFactory

Returns:

the OrderConfigurationBuilder

setOrderFactory

public OrderConfigurationBuilder setOrderFactory(OrderFactory orderFactory)

Sets a custom OrderFactory to override the OrderAdapter's default OrderFactory.

Parameters:

orderFactory - A custom OrderFactory

See Also:

• OrderFactory

setOrderEditor

public OrderConfigurationBuilder setOrderEditor(OrderEditor orderEditor)

Sets a custom OrderEditor to override the OrderAdapter's default PerStrategyOrderEditor. The OrderEditor maps data from a given Strategy and Order to a TrAPI order.

Parameters:

orderEditor - A custom OrderEditor

See Also:

• OrderEditor

setUserManager

public OrderConfigurationBuilder setUserManager(UserManager userManager)

Sets a custom UserManager to override the OrderAdapter's default UserManager.

Parameters:

userManager - a custom UserManager

See Also:

• UserManager

setAdapterConfigurationListener

public OrderConfigurationBuilder setAdapterConfigurationListener(AdapterConfigurationListener listener)

Sets a custom AdapterConfigurationListener to load custom configurations.

Parameters:

listener - The listener that will receive a callback to load custom configurations

See Also:

• AdapterConfigurationListener

setCustomFieldValuesFactory

public OrderConfigurationBuilder setCustomFieldValuesFactory(CustomFieldValuesFactory<MotifOrderStrategy,OrderProperties> customFieldValuesFactory)

Sets a custom CustomFieldValuesFactory used to create custom CustomFieldValues objects for orders. The resulting CustomFieldValues objects will be serialised and stored in the TakerOrderCustom field of the order.

Parameters:

customFieldValuesFactory - The custom factory to use to create CustomFieldValues objects for orders

setCustomFieldValuesSerialiser

public OrderConfigurationBuilder setCustomFieldValuesSerialiser(CustomFieldValuesSerialiser customFieldValuesSerialiser)

Sets a custom CustomFieldValuesSerialiser used to serialise/deserialise CustomFieldValues objects. The resulting serialised objects will be stored in the TakerOrderCustom field.

Parameters:

customFieldValuesSerialiser - The custom serialiser to use when serialising/deserialising CustomFieldValues objects

setDataSource

public OrderConfigurationBuilder setDataSource(com.caplin.datasource.DataSource dataSource)

Sets a custom DataSource to extend the OrderAdapter's default behaviour.

Parameters:

dataSource - a custom DataSource

Returns:

the OrderConfigurationBuilder

See Also:

• DataSource

setOrderPermissionFactory

public OrderConfigurationBuilder setOrderPermissionFactory(OrderPermissionFactory orderPermissionFactory)

Sets a custom OrderPermissionFactory to extend the OrderAdapter's default behaviour in populating the order blotter, edit orders and see order strategy details.

Parameters:

orderPermissionFactory - a custom OrderPermissionFactory

Returns:

the OrderConfigurationBuilder

See Also:

• OrderPermissionFactory

setConfigurationLoader

public OrderConfigurationBuilder setConfigurationLoader(ConfigurationLoader configurationLoader)

Sets a custom ConfigurationLoader to replace the OrderAdapter's default behaviour.

Parameters:

configurationLoader - a custom ConfigurationLoader

Returns:

the OrderConfigurationBuilder

See Also:

• ConfigurationLoader

registerOrderSubmissionValidator

public OrderConfigurationBuilder 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

Returns:

the OrderConfigurationBuilder

setStrategyDetailsGenerator

public OrderConfigurationBuilder setStrategyDetailsGenerator(StrategyDetailsGenerator strategyDetailsGenerator)

Sets a custom StrategyDetailsGenerator to replace the OrderAdapter's default behaviour.

Parameters:

strategyDetailsGenerator - a custom StrategyDetailsGenerator

Returns:

the OrderConfigurationBuilder

See Also:

• StrategyDetailsGenerator

setOrderConnectionRequestRouter

public OrderConfigurationBuilder setOrderConnectionRequestRouter(OrderConnectionRequestRouter router)

Sets a custom OrderConnectionRequestRouter to override the OrderAdapter's default behaviour.

Parameters:

router - a custom OrderConnectionRequestRouter

Returns:

the OrderConfigurationBuilder

See Also:

• OrderConnectionRequestRouter

setOrderAuditTrailListener

@Deprecated
public OrderConfigurationBuilder setOrderAuditTrailListener(OrderAuditTrailListener auditTrailListener)

Deprecated.

Sets a OrderAuditTrailListener to receive callbacks on actions that users perform on orders.

Parameters:

auditTrailListener - a custom OrderAuditTrailListener

Returns:

the OrderConfigurationBuilder

See Also:

• OrderAuditTrailListener

setInstrumentProvider

public OrderConfigurationBuilder setInstrumentProvider(InstrumentProvider instrumentProvider)

Sets a InstrumentProvider to replace the OrderAdapter's default behaviour.

Parameters:

instrumentProvider - a custom InstrumentProvider

Returns:

the OrderConfigurationBuilder

setOrderConnectionPoolPreprocessor

public OrderConfigurationBuilder setOrderConnectionPoolPreprocessor(OrderConnectionPoolPreprocessor preProcessor)

Set a OrderConnectionPoolPreprocessor to preprocess the order connections for the connection pool.

Parameters:

preProcessor - the configured OrderConnectionPoolPreprocessor

Returns:

the OrderConfigurationBuilder

See Also:

• OrderConnectionPoolPreprocessor

setNotificationManager

public OrderConfigurationBuilder setNotificationManager(NotificationManager notificationManager)

Set a NotificationManager used to initialise notification components.

Parameters:

notificationManager - to received subscriptions and send notifications.

See Also:

• NotificationManager

build

public OrderConfiguration build()

Creates an instance of OrderConfiguration which can be used to instantiate a OrderAdapter.

Returns:

a new OrderConfiguration