de.hybris.platform.servicelayer.tenant

Class MockTenant

java.lang.Object

de.hybris.platform.servicelayer.tenant.MockTenant

All Implemented Interfaces:

DataSourceProvider, Tenant

public class MockTenant
extends Object
implements Tenant

Constructor Summary

Constructors

Constructor and Description
MockTenant(String tenantId)

Method Summary

Modifier and Type	Method and Description
void	activateAlternativeMasterDataSource(String id) Switches to a specified (by the id) master data source for the current thread.
String	activateSlaveDataSource() Switches to a slave data source for the current thread.
void	activateSlaveDataSource(String id) Switches to a specified (by the id) slave data source for the current thread.
Thread	createAndRegisterBackgroundThread(Runnable payload, ThreadFactory factory)
void	deactivateAlternativeDataSource() After a alternative slave or master data source has been activated for the current thread it's necessary to de-activate it again! After this the base master data source is active (again).
void	deactivateSlaveDataSource() After slave data source has been activated for the current thread it's necessary to de-activate it again! After this the master data source is active (again).
boolean	equals(Object object)
void	forceMasterDataSource() Enforces the usage of a master data source for all subsequent calls to DataSourceProvider.getDataSource() no matter if a slave data source has been activated or not.
JaloSession	getActiveSession()
Set<String>	getAllAlternativeMasterDataSourceIDs() Provides IDs of all available alternative master data sources.
Collection<HybrisDataSource>	getAllAlternativeMasterDataSources() Returns all known alternative master data sources as Collection.
Set<String>	getAllDataSourceIDs()
Set<String>	getAllSlaveDataSourceIDs() Provides IDs of all available slave data sources.
Collection<HybrisDataSource>	getAllSlaveDataSources() Returns all known slave data sources as Collection.
Cache	getCache()
ConfigIntf	getConfig()
HybrisDataSource	getDataSource() Returns currently active data source.
HybrisDataSource	getDataSource(String className) Returns new data source.
InvalidationManager	getInvalidationManager()
JaloConnection	getJaloConnection()
HybrisDataSource	getMasterDataSource() Returns master data source no matter which one is currently active.
PersistenceManager	getPersistenceManager()
PersistencePool	getPersistencePool()
SerialNumberGenerator	getSerialNumberGenerator()
SingletonCreator	getSingletonCreator()
SystemEJB	getSystemEJB()
String	getTenantID()
List<String>	getTenantSpecificExtensionNames()
Locale	getTenantSpecificLocale()
TimeZone	getTenantSpecificTimeZone()
ThreadPool	getThreadPool()
ThreadPool	getWorkersThreadPool()
int	hashCode()
boolean	isAlternativeMasterDataSource() Tells whether the current active data source is a alternative master data source.
boolean	isForceMaster() If on the current data source (slave/master) the method DataSourceProvider.forceMasterDataSource() was called then this method returns true.
boolean	isSlaveDataSource() Tells whether current data source is a slave data source.
void	resetTenantRestartMarker()

Methods inherited from class java.lang.Object

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

Constructor Detail

MockTenant

public MockTenant(String tenantId)

Method Detail

resetTenantRestartMarker

public void resetTenantRestartMarker()

Specified by:

resetTenantRestartMarker in interface Tenant

getDataSource

public HybrisDataSource getDataSource(String className)

Description copied from interface: DataSourceProvider

Returns new data source. (experimental (related to PLA-7861))

Specified by:

getDataSource in interface DataSourceProvider

getCache

public Cache getCache()

Specified by:

getCache in interface Tenant

getConfig

public ConfigIntf getConfig()

Specified by:

getConfig in interface Tenant

getDataSource

public HybrisDataSource getDataSource()

Description copied from interface: DataSourceProvider

Returns currently active data source.

Specified by:

getDataSource in interface DataSourceProvider

getInvalidationManager

public InvalidationManager getInvalidationManager()

Specified by:

getInvalidationManager in interface Tenant

getJaloConnection

public JaloConnection getJaloConnection()

Specified by:

getJaloConnection in interface Tenant

getPersistenceManager

public PersistenceManager getPersistenceManager()

Specified by:

getPersistenceManager in interface Tenant

getPersistencePool

public PersistencePool getPersistencePool()

Specified by:

getPersistencePool in interface Tenant

getSerialNumberGenerator

public SerialNumberGenerator getSerialNumberGenerator()

Specified by:

getSerialNumberGenerator in interface Tenant

getSingletonCreator

public SingletonCreator getSingletonCreator()

Specified by:

getSingletonCreator in interface Tenant

getSystemEJB

public SystemEJB getSystemEJB()

Specified by:

getSystemEJB in interface Tenant

getTenantID

public String getTenantID()

Specified by:

getTenantID in interface Tenant

getTenantSpecificExtensionNames

public List<String> getTenantSpecificExtensionNames()

Specified by:

getTenantSpecificExtensionNames in interface Tenant

getTenantSpecificLocale

public Locale getTenantSpecificLocale()

Specified by:

getTenantSpecificLocale in interface Tenant

getTenantSpecificTimeZone

public TimeZone getTenantSpecificTimeZone()

Specified by:

getTenantSpecificTimeZone in interface Tenant

getThreadPool

public ThreadPool getThreadPool()

Specified by:

getThreadPool in interface Tenant

getWorkersThreadPool

public ThreadPool getWorkersThreadPool()

Specified by:

getWorkersThreadPool in interface Tenant

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getActiveSession

public JaloSession getActiveSession()

Specified by:

getActiveSession in interface Tenant

deactivateSlaveDataSource

public void deactivateSlaveDataSource()

Description copied from interface: DataSourceProvider

After slave data source has been activated for the current thread it's necessary to de-activate it again! After this the master data source is active (again).

Specified by:

deactivateSlaveDataSource in interface DataSourceProvider

See Also:

DataSourceProvider.activateSlaveDataSource()

activateSlaveDataSource

public String activateSlaveDataSource()

Description copied from interface: DataSourceProvider

Switches to a slave data source for the current thread. If the current data source is already a slave one this has no effect. Use as follows:

 Tenant t = Registry.getCurrentTenant();
 try
 {
        t.activateSlaveDataSource();
        // ... business logic ...
 }
 finally
 {
        t.deactivateSlaveSource();
 }
 

Specified by:

activateSlaveDataSource in interface DataSourceProvider

See Also:

DataSourceProvider.deactivateAlternativeDataSource()

activateSlaveDataSource

public void activateSlaveDataSource(String id)

Description copied from interface: DataSourceProvider

Switches to a specified (by the id) slave data source for the current thread. If the current data source is already a slave one this has no effect. Use as follows:

 Tenant t = Registry.getCurrentTenant();
 try
 {
        t.activateSlaveDataSource("your_slave_id");
        // ... business logic ...
 }
 finally
 {
        t.deactivateSlaveSource();
 }
 

Specified by:

activateSlaveDataSource in interface DataSourceProvider

Parameters:

id - the id string of the slave data source

See Also:

DataSourceProvider.deactivateAlternativeDataSource()

getMasterDataSource

public HybrisDataSource getMasterDataSource()

Description copied from interface: DataSourceProvider

Returns master data source no matter which one is currently active.

Specified by:

getMasterDataSource in interface DataSourceProvider

isSlaveDataSource

public boolean isSlaveDataSource()

Description copied from interface: DataSourceProvider

Tells whether current data source is a slave data source.

Specified by:

isSlaveDataSource in interface DataSourceProvider

Returns:

true if the DataSourceProvider is a slave data source

isAlternativeMasterDataSource

public boolean isAlternativeMasterDataSource()

Description copied from interface: DataSourceProvider

Tells whether the current active data source is a alternative master data source.

Specified by:

isAlternativeMasterDataSource in interface DataSourceProvider

getAllSlaveDataSources

public Collection<HybrisDataSource> getAllSlaveDataSources()

Description copied from interface: DataSourceProvider

Returns all known slave data sources as Collection.

Specified by:

getAllSlaveDataSources in interface DataSourceProvider

Returns:

a Set with HybrisDataSource objects

getAllDataSourceIDs

public Set<String> getAllDataSourceIDs()

Specified by:

getAllDataSourceIDs in interface DataSourceProvider

forceMasterDataSource

public void forceMasterDataSource()

Description copied from interface: DataSourceProvider

Enforces the usage of a master data source for all subsequent calls to DataSourceProvider.getDataSource() no matter if a slave data source has been activated or not. Please note that this does not affect chosen alternative master data sources. If you want to switch back to the main master data source use DataSourceProvider.deactivateAlternativeDataSource().

Specified by:

forceMasterDataSource in interface DataSourceProvider

isForceMaster

public boolean isForceMaster()

Description copied from interface: DataSourceProvider

If on the current data source (slave/master) the method DataSourceProvider.forceMasterDataSource() was called then this method returns true. A DataSourceProvider.deactivateAlternativeDataSource() will reset this state.

Specified by:

isForceMaster in interface DataSourceProvider

Returns:

true if the master data source is forced

activateAlternativeMasterDataSource

public void activateAlternativeMasterDataSource(String id)

Description copied from interface: DataSourceProvider

Switches to a specified (by the id) master data source for the current thread. Use as follows:

 Tenant t = Registry.getCurrentTenant();
 try
 {
        t.activateMasterDataSource("your_slave_id");
        // ... business logic ...
 }
 finally
 {
        t.deactivateSlaveSource();
 }
 

Specified by:

activateAlternativeMasterDataSource in interface DataSourceProvider

Parameters:

id - the id string of the slave data source

See Also:

DataSourceProvider.deactivateAlternativeDataSource()

deactivateAlternativeDataSource

public void deactivateAlternativeDataSource()

Description copied from interface: DataSourceProvider

After a alternative slave or master data source has been activated for the current thread it's necessary to de-activate it again! After this the base master data source is active (again).

Specified by:

deactivateAlternativeDataSource in interface DataSourceProvider

See Also:

DataSourceProvider.activateSlaveDataSource(), DataSourceProvider.activateAlternativeMasterDataSource(String)

getAllAlternativeMasterDataSourceIDs

public Set<String> getAllAlternativeMasterDataSourceIDs()

Description copied from interface: DataSourceProvider

Provides IDs of all available alternative master data sources.

Specified by:

getAllAlternativeMasterDataSourceIDs in interface DataSourceProvider

getAllAlternativeMasterDataSources

public Collection<HybrisDataSource> getAllAlternativeMasterDataSources()

Description copied from interface: DataSourceProvider

Returns all known alternative master data sources as Collection.

Specified by:

getAllAlternativeMasterDataSources in interface DataSourceProvider

Returns:

a Set with HybrisDataSource objects

getAllSlaveDataSourceIDs

public Set<String> getAllSlaveDataSourceIDs()

Description copied from interface: DataSourceProvider

Provides IDs of all available slave data sources.

Specified by:

getAllSlaveDataSourceIDs in interface DataSourceProvider

createAndRegisterBackgroundThread

public Thread createAndRegisterBackgroundThread(Runnable payload,
                                                ThreadFactory factory)

Specified by:

createAndRegisterBackgroundThread in interface Tenant