de.hybris.platform.hac.facade

Interface TenantsFacade

All Known Implementing Classes:

DefaultTenantsFacade

public interface TenantsFacade

Facade, responsible for providing the most operations on tenants data.

Method Summary

Modifier and Type	Method and Description
List<TenantData>	getAllSlaveTenants() Returns a list of TenantDatas containing the most important information about slave tenants.
String	getCurrentTenantID() returns the current tenantID
Map<String,ConfiguredExtensionData>	getExtensionsForMasterTenant() Gets the Map of all extension names for master tenant, where key is the name of extension and value is data object which determines whether particular extension is configured for master tenant or not , whether extension has a web module and what is the given context name for current tenant (if applicable).
Map<String,ConfiguredExtensionData>	getExtensionsForSlaveTenant(String slaveTenantId) Gets the Map of all extension names for slave tenant, where key is the name of extension and value is data object which determines whether particular extension is configured for slaveTenantId or not , whether extension has a web module and what is the given context name for current tenant (if applicable).
TenantData	getMasterTenant() Gets the master TenantData.
TenantData	getSlaveTenant(String slaveTenantId) Gets the slave TenantData for given slaveTenantId.
boolean	isCurrentTenantMaster() Checks if the current tenant is master tenant.

Method Detail

getAllSlaveTenants

List<TenantData> getAllSlaveTenants()

Returns a list of TenantDatas containing the most important information about slave tenants. If master tenant is not the currently used tenant - an empty list will always be returned.

Returns:

an empty list if no slave tenants exist

getCurrentTenantID

String getCurrentTenantID()

returns the current tenantID

Returns:

id of the current tenant

getExtensionsForSlaveTenant

Map<String,ConfiguredExtensionData> getExtensionsForSlaveTenant(String slaveTenantId)

Gets the Map of all extension names for slave tenant, where key is the name of extension and value is data object which determines whether particular extension is configured for slaveTenantId or not , whether extension has a web module and what is the given context name for current tenant (if applicable).

Parameters:

slaveTenantId - the slave tenant id

Returns:

map of extension names.

getExtensionsForMasterTenant

Map<String,ConfiguredExtensionData> getExtensionsForMasterTenant()

Gets the Map of all extension names for master tenant, where key is the name of extension and value is data object which determines whether particular extension is configured for master tenant or not , whether extension has a web module and what is the given context name for current tenant (if applicable).

Returns:

map of extension names.

getSlaveTenant

TenantData getSlaveTenant(String slaveTenantId)

Gets the slave TenantData for given slaveTenantId.

Parameters:

slaveTenantId - the slave tenant id

Returns:

the slave tenant object

getMasterTenant

TenantData getMasterTenant()

Gets the master TenantData.

Returns:

the master tenant data

isCurrentTenantMaster

boolean isCurrentTenantMaster()

Checks if the current tenant is master tenant.

Returns:

true, if current tenant is master tenant