com.sitewhere.rest.model.tenant.request.scripting

Class TenantManagementRequestBuilder

java.lang.Object

com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder

public class TenantManagementRequestBuilder
extends java.lang.Object

Builder that supports creating tenant management entities.

Constructor Summary

Constructors

Constructor and Description
TenantManagementRequestBuilder(ITenantManagement tenantManagement)

Method Summary

Modifier and Type	Method and Description
ITenant	getTenant(java.lang.String id) Get tenant by unique id.
ITenantGroup	getTenantGroup(java.lang.String token) Get a tenant group by token.
ITenantManagement	getTenantManagement()
boolean	hasTenant(java.lang.String id) Indicates whether a tenant exists for the given id.
boolean	hasTenantGroup(java.lang.String id) Indicates whether a tenant group exists for the given id.
TenantCreateRequest.Builder	newTenant(java.lang.String id, java.lang.String name, java.lang.String authenticationToken, java.lang.String logoUrl) Create builder for new tenant request.
TenantCreateRequest.Builder	newTenant(java.lang.String id, java.lang.String name, java.lang.String authenticationToken, java.lang.String logoUrl, java.lang.String tenantTemplateId) Create builder for new tenant request.
TenantGroupCreateRequest.Builder	newTenantGroup(java.lang.String name) Create builder for new tenant group request.
TenantGroupCreateRequest.Builder	newTenantGroup(java.lang.String token, java.lang.String name) Create builder for new tenant group request.
TenantGroupElementCreateRequest.Builder	newTenantGroupElement(java.lang.String tenantId) Create builder for a tenant group element.
java.util.List<ITenantGroupElement>	persist(ITenantGroup group, java.util.List<TenantGroupElementCreateRequest.Builder> builders) Add elements to a tenant group.
ITenant	persist(TenantCreateRequest.Builder builder) Persist tenant contructed via builder.
ITenantGroup	persist(TenantGroupCreateRequest.Builder builder) Persist tenant group contructed via builder.
void	setTenantManagement(ITenantManagement tenantManagement)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TenantManagementRequestBuilder

public TenantManagementRequestBuilder(ITenantManagement tenantManagement)

Method Detail

newTenant

public TenantCreateRequest.Builder newTenant(java.lang.String id,
                                             java.lang.String name,
                                             java.lang.String authenticationToken,
                                             java.lang.String logoUrl)

Create builder for new tenant request. Assumes tenant uses the "empty" tenant template.

Parameters:

id -

name -

authenticationToken -

logoUrl -

Returns:

newTenant

public TenantCreateRequest.Builder newTenant(java.lang.String id,
                                             java.lang.String name,
                                             java.lang.String authenticationToken,
                                             java.lang.String logoUrl,
                                             java.lang.String tenantTemplateId)

Create builder for new tenant request. Allows tenant template to be specified.

Parameters:

id -

name -

authenticationToken -

logoUrl -

tenantTemplateId -

Returns:

persist

public ITenant persist(TenantCreateRequest.Builder builder)
                throws SiteWhereException

Persist tenant contructed via builder.

Parameters:

builder -

Returns:

Throws:

SiteWhereException

getTenant

public ITenant getTenant(java.lang.String id)
                  throws SiteWhereException

Get tenant by unique id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

hasTenant

public boolean hasTenant(java.lang.String id)
                  throws SiteWhereException

Indicates whether a tenant exists for the given id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

newTenantGroup

public TenantGroupCreateRequest.Builder newTenantGroup(java.lang.String name)

Create builder for new tenant group request. This version allows a token to be auto-generated.

Parameters:

name -

Returns:

newTenantGroup

public TenantGroupCreateRequest.Builder newTenantGroup(java.lang.String token,
                                                       java.lang.String name)

Create builder for new tenant group request.

Parameters:

token -

name -

Returns:

persist

public ITenantGroup persist(TenantGroupCreateRequest.Builder builder)
                     throws SiteWhereException

Persist tenant group contructed via builder.

Parameters:

builder -

Returns:

Throws:

SiteWhereException

getTenantGroup

public ITenantGroup getTenantGroup(java.lang.String token)
                            throws SiteWhereException

Get a tenant group by token.

Parameters:

token -

Returns:

Throws:

SiteWhereException

hasTenantGroup

public boolean hasTenantGroup(java.lang.String id)
                       throws SiteWhereException

Indicates whether a tenant group exists for the given id.

Parameters:

id -

Returns:

Throws:

SiteWhereException

newTenantGroupElement

public TenantGroupElementCreateRequest.Builder newTenantGroupElement(java.lang.String tenantId)

Create builder for a tenant group element.

Parameters:

tenantGroupId -

tenantId -

Returns:

persist

public java.util.List<ITenantGroupElement> persist(ITenantGroup group,
                                                   java.util.List<TenantGroupElementCreateRequest.Builder> builders)
                                            throws SiteWhereException

Add elements to a tenant group.

Parameters:

group -

builders -

Returns:

Throws:

SiteWhereException

getTenantManagement

public ITenantManagement getTenantManagement()

setTenantManagement

public void setTenantManagement(ITenantManagement tenantManagement)