Package de.hybris.platform.core

Class AbstractTenant

java.lang.Object

de.hybris.platform.core.AbstractTenant

All Implemented Interfaces:

DataSourceProvider, Tenant, Serializable

Direct Known Subclasses:

MasterTenant, SlaveTenant, TestTenantStub

public abstract class AbstractTenant
extends Object
implements Tenant, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractTenant.CodeWrapper
protected static class	AbstractTenant.DataSourceHolder
protected static class	AbstractTenant.DataSourceSelection
static enum	AbstractTenant.ShutDownMode
static enum	AbstractTenant.State
class	AbstractTenant.TenantNotYetStartedException

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALT_DATASOURCE
static final String	MASTER_DATASOURCE_ID
static final String	SLAVE_DATASOURCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTenant(String tenantID)

Method Summary

Modifier and Type	Method	Description
protected void	activateAlternativeDataSource(String id, boolean asMaster)
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.
protected void	assertTenant(JaloSession session)
protected void	assureTypeSystemStructureIsUpToDate()
protected void	backgroundThreadFinished(Thread thread, Runnable payload)
protected void	backgroundThreadStarted(Thread thread, Runnable payload)
void	cancelForceMasterMode()	Be careful! This method is intended for internal testing.
protected final boolean	cannotAccess()
boolean	cannotConnect()
protected boolean	canSwitch(AbstractTenant.DataSourceSelection currentSelection, boolean toMaster)
void	clearConnectionHasBeenBroken()
boolean	connectionHasBeenBroken()
protected HybrisDataSource	createAlternativeDataSource(DataSourceFactory factory, String id, Map<String,String> params, boolean readOnly)
protected List<AbstractTenant.DataSourceHolder>	createAlternativeDataSources(DataSourceFactory defaultFactory, ConfigIntf cfg, Collection<HybrisDataSource> createdForRollback)
Thread	createAndRegisterBackgroundThread(Runnable payload, ThreadFactory factory)
protected Cache	createCache()
protected DataSourceFactory	createDataSourceFactory(ConfigIntf cfg)
protected DataSourceFactory	createDataSourceFactory(String className)
static ThreadPool	createDefaultThreadPool(String tenantID, int poolSize)
protected HybrisDataSource	createMasterDataSource(DataSourceFactory 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).
protected void	doInitialize()
final void	doShutDown()
final void	doStartUp()
boolean	equals(Object o)
protected final void	executeInitsIfNecessary()	Performs calling Init.Init() for all registered init instances and also performs TenantListener.afterTenantStartUp(Tenant) notification.
static Map<String,String>	extractCustomDBParams(ConfigIntf cfg)
static Map<String,String>	extractCustomDBParams(ConfigIntf cfg, boolean stripPrefix)
static Map<String,String>	extractCustomDBParams(Map<String,String> map)
static Map<String,String>	extractCustomDBParams(Map<String,String> map, boolean stripPrefix)
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()
List<SessionContext>	getActiveSessionContextList()
protected Collection<HybrisDataSource>	getAllAlternativeDataSources(boolean asMaster)
Set<String>	getAllAlternativeMasterDataSourceIDs()	Provides IDs of all available alternative master data sources.
Collection<HybrisDataSource>	getAllAlternativeMasterDataSources()	Returns all known alternative master data sources as Collection.
protected Set<String>	getAllAlterntiveDataSourceIDs(boolean asMaster)
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()
int	getClusterID()	Deprecated, for removal: This API element is subject to removal in a future version. since ages - UseRegistry.getClusterID() instead.
abstract ConfigIntf	getConfig()
static Tenant	getCurrentTenant()
HybrisDataSource	getDataSource()	Returns currently active data source.
HybrisDataSource	getDataSource(String className)	Returns new data source.
long	getDynamicClusterNodeID()
InvalidationManager	getInvalidationManager()
JaloConnection	getJaloConnection()
HybrisDataSource	getMasterDataSource()	Returns master data source no matter which one is currently active.
protected AbstractTenant.DataSourceSelection	getNextSlave()	Returns the next available AbstractTenant.DataSourceSelection
PersistenceManager	getPersistenceManager()
PersistencePool	getPersistencePool()
SerialNumberGenerator	getSerialNumberGenerator()
SingletonCreator	getSingletonCreator()
final AbstractTenant.State	getState()
protected String	getStateInfo()
SystemEJB	getSystemEJB()
String	getTenantID()
long	getTenantRestartMarker()
abstract List<String>	getTenantSpecificExtensionNames()
ThreadPool	getThreadPool()
ThreadPool	getWorkersThreadPool()
int	hashCode()
protected void	initializeCache(HybrisDataSource masterDataSource)
boolean	isAlternativeMasterDataSource()	Tells whether the current active data source is a alternative master data source.
boolean	isClusteringEnabled()	checks if clustermode is enabled
boolean	isConnectionPoolCheckEnabled()
boolean	isForceMaster()	If on the current data source (slave/master) the method DataSourceProvider.forceMasterDataSource() was called then this method returns true.
final boolean	isNotifiyingListeners()
boolean	isSlaveDataSource()	Tells whether current data source is a slave data source.
final boolean	isStarting()
final boolean	isStopping()
protected Map<String,String>	mergeSlaveDataSourceParameter(String dsID, Map<String,String> tenantSettings, String... keys)
protected Object	performWithinOwnSystem(AbstractTenant.CodeWrapper wrapper)
MSSQLServerTransactionParameters	readParameters(DataSource dataSource)	Checks READ_COMMITTED_SNAPSHOT and ALLOW_SNAPSHOT_ISOLATION parameters for MS SQL Server
protected void	relaseAdministrationLockIfNeeded(HybrisDataSource masterDataSource)	Tries to release administration lock if lock was acquired by this getClusterID() node.
void	resetTenantRestartMarker()
void	setActiveSessionForCurrentThread(JaloSession session)
protected final void	setState(AbstractTenant.State state)
void	setSystemInit(Boolean state)
void	setTenantID(String id)
abstract void	shutDown()
protected void	shutdownCache(AbstractTenant.ShutDownMode mode)
abstract void	startUp()
String	toString()
Object	writeReplace()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.core.Tenant

getAllItemLifecycleListeners, getTenantSpecificLocale, getTenantSpecificTimeZone

Field Details

SLAVE_DATASOURCE

public static final String SLAVE_DATASOURCE

See Also:

• Constant Field Values

ALT_DATASOURCE

public static final String ALT_DATASOURCE

See Also:

• Constant Field Values

MASTER_DATASOURCE_ID

public static final String MASTER_DATASOURCE_ID

See Also:

• Constant Field Values

Constructor Details

AbstractTenant

protected AbstractTenant(String tenantID)

Method Details

getTenantSpecificExtensionNames

public abstract List<String> getTenantSpecificExtensionNames()

Specified by:

getTenantSpecificExtensionNames in interface Tenant

getConfig

public abstract ConfigIntf getConfig()

Specified by:

getConfig in interface Tenant

startUp

public abstract void startUp()
                      throws ConsistencyCheckException

Throws:

ConsistencyCheckException

shutDown

public abstract void shutDown()

getCurrentTenant

public static Tenant getCurrentTenant()

setSystemInit

public void setSystemInit(Boolean state)

getTenantRestartMarker

public long getTenantRestartMarker()

Returns:

a time stamp marker when current tenant was created/restarted for the last time. If no restart occurred points to creation time.

doInitialize

protected void doInitialize()

relaseAdministrationLockIfNeeded

protected void relaseAdministrationLockIfNeeded(HybrisDataSource masterDataSource)

Tries to release administration lock if lock was acquired by this getClusterID() node.

initializeCache

protected void initializeCache(HybrisDataSource masterDataSource)

readParameters

public MSSQLServerTransactionParameters readParameters(DataSource dataSource)

Checks READ_COMMITTED_SNAPSHOT and ALLOW_SNAPSHOT_ISOLATION parameters for MS SQL Server

doStartUp

public final void doStartUp()
                     throws ConsistencyCheckException

Throws:

ConsistencyCheckException

assureTypeSystemStructureIsUpToDate

protected void assureTypeSystemStructureIsUpToDate()

doShutDown

public final void doShutDown()

shutdownCache

protected void shutdownCache(AbstractTenant.ShutDownMode mode)

executeInitsIfNecessary

protected final void executeInitsIfNecessary()

Performs calling Init.Init() for all registered init instances and also performs TenantListener.afterTenantStartUp(Tenant) notification.

Both is working in a thread-safe non-blocking mode now.

cannotAccess

protected final boolean cannotAccess()

getStateInfo

protected String getStateInfo()

getState

public final AbstractTenant.State getState()

setState

protected final void setState(AbstractTenant.State state)

getTenantID

public String getTenantID()

Specified by:

getTenantID in interface Tenant

setTenantID

public void setTenantID(String id)

toString

public String toString()

Overrides:

toString in class Object

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

getDataSource

public HybrisDataSource getDataSource()

Description copied from interface: DataSourceProvider

Returns currently active data source.

Specified by:

getDataSource in interface DataSourceProvider

cancelForceMasterMode

public void cancelForceMasterMode()

Be careful! This method is intended for internal testing. Generally it's not recommended to cancel forceMaster mode since this would bear the danger of seeing stale data due to switching to slave data source is possible again.

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

createDataSourceFactory

protected DataSourceFactory createDataSourceFactory(String className)

createDataSourceFactory

protected DataSourceFactory createDataSourceFactory(ConfigIntf cfg)

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

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()

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)

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

getAllAlternativeDataSources

protected Collection<HybrisDataSource> getAllAlternativeDataSources(boolean asMaster)

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

getAllDataSourceIDs

public Set<String> getAllDataSourceIDs()

Specified by:

getAllDataSourceIDs in interface DataSourceProvider

getAllAlterntiveDataSourceIDs

protected Set<String> getAllAlterntiveDataSourceIDs(boolean asMaster)

getAllSlaveDataSourceIDs

public Set<String> getAllSlaveDataSourceIDs()

Description copied from interface: DataSourceProvider

Provides IDs of all available slave data sources.

Specified by:

getAllSlaveDataSourceIDs in interface DataSourceProvider

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

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()

canSwitch

protected boolean canSwitch(AbstractTenant.DataSourceSelection currentSelection,
 boolean toMaster)

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()

activateAlternativeDataSource

protected void activateAlternativeDataSource(String id,
 boolean asMaster)

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()

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

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

getNextSlave

protected AbstractTenant.DataSourceSelection getNextSlave()

Returns the next available AbstractTenant.DataSourceSelection

Returns:

null if no valid slave was found

getInvalidationManager

public InvalidationManager getInvalidationManager()

Specified by:

getInvalidationManager in interface Tenant

getCache

public Cache getCache()

Specified by:

getCache in interface Tenant

getPersistencePool

public PersistencePool getPersistencePool()

Specified by:

getPersistencePool in interface Tenant

getPersistenceManager

public PersistenceManager getPersistenceManager()

Specified by:

getPersistenceManager in interface Tenant

getSystemEJB

public SystemEJB getSystemEJB()

Specified by:

getSystemEJB in interface Tenant

getThreadPool

public ThreadPool getThreadPool()

Specified by:

getThreadPool in interface Tenant

getWorkersThreadPool

public ThreadPool getWorkersThreadPool()

Specified by:

getWorkersThreadPool in interface Tenant

getSingletonCreator

public SingletonCreator getSingletonCreator()

Specified by:

getSingletonCreator in interface Tenant

getSerialNumberGenerator

public SerialNumberGenerator getSerialNumberGenerator()

Specified by:

getSerialNumberGenerator in interface Tenant

createDefaultThreadPool

public static ThreadPool createDefaultThreadPool(String tenantID,
 int poolSize)

createMasterDataSource

protected HybrisDataSource createMasterDataSource(DataSourceFactory factory)

createAlternativeDataSources

protected List<AbstractTenant.DataSourceHolder> createAlternativeDataSources(DataSourceFactory defaultFactory,
 ConfigIntf cfg,
 Collection<HybrisDataSource> createdForRollback)

createAlternativeDataSource

protected HybrisDataSource createAlternativeDataSource(DataSourceFactory factory,
 String id,
 Map<String,String> params,
 boolean readOnly)

mergeSlaveDataSourceParameter

protected Map<String,String> mergeSlaveDataSourceParameter(String dsID,
 Map<String,String> tenantSettings,
 String... keys)

extractCustomDBParams

public static Map<String,String> extractCustomDBParams(ConfigIntf cfg)

extractCustomDBParams

public static Map<String,String> extractCustomDBParams(ConfigIntf cfg,
 boolean stripPrefix)

extractCustomDBParams

public static Map<String,String> extractCustomDBParams(Map<String,String> map)

extractCustomDBParams

public static Map<String,String> extractCustomDBParams(Map<String,String> map,
 boolean stripPrefix)

createCache

protected Cache createCache()

isClusteringEnabled

public boolean isClusteringEnabled()

checks if clustermode is enabled

Returns:

'true' ONLY IF the correspondig property is set to 'true' AND the installed licence file supports this feature, too

Since:

4.0.3

getClusterID

@Deprecated(since="ages",
            forRemoval=true)
public int getClusterID()

Deprecated, for removal: This API element is subject to removal in a future version.

since ages - UseRegistry.getClusterID() instead. The cluster ID is a global setting and therefore not strictly depending on the current tenant.

getDynamicClusterNodeID

public long getDynamicClusterNodeID()

performWithinOwnSystem

protected Object performWithinOwnSystem(AbstractTenant.CodeWrapper wrapper)

getActiveSession

public JaloSession getActiveSession()

Specified by:

getActiveSession in interface Tenant

setActiveSessionForCurrentThread

public void setActiveSessionForCurrentThread(JaloSession session)

assertTenant

protected void assertTenant(JaloSession session)

getActiveSessionContextList

public List<SessionContext> getActiveSessionContextList()

getJaloConnection

public JaloConnection getJaloConnection()

Specified by:

getJaloConnection in interface Tenant

cannotConnect

public boolean cannotConnect()

isConnectionPoolCheckEnabled

public boolean isConnectionPoolCheckEnabled()

connectionHasBeenBroken

public boolean connectionHasBeenBroken()

clearConnectionHasBeenBroken

public void clearConnectionHasBeenBroken()

writeReplace

public Object writeReplace()
                    throws ObjectStreamException

Throws:

ObjectStreamException

isStarting

public final boolean isStarting()

isStopping

public final boolean isStopping()

isNotifiyingListeners

public final boolean isNotifiyingListeners()

createAndRegisterBackgroundThread

public Thread createAndRegisterBackgroundThread(Runnable payload,
 ThreadFactory factory)

Specified by:

createAndRegisterBackgroundThread in interface Tenant

backgroundThreadStarted

protected void backgroundThreadStarted(Thread thread,
 Runnable payload)

backgroundThreadFinished

protected void backgroundThreadFinished(Thread thread,
 Runnable payload)

resetTenantRestartMarker

public void resetTenantRestartMarker()

Specified by:

resetTenantRestartMarker in interface Tenant

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object