com.sitewhere.spi.configuration

Interface ITenantConfigurationResolver

public interface ITenantConfigurationResolver

Pluggable resolver for interacting with global configuration data.

Method Summary

Modifier and Type	Method and Description
com.sitewhere.spi.resource.IResource	copyTenantTemplateResources() Copies all resources from the tenant template into the tenant.
com.sitewhere.spi.resource.IResource	getActiveTenantConfiguration() Gets the active configuration resource for a given tenant.
com.sitewhere.spi.resource.IResource	getAssetResource(java.lang.String path) Get an asset resource based on relative path.
IGlobalConfigurationResolver	getGlobalConfigurationResolver() Get the global configuration resolver.
com.sitewhere.spi.resource.IResource	getResourceForPath(java.lang.String path) Get tenant resource that corresponds to path.
com.sitewhere.spi.resource.IResource	getScriptResource(java.lang.String path) Get a script resource based on relative path.
com.sitewhere.spi.resource.IResource	getStagedTenantConfiguration() Gets the staged configuration resource for a given tenant.
boolean	hasStagedConfiguration() Indicates if a staged configuration exists for the tenant.
boolean	hasValidConfiguration() Indicates a configuration exists for the tenant.
com.sitewhere.spi.resource.IResource	stageTenantConfiguration(byte[] content) Stage a new tenant configuration.
void	transitionStagedToActiveTenantConfiguration() Transition the staged tenant configuration to the active tenant configuration, backing up the active configuration in the process.

Method Detail

getGlobalConfigurationResolver

IGlobalConfigurationResolver getGlobalConfigurationResolver()
                                                     throws com.sitewhere.spi.SiteWhereException

Get the global configuration resolver.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

hasValidConfiguration

boolean hasValidConfiguration()

Indicates a configuration exists for the tenant.

Returns:

hasStagedConfiguration

boolean hasStagedConfiguration()

Indicates if a staged configuration exists for the tenant.

Returns:

getResourceForPath

com.sitewhere.spi.resource.IResource getResourceForPath(java.lang.String path)
                                                 throws com.sitewhere.spi.SiteWhereException

Get tenant resource that corresponds to path.

Parameters:

path -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssetResource

com.sitewhere.spi.resource.IResource getAssetResource(java.lang.String path)
                                               throws com.sitewhere.spi.SiteWhereException

Get an asset resource based on relative path.

Parameters:

path -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getScriptResource

com.sitewhere.spi.resource.IResource getScriptResource(java.lang.String path)
                                                throws com.sitewhere.spi.SiteWhereException

Get a script resource based on relative path.

Parameters:

path -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getActiveTenantConfiguration

com.sitewhere.spi.resource.IResource getActiveTenantConfiguration()
                                                           throws com.sitewhere.spi.SiteWhereException

Gets the active configuration resource for a given tenant.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

copyTenantTemplateResources

com.sitewhere.spi.resource.IResource copyTenantTemplateResources()
                                                          throws com.sitewhere.spi.SiteWhereException

Copies all resources from the tenant template into the tenant.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getStagedTenantConfiguration

com.sitewhere.spi.resource.IResource getStagedTenantConfiguration()
                                                           throws com.sitewhere.spi.SiteWhereException

Gets the staged configuration resource for a given tenant. Returns null if no configuration is staged.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

stageTenantConfiguration

com.sitewhere.spi.resource.IResource stageTenantConfiguration(byte[] content)
                                                       throws com.sitewhere.spi.SiteWhereException

Stage a new tenant configuration. This stores the new configuration separately from the active configuration. The staged configuration will be made active the next time the tenant is restarted.

Parameters:

content -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

transitionStagedToActiveTenantConfiguration

void transitionStagedToActiveTenantConfiguration()
                                          throws com.sitewhere.spi.SiteWhereException

Transition the staged tenant configuration to the active tenant configuration, backing up the active configuration in the process.

Throws:

com.sitewhere.spi.SiteWhereException