com.sitewhere.spi.tenant

Interface ITenantManagement

All Superinterfaces:

ILifecycleComponent

public interface ITenantManagement
extends ILifecycleComponent

Interface for tenant management operations.

Method Summary

Modifier and Type	Method and Description
java.util.List<ITenantGroupElement>	addTenantGroupElements(java.lang.String token, java.util.List<ITenantGroupElementCreateRequest> elements) Add elements to a tenant group.
ITenant	createTenant(ITenantCreateRequest request) Create a new tenant.
ITenantGroup	createTenantGroup(ITenantGroupCreateRequest request) Create a new tenant group.
ITenant	deleteTenant(java.lang.String tenantId, boolean force) Delete an existing tenant.
ITenantGroup	deleteTenantGroup(java.lang.String groupId, boolean force) Delete an existing tenant group based on its unique id.
ITenant	getTenantByAuthenticationToken(java.lang.String token) Get a tenant by authentication token sent by devices.
ITenant	getTenantById(java.lang.String id) Get a tenant by tenant id.
ITenantGroup	getTenantGroupByToken(java.lang.String token) Get a tenant group by unique token.
ISearchResults<ITenantGroupElement>	listTenantGroupElements(java.lang.String token, ISearchCriteria criteria) List elements in a tenant group.
ISearchResults<ITenantGroup>	listTenantGroups(ISearchCriteria criteria) List tenant groups that meet the given criteria.
ISearchResults<ITenant>	listTenants(ITenantSearchCriteria criteria) Find all tenants that match the given criteria.
java.util.List<ITenantGroupElement>	removeTenantGroupElements(java.lang.String token, java.util.List<ITenantGroupElementCreateRequest> elements) Remove elements from a tenant group.
ITenant	updateTenant(java.lang.String id, ITenantCreateRequest request) Update an existing tenant.
ITenantGroup	updateTenantGroup(java.lang.String token, ITenantGroupCreateRequest request) Update an existing tenant group.

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

createTenant

ITenant createTenant(ITenantCreateRequest request)
              throws SiteWhereException

Create a new tenant.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateTenant

ITenant updateTenant(java.lang.String id,
                     ITenantCreateRequest request)
              throws SiteWhereException

Update an existing tenant.

Parameters:

id -

request -

Returns:

Throws:

SiteWhereException

getTenantById

ITenant getTenantById(java.lang.String id)
               throws SiteWhereException

Get a tenant by tenant id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

getTenantByAuthenticationToken

ITenant getTenantByAuthenticationToken(java.lang.String token)
                                throws SiteWhereException

Get a tenant by authentication token sent by devices.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listTenants

ISearchResults<ITenant> listTenants(ITenantSearchCriteria criteria)
                             throws SiteWhereException

Find all tenants that match the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteTenant

ITenant deleteTenant(java.lang.String tenantId,
                     boolean force)
              throws SiteWhereException

Delete an existing tenant.

Parameters:

tenantId -

force -

Returns:

Throws:

SiteWhereException

createTenantGroup

ITenantGroup createTenantGroup(ITenantGroupCreateRequest request)
                        throws SiteWhereException

Create a new tenant group.

Parameters:

request -

Returns:

Throws:

SiteWhereException

updateTenantGroup

ITenantGroup updateTenantGroup(java.lang.String token,
                               ITenantGroupCreateRequest request)
                        throws SiteWhereException

Update an existing tenant group.

Parameters:

token -

request -

Returns:

Throws:

SiteWhereException

getTenantGroupByToken

ITenantGroup getTenantGroupByToken(java.lang.String token)
                            throws SiteWhereException

Get a tenant group by unique token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

listTenantGroups

ISearchResults<ITenantGroup> listTenantGroups(ISearchCriteria criteria)
                                       throws SiteWhereException

List tenant groups that meet the given criteria.

Parameters:

criteria -

Returns:

Throws:

SiteWhereException

deleteTenantGroup

ITenantGroup deleteTenantGroup(java.lang.String groupId,
                               boolean force)
                        throws SiteWhereException

Delete an existing tenant group based on its unique id.

Parameters:

groupId -

force -

Returns:

Throws:

SiteWhereException

addTenantGroupElements

java.util.List<ITenantGroupElement> addTenantGroupElements(java.lang.String token,
                                                           java.util.List<ITenantGroupElementCreateRequest> elements)
                                                    throws SiteWhereException

Add elements to a tenant group.

Parameters:

token -

elements -

Returns:

Throws:

SiteWhereException

removeTenantGroupElements

java.util.List<ITenantGroupElement> removeTenantGroupElements(java.lang.String token,
                                                              java.util.List<ITenantGroupElementCreateRequest> elements)
                                                       throws SiteWhereException

Remove elements from a tenant group.

Parameters:

token -

elements -

Returns:

Throws:

SiteWhereException

listTenantGroupElements

ISearchResults<ITenantGroupElement> listTenantGroupElements(java.lang.String token,
                                                            ISearchCriteria criteria)
                                                     throws SiteWhereException

List elements in a tenant group.

Parameters:

token -

criteria -

Returns:

Throws:

SiteWhereException