com.sitewhere.spi.server.tenant

Interface ISiteWhereTenantEngine

All Superinterfaces:

com.sitewhere.spi.server.lifecycle.ILifecycleComponent, com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot, com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

public interface ISiteWhereTenantEngine
extends com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent, com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot

A SiteWhere tenant engine wraps up the processing pipeline and data storage for a single SiteWhere tenant.

Method Summary

Modifier and Type	Method and Description
com.sitewhere.spi.asset.IAssetManagement	getAssetManagement() Get the asset management implementation.
com.sitewhere.spi.asset.IAssetManagementCacheProvider	getAssetManagementCacheProvider() Get the asset management cache provider implementation.
com.sitewhere.spi.asset.IAssetModuleManager	getAssetModuleManager() Get the asset modules manager instance.
com.sitewhere.spi.device.communication.IDeviceCommunication	getDeviceCommunication() Get the device communication subsystem implementation.
com.sitewhere.spi.device.event.IDeviceEventManagement	getDeviceEventManagement() Get the device event management implementation.
com.sitewhere.spi.device.IDeviceManagement	getDeviceManagement() Get the device management implementation.
com.sitewhere.spi.device.IDeviceManagementCacheProvider	getDeviceManagementCacheProvider() Get the device management cache provider implementation.
com.sitewhere.spi.server.ITenantRuntimeState	getEngineState() Get current runtime state of engine.
com.sitewhere.spi.device.event.IEventProcessing	getEventProcessing() Get the event processing subsystem implementation.
IGlobalConfigurationResolver	getGlobalConfigurationResolver() Get resolver for global configuration elements.
ITenantGroovyConfiguration	getGroovyConfiguration() Get tenant-scoped Groovy configuration.
ITenantPersistentState	getPersistentState() Get state information that is persisted across engine restarts.
com.sitewhere.spi.scheduling.IScheduleManagement	getScheduleManagement() Get the schedule management implementation.
com.sitewhere.spi.scheduling.IScheduleManager	getScheduleManager() Get the schedule manager implementation.
com.sitewhere.spi.search.external.ISearchProviderManager	getSearchProviderManager() Get the search provider manager implementation.
org.springframework.context.ApplicationContext	getSpringContext() Get Spring ApplicationContext used to configure the tenant engine.
ITenantConfigurationResolver	getTenantConfigurationResolver() Get resolver for tenant configuration elements.
com.sitewhere.spi.command.ICommandResponse	issueCommand(java.lang.String command, com.sitewhere.spi.server.lifecycle.ILifecycleProgressMonitor monitor) Issue a command to the tenant engine.
void	persistState(ITenantPersistentState state) Persist the engine state.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot

getLifecycleComponentById, getRegisteredLifecycleComponents

Method Detail

getGlobalConfigurationResolver

IGlobalConfigurationResolver getGlobalConfigurationResolver()

Get resolver for global configuration elements.

Returns:

getTenantConfigurationResolver

ITenantConfigurationResolver getTenantConfigurationResolver()

Get resolver for tenant configuration elements.

Returns:

getSpringContext

org.springframework.context.ApplicationContext getSpringContext()

Get Spring ApplicationContext used to configure the tenant engine.

Returns:

getGroovyConfiguration

ITenantGroovyConfiguration getGroovyConfiguration()

Get tenant-scoped Groovy configuration.

Returns:

getDeviceManagement

com.sitewhere.spi.device.IDeviceManagement getDeviceManagement()

Get the device management implementation.

Returns:

getDeviceEventManagement

com.sitewhere.spi.device.event.IDeviceEventManagement getDeviceEventManagement()

Get the device event management implementation.

Returns:

getAssetManagement

com.sitewhere.spi.asset.IAssetManagement getAssetManagement()

Get the asset management implementation.

Returns:

getScheduleManagement

com.sitewhere.spi.scheduling.IScheduleManagement getScheduleManagement()
                                                                throws com.sitewhere.spi.SiteWhereException

Get the schedule management implementation.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceManagementCacheProvider

com.sitewhere.spi.device.IDeviceManagementCacheProvider getDeviceManagementCacheProvider()

Get the device management cache provider implementation.

Returns:

getAssetManagementCacheProvider

com.sitewhere.spi.asset.IAssetManagementCacheProvider getAssetManagementCacheProvider()

Get the asset management cache provider implementation.

Returns:

getDeviceCommunication

com.sitewhere.spi.device.communication.IDeviceCommunication getDeviceCommunication()

Get the device communication subsystem implementation.

Returns:

getEventProcessing

com.sitewhere.spi.device.event.IEventProcessing getEventProcessing()

Get the event processing subsystem implementation.

Returns:

getAssetModuleManager

com.sitewhere.spi.asset.IAssetModuleManager getAssetModuleManager()

Get the asset modules manager instance.

Returns:

getSearchProviderManager

com.sitewhere.spi.search.external.ISearchProviderManager getSearchProviderManager()

Get the search provider manager implementation.

Returns:

getScheduleManager

com.sitewhere.spi.scheduling.IScheduleManager getScheduleManager()
                                                          throws com.sitewhere.spi.SiteWhereException

Get the schedule manager implementation.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getEngineState

com.sitewhere.spi.server.ITenantRuntimeState getEngineState()

Get current runtime state of engine.

Returns:

getPersistentState

ITenantPersistentState getPersistentState()
                                   throws com.sitewhere.spi.SiteWhereException

Get state information that is persisted across engine restarts.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

persistState

void persistState(ITenantPersistentState state)
           throws com.sitewhere.spi.SiteWhereException

Persist the engine state.

Parameters:

state -

Throws:

com.sitewhere.spi.SiteWhereException

issueCommand

com.sitewhere.spi.command.ICommandResponse issueCommand(java.lang.String command,
                                                        com.sitewhere.spi.server.lifecycle.ILifecycleProgressMonitor monitor)
                                                 throws com.sitewhere.spi.SiteWhereException

Issue a command to the tenant engine.

Parameters:

command -

monitor -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException