cloud.metaapi.sdk.util

Class ServiceProvider

java.lang.Object

cloud.metaapi.sdk.util.ServiceProvider

public class ServiceProvider
extends Object

Inner service provider that implements dependency injection (DI) of some SDK classes which are needed to be tested properly. This class creates objects as they are used in normal environment giving opportunity to mock them for testing before they are actually created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceProvider.MetaApiConnectionProvider Interface for creating MetaApiConnection.

Constructor Summary

Constructors

Constructor and Description
ServiceProvider()

Method Summary

Modifier and Type	Method and Description
static HistoryFileManager	createHistoryFileManager(String accountId, String application, HistoryStorage storage) Constructs history file manager with its corresponding constructor or returns a mock if it is set.
static MetaApiConnection	createMetaApiConnection(MetaApiWebsocketClient websocketClient, MetatraderAccount account, HistoryStorage historyStorage, ConnectionRegistry connectionRegistry, cloud.metaapi.sdk.clients.models.IsoTime historyStartTime) Constructs metaapi connection with its corresponding constructor or returns a mock if it is set.
static java.time.Instant	getNow() Returns instant with current time or a mock if it is set
static double	getRandom() Returns value of Math.random() or stubbed value
static void	reset() Removes all mocks
static void	setHistoryFileManagerMock(HistoryFileManager mock) Sets history file manager mock that will be created by this provider.
static void	setMetApiConnectionMock(MetaApiConnection mock) Sets metaapi connection mock that will be created by this provider.
static void	setMetApiConnectionMock(ServiceProvider.MetaApiConnectionProvider mockProvider) Sets metaapi connection provider that will be used for creating the mock.
static void	setNowInstantMock(java.time.Instant instant) Sets instant with current time that will be used for provided by this class instead of real instant.
static void	setRandom(Double value) Sets or removes mock for random value

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProvider

public ServiceProvider()

Method Detail

reset

public static void reset()

Removes all mocks

createHistoryFileManager

public static HistoryFileManager createHistoryFileManager(String accountId,
                                                          String application,
                                                          HistoryStorage storage)

Constructs history file manager with its corresponding constructor or returns a mock if it is set.

Parameters:

accountId - account id

application - MetaApi application id

storage - storage

Returns:

normal or mocked history file manager

See Also:

setHistoryFileManagerMock(HistoryFileManager)

setHistoryFileManagerMock

public static void setHistoryFileManagerMock(HistoryFileManager mock)

Sets history file manager mock that will be created by this provider. If null is set, the mock is removed and the object will be created as normal.

Parameters:

mock - mocked history file manager or null

createMetaApiConnection

public static MetaApiConnection createMetaApiConnection(MetaApiWebsocketClient websocketClient,
                                                        MetatraderAccount account,
                                                        HistoryStorage historyStorage,
                                                        ConnectionRegistry connectionRegistry,
                                                        cloud.metaapi.sdk.clients.models.IsoTime historyStartTime)

Constructs metaapi connection with its corresponding constructor or returns a mock if it is set.

Parameters:

websocketClient - MetaApi websocket client

account - MetaTrader account to connect to

historyStorage - optional local terminal history storage. Use for accounts in user synchronization mode. By default an instance of MemoryHistoryStorage will be used.

connectionRegistry - metatrader account connection registry

historyStartTime - history start sync time, or null

Returns:

Metaapi connection

See Also:

setHistoryFileManagerMock(HistoryFileManager)

setMetApiConnectionMock

public static void setMetApiConnectionMock(MetaApiConnection mock)

Sets metaapi connection mock that will be created by this provider. If null is set, the mock is removed and the object will be created as normal.

Parameters:

mock - mocked metaapi connection or null

setMetApiConnectionMock

public static void setMetApiConnectionMock(ServiceProvider.MetaApiConnectionProvider mockProvider)

Sets metaapi connection provider that will be used for creating the mock. If null is set, the mock provider is removed and the object will be created as normal.

Parameters:

mockProvider - mocked metaapi connection or null

getNow

public static java.time.Instant getNow()

Returns instant with current time or a mock if it is set

Returns:

instant with current time or a mock if it is set

See Also:

setNowInstantMock(Instant)

setNowInstantMock

public static void setNowInstantMock(java.time.Instant instant)

Sets instant with current time that will be used for provided by this class instead of real instant. If null is set, the mock provider is removed and the object will be created as normal.

Parameters:

instant - mocked instant or null

getRandom

public static double getRandom()

Returns value of Math.random() or stubbed value

Returns:

random value

setRandom

public static void setRandom(Double value)

Sets or removes mock for random value

Parameters:

value - random value to return