com.sitewhere.spi.server

Interface ISiteWhereServer

All Superinterfaces:

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

public interface ISiteWhereServer
extends com.sitewhere.spi.server.lifecycle.ILifecycleComponent, com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot

Interface for interacting with core SiteWhere server functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENV_SITEWHERE_HOME SiteWhere home environment variable name

Method Summary

Modifier and Type	Method and Description
com.sitewhere.spi.asset.IAssetManagement	getAssetManagement(com.sitewhere.spi.tenant.ITenant tenant) Get asset management implementation for the given tenant.
com.sitewhere.spi.asset.IAssetModuleManager	getAssetModuleManager(com.sitewhere.spi.tenant.ITenant tenant) Get asset module manager for tenant.
java.util.List<com.sitewhere.spi.tenant.ITenant>	getAuthorizedTenants(java.lang.String userId, boolean requireStarted) Get list of tenants a given user can access.
com.sitewhere.spi.resource.IResourceManager	getBootstrapResourceManager() Get resource manager for bootstrapping the system.
java.lang.String	getConfigurationParserClassname() Get Spring parser class name for handling bean definitions.
IGlobalConfigurationResolver	getConfigurationResolver() Get class that can be used to location the Spring configuration context.
com.sitewhere.spi.device.communication.IDeviceCommunication	getDeviceCommunication(com.sitewhere.spi.tenant.ITenant tenant) Get device communication subsystem for the given tenant.
com.sitewhere.spi.device.event.IDeviceEventManagement	getDeviceEventManagement(com.sitewhere.spi.tenant.ITenant tenant) Get device event management implementation for tenant.
com.sitewhere.spi.device.IDeviceManagement	getDeviceManagement(com.sitewhere.spi.tenant.ITenant tenant) Get device management implementation for tenant.
com.sitewhere.spi.device.IDeviceManagementCacheProvider	getDeviceManagementCacheProvider(com.sitewhere.spi.tenant.ITenant tenant) Get device management cache provider for tenant.
com.sitewhere.spi.device.event.IEventProcessing	getEventProcessing(com.sitewhere.spi.tenant.ITenant tenant) Get the event processing subsystem for the given tenant.
IGroovyConfiguration	getGroovyConfiguration() Get the common Groovy configuration for this node.
IHazelcastConfiguration	getHazelcastConfiguration() Get the Hazelcast configuration for this node.
com.codahale.metrics.health.HealthCheckRegistry	getHealthCheckRegistry() Get the health check registry.
com.codahale.metrics.MetricRegistry	getMetricRegistry() Get the metrics registry.
com.sitewhere.spi.resource.IResourceManager	getRuntimeResourceManager() Get resource manager for resolving runtime resource references.
com.sitewhere.spi.scheduling.IScheduleManagement	getScheduleManagement(com.sitewhere.spi.tenant.ITenant tenant) Get schedule management implementation for the given tenant.
com.sitewhere.spi.scheduling.IScheduleManager	getScheduleManager(com.sitewhere.spi.tenant.ITenant tenant) Get schedule manager for tenant.
com.sitewhere.spi.search.external.ISearchProviderManager	getSearchProviderManager(com.sitewhere.spi.tenant.ITenant tenant) Get search provider manager for tenant.
ISiteWhereServerRuntime	getServerRuntimeInformation(boolean includeHistorical) Gets runtime information about the server.
com.sitewhere.spi.ServerStartupException	getServerStartupError() Returns exception if one was thrown on startup.
ISiteWhereServerState	getServerState() Get persistent server state information.
com.sitewhere.spi.tenant.ITenant	getTenantByAuthToken(java.lang.String authToken) Get a tenant based on its authentication token.
java.lang.String	getTenantConfigurationParserClassname() Get Spring parser class name for handling tenant bean definitions.
ISiteWhereTenantEngine	getTenantEngine(java.lang.String tenantId) Get a tenant engine by tenant id.
ITenantGroovyConfiguration	getTenantGroovyConfiguration(com.sitewhere.spi.tenant.ITenant tenant) Get Groovy configuration for tenant.
com.sitewhere.spi.tenant.ITenantManagement	getTenantManagement() Get the tenant management implementation.
ITenantTemplateManager	getTenantTemplateManager() Get tenant template manager implementation.
ITracer	getTracer() Get tracer for debug operations.
com.sitewhere.spi.user.IUserManagement	getUserManagement() Get the user management implementation.
com.sitewhere.spi.system.IVersion	getVersion() Get version information.
void	onTenantInformationUpdated(com.sitewhere.spi.tenant.ITenant tenant) Called when tenant information has been updated so that cached data is kept current.
void	setServerStartupError(com.sitewhere.spi.ServerStartupException e) Set server startup error reason.

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

Field Detail

ENV_SITEWHERE_HOME

static final java.lang.String ENV_SITEWHERE_HOME

SiteWhere home environment variable name

See Also:

Constant Field Values

Method Detail

getVersion

com.sitewhere.spi.system.IVersion getVersion()

Get version information.

Returns:

getConfigurationParserClassname

java.lang.String getConfigurationParserClassname()

Get Spring parser class name for handling bean definitions.

Returns:

getTenantConfigurationParserClassname

java.lang.String getTenantConfigurationParserClassname()

Get Spring parser class name for handling tenant bean definitions.

Returns:

getServerState

ISiteWhereServerState getServerState()

Get persistent server state information.

Returns:

getServerRuntimeInformation

ISiteWhereServerRuntime getServerRuntimeInformation(boolean includeHistorical)
                                             throws com.sitewhere.spi.SiteWhereException

Gets runtime information about the server.

Parameters:

includeHistorical -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getServerStartupError

com.sitewhere.spi.ServerStartupException getServerStartupError()

Returns exception if one was thrown on startup.

Returns:

setServerStartupError

void setServerStartupError(com.sitewhere.spi.ServerStartupException e)

Set server startup error reason.

Parameters:

e -

getTracer

ITracer getTracer()

Get tracer for debug operations.

Returns:

getHazelcastConfiguration

IHazelcastConfiguration getHazelcastConfiguration()

Get the Hazelcast configuration for this node.

Returns:

getGroovyConfiguration

IGroovyConfiguration getGroovyConfiguration()

Get the common Groovy configuration for this node.

Returns:

getBootstrapResourceManager

com.sitewhere.spi.resource.IResourceManager getBootstrapResourceManager()

Get resource manager for bootstrapping the system.

Returns:

getRuntimeResourceManager

com.sitewhere.spi.resource.IResourceManager getRuntimeResourceManager()

Get resource manager for resolving runtime resource references.

Returns:

getConfigurationResolver

IGlobalConfigurationResolver getConfigurationResolver()

Get class that can be used to location the Spring configuration context.

Returns:

getTenantTemplateManager

ITenantTemplateManager getTenantTemplateManager()

Get tenant template manager implementation.

Returns:

getTenantByAuthToken

com.sitewhere.spi.tenant.ITenant getTenantByAuthToken(java.lang.String authToken)
                                               throws com.sitewhere.spi.SiteWhereException

Get a tenant based on its authentication token.

Parameters:

authToken -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAuthorizedTenants

java.util.List<com.sitewhere.spi.tenant.ITenant> getAuthorizedTenants(java.lang.String userId,
                                                                      boolean requireStarted)
                                                               throws com.sitewhere.spi.SiteWhereException

Get list of tenants a given user can access.

Parameters:

userId -

requireStarted -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getTenantEngine

ISiteWhereTenantEngine getTenantEngine(java.lang.String tenantId)
                                throws com.sitewhere.spi.SiteWhereException

Get a tenant engine by tenant id. If a tenant exists but the engine has not been initialized, the tenant engine will be initialized and started.

Parameters:

tenantId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

onTenantInformationUpdated

void onTenantInformationUpdated(com.sitewhere.spi.tenant.ITenant tenant)
                         throws com.sitewhere.spi.SiteWhereException

Called when tenant information has been updated so that cached data is kept current.

Parameters:

tenant -

Throws:

com.sitewhere.spi.SiteWhereException

getUserManagement

com.sitewhere.spi.user.IUserManagement getUserManagement()

Get the user management implementation.

Returns:

getTenantManagement

com.sitewhere.spi.tenant.ITenantManagement getTenantManagement()

Get the tenant management implementation.

Returns:

getDeviceManagement

com.sitewhere.spi.device.IDeviceManagement getDeviceManagement(com.sitewhere.spi.tenant.ITenant tenant)
                                                        throws com.sitewhere.spi.SiteWhereException

Get device management implementation for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceEventManagement

com.sitewhere.spi.device.event.IDeviceEventManagement getDeviceEventManagement(com.sitewhere.spi.tenant.ITenant tenant)
                                                                        throws com.sitewhere.spi.SiteWhereException

Get device event management implementation for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceManagementCacheProvider

com.sitewhere.spi.device.IDeviceManagementCacheProvider getDeviceManagementCacheProvider(com.sitewhere.spi.tenant.ITenant tenant)
                                                                                  throws com.sitewhere.spi.SiteWhereException

Get device management cache provider for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssetManagement

com.sitewhere.spi.asset.IAssetManagement getAssetManagement(com.sitewhere.spi.tenant.ITenant tenant)
                                                     throws com.sitewhere.spi.SiteWhereException

Get asset management implementation for the given tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScheduleManagement

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

Get schedule management implementation for the given tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceCommunication

com.sitewhere.spi.device.communication.IDeviceCommunication getDeviceCommunication(com.sitewhere.spi.tenant.ITenant tenant)
                                                                            throws com.sitewhere.spi.SiteWhereException

Get device communication subsystem for the given tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getEventProcessing

com.sitewhere.spi.device.event.IEventProcessing getEventProcessing(com.sitewhere.spi.tenant.ITenant tenant)
                                                            throws com.sitewhere.spi.SiteWhereException

Get the event processing subsystem for the given tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssetModuleManager

com.sitewhere.spi.asset.IAssetModuleManager getAssetModuleManager(com.sitewhere.spi.tenant.ITenant tenant)
                                                           throws com.sitewhere.spi.SiteWhereException

Get asset module manager for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getSearchProviderManager

com.sitewhere.spi.search.external.ISearchProviderManager getSearchProviderManager(com.sitewhere.spi.tenant.ITenant tenant)
                                                                           throws com.sitewhere.spi.SiteWhereException

Get search provider manager for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScheduleManager

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

Get schedule manager for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getTenantGroovyConfiguration

ITenantGroovyConfiguration getTenantGroovyConfiguration(com.sitewhere.spi.tenant.ITenant tenant)
                                                 throws com.sitewhere.spi.SiteWhereException

Get Groovy configuration for tenant.

Parameters:

tenant -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getMetricRegistry

com.codahale.metrics.MetricRegistry getMetricRegistry()

Get the metrics registry.

Returns:

getHealthCheckRegistry

com.codahale.metrics.health.HealthCheckRegistry getHealthCheckRegistry()

Get the health check registry.

Returns: