Package velox.api.layer1.providers.helper

Class InstrumentDataRequestRedirectHelper

java.lang.Object

velox.api.layer1.providers.helper.InstrumentDataRequestRedirectHelper

public class InstrumentDataRequestRedirectHelper
extends Object

When creating synthetic instruments using Layer1UpstreamDataEditor bookmap will still try to query those instruments for certain things (like "which provider does it belong to?", "which order types are supported by that instrument").

This class provides helper methods to take care of that for you.

Constructor Summary

Constructors

Constructor	Description
InstrumentDataRequestRedirectHelper()

Method Summary

Modifier and Type	Method	Description
static InstrumentDataRequestRedirector	redirector(Function<Object,Object> forwardFunction, Function<String,String> aliasMapper)	Creates a InstrumentDataRequestRedirector for your strategy's instruments.
static Object	redirectUserMessage(Object data, Function<Object,Object> forwardFunction, Function<String,String> aliasMapper)	Deprecated. create one InstrumentDataRequestRedirector via redirector(Function, Function), keep it in a field and call InstrumentDataRequestRedirector.redirect(Object) instead
static Object	redirectUserMessage(Object data, Function<Object,Object> forwardFunction, Function<String,String> aliasMapper, boolean keepProvider)	Deprecated. create one InstrumentDataRequestRedirector via redirector(Function, Function), configure it with InstrumentDataRequestRedirector.keepProvider(boolean), keep it in a field and call InstrumentDataRequestRedirector.redirect(Object) instead

Methods inherited from class java.lang.Object

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

Constructor Details

InstrumentDataRequestRedirectHelper

public InstrumentDataRequestRedirectHelper()

Method Details

redirector

public static InstrumentDataRequestRedirector redirector(Function<Object,Object> forwardFunction,
 Function<String,String> aliasMapper)

Creates a InstrumentDataRequestRedirector for your strategy's instruments.

Parameters:

forwardFunction - how to pass a question further down, normally super::sendUserMessage

aliasMapper - maps an alias created by your strategy to the alias of the real instrument it is based on; returns null for aliases that are not yours

redirectUserMessage

@Deprecated
public static Object redirectUserMessage(Object data,
 Function<Object,Object> forwardFunction,
 Function<String,String> aliasMapper)

Deprecated.

create one InstrumentDataRequestRedirector via redirector(Function, Function), keep it in a field and call InstrumentDataRequestRedirector.redirect(Object) instead

Should be used inside Layer1ApiAdminProvider.sendUserMessage(Object), helps you to redirect requests Delegates to redirectUserMessage(Object, Function, Function, boolean) without keeping provider (use this method for synthetic instruments)

redirectUserMessage

@Deprecated
public static Object redirectUserMessage(Object data,
 Function<Object,Object> forwardFunction,
 Function<String,String> aliasMapper,
 boolean keepProvider)

Deprecated.

create one InstrumentDataRequestRedirector via redirector(Function, Function), configure it with InstrumentDataRequestRedirector.keepProvider(boolean), keep it in a field and call InstrumentDataRequestRedirector.redirect(Object) instead

Should be used inside Layer1ApiAdminProvider.sendUserMessage(Object), helps you to redirect requests

Parameters:

data - the original data object that you have received as part of request

forwardFunction - where to forward requests (usually to the lower layers, often will be something like super::sendUserMessage)

aliasMapper - your function that handles alias translation. If provided alias isn't created by your strategy - return null, otherwise provide some other alias to take that information from (e.g. if you are creating synthetic instruments that will often be one of underlying instruments)

keepProvider - defines if messages should be forwarded futher and not change the provider. The value should be true if the data provider of the mapped alias was not changed. For synthetic instruments the value should be false.

Returns:

value that should be returned by Layer1ApiAdminProvider.sendUserMessage(Object)