com.sitewhere.spi.resource

Interface IResourceManager

All Superinterfaces:

ILifecycleComponent

public interface IResourceManager
extends ILifecycleComponent

Interface for component that manages system resources.

Method Summary

Modifier and Type	Method and Description
IMultiResourceCreateResponse	copyTemplateResourcesToTenant(java.lang.String templateId, java.lang.String tenantId, ResourceCreateMode mode) Copies resources from a tenant template into a tenant with the given id.
IMultiResourceCreateResponse	createGlobalResources(java.util.List<IResourceCreateRequest> request, ResourceCreateMode mode) Create one or more global resources.
IMultiResourceCreateResponse	createTenantResources(java.lang.String tenantId, java.util.List<IResourceCreateRequest> request, ResourceCreateMode mode) Create one or more tenant resources.
IResource	deleteGlobalResource(java.lang.String path) Delete global resource at the given path.
IResource	deleteTenantResource(java.lang.String tenantId, java.lang.String path) Delete tenant resource at the given path.
IResource	getGlobalResource(java.lang.String path) Get a global resource registered for the given path.
java.util.List<IResource>	getGlobalResources() Get list of all global resources.
IResource	getTenantResource(java.lang.String tenantId, java.lang.String path) Get a tenant resource registered for the given path.
java.util.List<IResource>	getTenantResources(java.lang.String tenantId) Get list of all resources for the given tenant.
java.util.List<IResource>	getTenantTemplateResources(java.lang.String templateId) Gets resources associated with the given tenant template.
java.util.List<java.lang.String>	getTenantTemplateRoots() Get root names for tenant template resource trees.

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

Method Detail

createGlobalResources

IMultiResourceCreateResponse createGlobalResources(java.util.List<IResourceCreateRequest> request,
                                                   ResourceCreateMode mode)
                                            throws SiteWhereException

Create one or more global resources.

Parameters:

request -

mode -

Returns:

Throws:

SiteWhereException

getGlobalResource

IResource getGlobalResource(java.lang.String path)
                     throws SiteWhereException

Get a global resource registered for the given path.

Parameters:

path -

Returns:

Throws:

SiteWhereException

getGlobalResources

java.util.List<IResource> getGlobalResources()
                                      throws SiteWhereException

Get list of all global resources.

Returns:

Throws:

SiteWhereException

getTenantTemplateRoots

java.util.List<java.lang.String> getTenantTemplateRoots()
                                                 throws SiteWhereException

Get root names for tenant template resource trees.

Returns:

Throws:

SiteWhereException

getTenantTemplateResources

java.util.List<IResource> getTenantTemplateResources(java.lang.String templateId)
                                              throws SiteWhereException

Gets resources associated with the given tenant template.

Parameters:

templateId -

Returns:

Throws:

SiteWhereException

deleteGlobalResource

IResource deleteGlobalResource(java.lang.String path)
                        throws SiteWhereException

Delete global resource at the given path.

Parameters:

path -

Returns:

Throws:

SiteWhereException

copyTemplateResourcesToTenant

IMultiResourceCreateResponse copyTemplateResourcesToTenant(java.lang.String templateId,
                                                           java.lang.String tenantId,
                                                           ResourceCreateMode mode)
                                                    throws SiteWhereException

Copies resources from a tenant template into a tenant with the given id.

Parameters:

prefix -

tenantId -

mode -

Returns:

Throws:

SiteWhereException

createTenantResources

IMultiResourceCreateResponse createTenantResources(java.lang.String tenantId,
                                                   java.util.List<IResourceCreateRequest> request,
                                                   ResourceCreateMode mode)
                                            throws SiteWhereException

Create one or more tenant resources.

Parameters:

tenantId -

request -

mode -

Returns:

Throws:

SiteWhereException

getTenantResource

IResource getTenantResource(java.lang.String tenantId,
                            java.lang.String path)
                     throws SiteWhereException

Get a tenant resource registered for the given path.

Parameters:

tenantId -

path -

Returns:

Throws:

SiteWhereException

getTenantResources

java.util.List<IResource> getTenantResources(java.lang.String tenantId)
                                      throws SiteWhereException

Get list of all resources for the given tenant.

Parameters:

tenantId -

Returns:

Throws:

SiteWhereException

deleteTenantResource

IResource deleteTenantResource(java.lang.String tenantId,
                               java.lang.String path)
                        throws SiteWhereException

Delete tenant resource at the given path.

Parameters:

tenantId -

path -

Returns:

Throws:

SiteWhereException