Registry (hybris Commerce Suite 18.11)

java.lang.Object
- de.hybris.platform.core.Registry

public class Registry
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Registry.Init

protected static class Registry.TenantHolder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Registry.Init`
`protected static class`	`Registry.TenantHolder`

Field Summary

Fields
Modifier and Type Field and Description

static boolean FAILSAVE_NOTENANTACTIVE

static java.lang.String SYSTEM_PROPERTY_FAILSAFE_ACTIVE

Fields
Modifier and Type	Field and Description
`static boolean`	`FAILSAVE_NOTENANTACTIVE`
`static java.lang.String`	`SYSTEM_PROPERTY_FAILSAFE_ACTIVE`

Constructor Summary

Constructors
Constructor and Description

Registry()

Constructors
Constructor and Description
`Registry()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Tenant`	`activateMasterTenant()` Internal note: currently called via reflection from JUnitTestRunner to assure that "ant yunit" will work
`static Tenant`	`activateMasterTenant(de.hybris.platform.core.Registry.REPLACE replace)` Deprecated. since ages - use`activateMasterTenant()`, `setCurrentTenant(Tenant)` or `setCurrentTenantByID(String)` instead
`static Tenant`	`activateMasterTenantAndFailIfAlreadySet()` Deprecated. since ages - use`activateMasterTenant()`, `setCurrentTenant(Tenant)` or `setCurrentTenantByID(String)` instead
`static Tenant`	`activateMasterTenantForInit()`
`static void`	`activateStandaloneMode()`
`protected static boolean`	`assureTenantStarted(AbstractTenant sys)`
`static void`	`destroy(boolean all)`
`static void`	`destroyAndForceStartup()` Can be called to ensure new Singletons are created and all startup()-Hookins are called again.
`static ApplicationContext`	`getApplicationContext()` Tries to retrieve web implementation of the `ApplicationContext` from the current `javax.servlet.ServletContext` or from http session `WebSessionFunctions.getCurrentHttpSession()` if it fails it fall backs to core application spring context see `getCoreApplicationContext()`.
`static java.util.Collection<java.lang.String>`	`getClusterGroups()`
`static int`	`getClusterID()` Returns the cluster ID assigned to this platform instance.
`static ApplicationContext`	`getCoreApplicationContext()` Method returns an instance of `ApplicationContext` context.
`static <T extends Tenant> T`	`getCurrentTenant()` Returns the tenant currently associated with the callers thread.
`protected static java.lang.Exception`	`getCurrentTenantActivationTrace()`
`protected static Tenant`	`getCurrentTenantInternal()`
`static <T extends Tenant> T`	`getCurrentTenantNoFallback()` Returns the tenant currently associated with the callers thread or `NULL` if no tenant had been activated.
`static ApplicationContext`	`getGlobalApplicationContext()` Deprecated. since 5.0 use `getCoreApplicationContext()` instead
`static MasterTenant`	`getMasterTenant()`
`static <T> T`	`getNonTenantSingleton(SingletonCreator.Creator<T> creator)`
`static PersistenceManager`	`getPersistenceManager()`
`static int`	`getPreferredClusterID()` Deprecated. since ages - use`isStandaloneMode()` instead
`static ServletContext`	`getServletContextIfExists()` Returns servlet context if invoked in webcontext
`static <T> T`	`getSingleton(java.lang.Class<T> clazz)`
`static <T> T`	`getSingleton(SingletonCreator.Creator<T> creator)`
`static ApplicationContext`	`getSingletonGlobalApplicationContext()` This method returns a global 'super' spring context.
`static SlaveTenant`	`getSlaveJunitTenant()` returns a slave tenant instance if exist otherwise throws `IllegalStateException`.
`static java.util.Map<java.lang.String,SlaveTenant>`	`getSlaveTenants()` returns immutable map of slave tenant configuration
`static <T extends Tenant> T`	`getTenantByID(java.lang.String id)` Return the tenant by its ID or NULL if no tenant was found.
`static java.util.List<TenantListener>`	`getTenantListeners()` Gets all listeners registered for getting tenant notifications.
`static boolean`	`hasCurrentTenant()` Tells whether the callers thread is already associated with a tenant.
`static boolean`	`isCurrentTenant(Tenant tenant)` Tells whether the callers thread is associated with the given tenant.
`static boolean`	`isCurrentTenantStarted()`
`static boolean`	`isStandaloneMode()`
`static void`	`registerTenantListener(TenantListener listener)` Registers a `TenantListener` which will be then notified on tenant start up / shut down.
`static <T> T`	`replaceSingleton(SingletonCreator.Creator<T> creator)`
`static <T> T`	`runAsTenant(Tenant tenant, java.util.concurrent.Callable<T> callable)` Runs a given Callable within the given tenant.
`static void`	`setCurrentTenant(Tenant tenant)` Activates the given tenant as current tenant for the callers thread.
`static void`	`setCurrentTenantByID(java.lang.String tenantID)`
`protected static void`	`setCurrentTenantInternal(Tenant tenant)`
`static void`	`setPreferredClusterID(int clusterid)` Deprecated. since ages - Use`activateStandaloneMode()` instead
`static void`	`startup()` This method starts up the Registry.
`static void`	`unregisterTenantListener(TenantListener listener)` Unregisters a `TenantListener` for not be notified on tenant start up / shut down anymore.
`static void`	`unsetCurrentTenant()` De-activates the currently active tenant for the callers thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSTEM_PROPERTY_FAILSAFE_ACTIVE
```
public static final java.lang.String SYSTEM_PROPERTY_FAILSAFE_ACTIVE
```
    See Also:
    
    Constant Field Values
  - FAILSAVE_NOTENANTACTIVE
```
public static final boolean FAILSAVE_NOTENANTACTIVE
```
- Constructor Detail
  - Registry
```
public Registry()
```
- Method Detail
  - getSlaveTenants
```
public static java.util.Map<java.lang.String,SlaveTenant> getSlaveTenants()
```
    returns immutable map of slave tenant configuration
  - getSlaveJunitTenant
```
public static SlaveTenant getSlaveJunitTenant()
```
    returns a slave tenant instance if exist otherwise throws IllegalStateException.
  - destroyAndForceStartup
```
public static void destroyAndForceStartup()
```
    Can be called to ensure new Singletons are created and all startup()-Hookins are called again. This is normally done at system startup (in Registry.static{}) and before a new system database initialization is made
  - getCurrentTenantActivationTrace
```
protected static java.lang.Exception getCurrentTenantActivationTrace()
```
  - setCurrentTenantInternal
```
protected static void setCurrentTenantInternal(Tenant tenant)
```
  - getCurrentTenantInternal
```
protected static Tenant getCurrentTenantInternal()
```
  - destroy
```
public static void destroy(boolean all)
```
  - startup
```
public static void startup()
```
    This method starts up the Registry. If the Registry is already started, it returns immediately. It is usually safe to call this method from several places to ensure the Registry is correctly started. (e.g. in Item(), Manager() ) Note that if system shutdown is in progress (RedeployUtilities.isShutdownInProgress()), this method returns immediately without doing anything.
  - getNonTenantSingleton
```
public static <T> T getNonTenantSingleton(SingletonCreator.Creator<T> creator)
```
  - getSingleton
```
public static <T> T getSingleton(java.lang.Class<T> clazz)
```
  - getSingleton
```
public static <T> T getSingleton(SingletonCreator.Creator<T> creator)
```
  - replaceSingleton
```
public static <T> T replaceSingleton(SingletonCreator.Creator<T> creator)
```
  - runAsTenant
```
public static <T> T runAsTenant(Tenant tenant,
                                java.util.concurrent.Callable<T> callable)
                         throws java.lang.Exception
```
    Runs a given Callable within the given tenant. The previously active tenant (if one is set) is deactivated before and activated afterward execution. If the same tenant was active, it stays active. If none was active before there will be no tenant active afterwards.
    
    Throws:
    
    java.lang.Exception
  - setCurrentTenant
```
public static void setCurrentTenant(Tenant tenant)
```
    Activates the given tenant as current tenant for the callers thread.
    
    See Also:
    
    activateMasterTenant(), setCurrentTenantByID(String), unsetCurrentTenant()
  - activateMasterTenantAndFailIfAlreadySet
```
@Deprecated
public static Tenant activateMasterTenantAndFailIfAlreadySet()
```
    Deprecated. since ages - useactivateMasterTenant(), setCurrentTenant(Tenant) or setCurrentTenantByID(String) instead
    
    Activates the master tenant.
    
    Returns:
    
    the previous tenant
    
    Throws:
    
    java.lang.IllegalStateException - if the current tenant is already set
  - activateMasterTenant
```
public static Tenant activateMasterTenant()
```
    Internal note: currently called via reflection from JUnitTestRunner to assure that "ant yunit" will work
    
    Returns:
    
    the previous tenant
  - activateMasterTenantForInit
```
public static Tenant activateMasterTenantForInit()
```
  - activateMasterTenant
```
@Deprecated
public static Tenant activateMasterTenant(de.hybris.platform.core.Registry.REPLACE replace)
```
    Deprecated. since ages - useactivateMasterTenant(), setCurrentTenant(Tenant) or setCurrentTenantByID(String) instead
  - assureTenantStarted
```
protected static boolean assureTenantStarted(AbstractTenant sys)
```
  - setCurrentTenantByID
```
public static void setCurrentTenantByID(java.lang.String tenantID)
```
  - unsetCurrentTenant
```
public static void unsetCurrentTenant()
```
    De-activates the currently active tenant for the callers thread. In case no tenant had been active this method has no effect.
    
    See Also:
    
    activateMasterTenant(), setCurrentTenantByID(String), setCurrentTenant(Tenant)
  - hasCurrentTenant
```
public static boolean hasCurrentTenant()
```
    Tells whether the callers thread is already associated with a tenant.
  - isCurrentTenant
```
public static boolean isCurrentTenant(Tenant tenant)
```
    Tells whether the callers thread is associated with the given tenant.
  - getCurrentTenantNoFallback
```
public static <T extends Tenant> T getCurrentTenantNoFallback()
```
    Returns the tenant currently associated with the callers thread or NULL if no tenant had been activated.
    
    See Also:
    
    getCurrentTenant()
  - isCurrentTenantStarted
```
public static boolean isCurrentTenantStarted()
```
  - getCurrentTenant
```
public static <T extends Tenant> T getCurrentTenant()
```
    Returns the tenant currently associated with the callers thread. This may be any SlaveTenant or (as default) the MasterTenant. Please note that depending upon the setting of activate.tenant.fallback this method will automatically activate the master tenant if no current tenant could be found!
    
    Throws:
    
    java.lang.IllegalStateException - in case no tenant has been activated and fallback mode is not switched on (system property 'activate.tenant.fallback')
    
    See Also:
    
    getCurrentTenantNoFallback()
  - getTenantByID
```
public static <T extends Tenant> T getTenantByID(java.lang.String id)
```
    Return the tenant by its ID or NULL if no tenant was found.
  - getPersistenceManager
```
public static PersistenceManager getPersistenceManager()
```
  - getMasterTenant
```
public static MasterTenant getMasterTenant()
```
  - getClusterID
```
public static final int getClusterID()
```
    Returns the cluster ID assigned to this platform instance.
  - getClusterGroups
```
public static final java.util.Collection<java.lang.String> getClusterGroups()
```
  - setPreferredClusterID
```
@Deprecated
public static void setPreferredClusterID(int clusterid)
```
    Deprecated. since ages - UseactivateStandaloneMode() instead
    
    set the preferred clusternode. note that this setting will be ignored if the registry is already initialized (e.g. if running on tomcat). it can be useful if running as a standalone application to ensure a different clusternode
    
    Parameters:
    
    clusterid - the preferred clusternode (0-15). if set to -1, the preferral is cleared.
  - getPreferredClusterID
```
@Deprecated
public static int getPreferredClusterID()
```
    Deprecated. since ages - useisStandaloneMode() instead
  - activateStandaloneMode
```
public static void activateStandaloneMode()
```
  - isStandaloneMode
```
public static boolean isStandaloneMode()
```
  - getGlobalApplicationContext
```
@Deprecated
public static ApplicationContext getGlobalApplicationContext()
```
    Deprecated. since 5.0 use getCoreApplicationContext() instead
    
    See Also:
    
    getCoreApplicationContext()
  - getApplicationContext
```
public static ApplicationContext getApplicationContext()
```
    Tries to retrieve web implementation of the ApplicationContext from the current javax.servlet.ServletContext or from http session WebSessionFunctions.getCurrentHttpSession() if it fails it fall backs to core application spring context see getCoreApplicationContext().
    
    Returns:
    
    current application context
  - getServletContextIfExists
```
public static ServletContext getServletContextIfExists()
```
    Returns servlet context if invoked in webcontext
    
    Returns:
    
    servlet context if available, otherwise null
  - getCoreApplicationContext
```
public static ApplicationContext getCoreApplicationContext()
```
    Method returns an instance of ApplicationContext context.
    - If current thread 'has a tenant'. This context consists of merged of every available extension beans definition(s) (its core part spring definitions) specific for the tenant. The bean definitions can be provided using properties as :
      ${extname}.application-context = ...
      The context also has as a parent global 'super' context @see getSingletonGlobalApplicationContext().
    - Otherwise it returns a empty context which in most case will cause application to fail.
    Returns:
    
    current global application context
  - getSingletonGlobalApplicationContext
```
public static ApplicationContext getSingletonGlobalApplicationContext()
```
    This method returns a global 'super' spring context. This context is not tenant aware. It contains a beans defined in spring configuration defined in properties as :
```
  ${extname}.global-application-context = ...
 
```
    Warning In most cases this context won't contain a business logic beans only those infrastructure ones which needs to stay in memory longer than tenant lifecycle.
  - registerTenantListener
```
public static void registerTenantListener(TenantListener listener)
```
    Registers a TenantListener which will be then notified on tenant start up / shut down.
    
    Parameters:
    
    listener - the listener to register for notifications
    
    Since:
    
    3.1-u1
  - unregisterTenantListener
```
public static void unregisterTenantListener(TenantListener listener)
```
    Unregisters a TenantListener for not be notified on tenant start up / shut down anymore.
    
    Parameters:
    
    listener - the listener to unregister for notifications
    
    Since:
    
    3.1-u1
  - getTenantListeners
```
public static java.util.List<TenantListener> getTenantListeners()
```
    Gets all listeners registered for getting tenant notifications.
    
    Returns:
    
    Unmodifiable list of all registered listeners
    
    Since:
    
    3.1-u1

Class Registry

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_PROPERTY_FAILSAFE_ACTIVE

FAILSAVE_NOTENANTACTIVE

Constructor Detail

Registry

Method Detail

getSlaveTenants

getSlaveJunitTenant

destroyAndForceStartup

getCurrentTenantActivationTrace

setCurrentTenantInternal

getCurrentTenantInternal

destroy

startup

getNonTenantSingleton

getSingleton

getSingleton

replaceSingleton

runAsTenant

setCurrentTenant

activateMasterTenantAndFailIfAlreadySet

activateMasterTenant

activateMasterTenantForInit

activateMasterTenant

assureTenantStarted

setCurrentTenantByID

unsetCurrentTenant

hasCurrentTenant

isCurrentTenant

getCurrentTenantNoFallback

isCurrentTenantStarted

getCurrentTenant

getTenantByID

getPersistenceManager

getMasterTenant

getClusterID

getClusterGroups

setPreferredClusterID

getPreferredClusterID

activateStandaloneMode

isStandaloneMode

getGlobalApplicationContext

getApplicationContext

getServletContextIfExists

getCoreApplicationContext

getSingletonGlobalApplicationContext

registerTenantListener

unregisterTenantListener

getTenantListeners