com.sitewhere.rest.model.tenant

Class Tenant

java.lang.Object

com.sitewhere.rest.model.common.MetadataProvider

com.sitewhere.rest.model.common.MetadataProviderEntity

com.sitewhere.rest.model.tenant.Tenant

All Implemented Interfaces:

IMetadataProvider, IMetadataProviderEntity, ISiteWhereEntity, ITenant, java.io.Serializable

public class Tenant
extends MetadataProviderEntity
implements ITenant, java.io.Serializable

Default implementation of ITenant interface used for REST services.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Tenant()

Method Summary

Modifier and Type	Method and Description
static Tenant	copy(ITenant input) Copy contents from the SPI class.
java.lang.String	getAuthenticationToken() Get token that devices pass to identify tenant.
java.util.List<java.lang.String>	getAuthorizedUserIds() Get list of users authorized to access the tenant.
ITenantRuntimeState	getEngineState() Get runtime state of tenant engine.
java.lang.String	getId() Get unique tenant id.
java.lang.String	getLogoUrl() Get URL for tenant logo.
java.lang.String	getName() Get tenant name.
java.lang.String	getTenantTemplateId() Get id of template used to create tenant.
void	setAuthenticationToken(java.lang.String authenticationToken)
void	setAuthorizedUserIds(java.util.List<java.lang.String> authorizedUserIds)
void	setEngineState(ITenantRuntimeState engineState)
void	setId(java.lang.String id)
void	setLogoUrl(java.lang.String logoUrl)
void	setName(java.lang.String name)
void	setTenantTemplateId(java.lang.String tenantTemplateId)

Methods inherited from class com.sitewhere.rest.model.common.MetadataProviderEntity

copy, getCreatedBy, getCreatedDate, getUpdatedBy, getUpdatedDate, isDeleted, setCreatedBy, setCreatedDate, setDeleted, setUpdatedBy, setUpdatedDate

Methods inherited from class com.sitewhere.rest.model.common.MetadataProvider

addOrReplaceMetadata, clearMetadata, copy, copy, getMetadata, getMetadata, removeMetadata, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sitewhere.spi.common.IMetadataProvider

addOrReplaceMetadata, clearMetadata, getMetadata, getMetadata, removeMetadata

Methods inherited from interface com.sitewhere.spi.common.ISiteWhereEntity

getCreatedBy, getCreatedDate, getUpdatedBy, getUpdatedDate, isDeleted

Constructor Detail

Tenant

public Tenant()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ITenant

Get unique tenant id.

Specified by:

getId in interface ITenant

Returns:

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

Description copied from interface: ITenant

Get tenant name.

Specified by:

getName in interface ITenant

Returns:

setName

public void setName(java.lang.String name)

getAuthenticationToken

public java.lang.String getAuthenticationToken()

Description copied from interface: ITenant

Get token that devices pass to identify tenant.

Specified by:

getAuthenticationToken in interface ITenant

Returns:

setAuthenticationToken

public void setAuthenticationToken(java.lang.String authenticationToken)

getLogoUrl

public java.lang.String getLogoUrl()

Description copied from interface: ITenant

Get URL for tenant logo.

Specified by:

getLogoUrl in interface ITenant

Returns:

setLogoUrl

public void setLogoUrl(java.lang.String logoUrl)

getAuthorizedUserIds

public java.util.List<java.lang.String> getAuthorizedUserIds()

Description copied from interface: ITenant

Get list of users authorized to access the tenant.

Specified by:

getAuthorizedUserIds in interface ITenant

Returns:

setAuthorizedUserIds

public void setAuthorizedUserIds(java.util.List<java.lang.String> authorizedUserIds)

getTenantTemplateId

public java.lang.String getTenantTemplateId()

Description copied from interface: ITenant

Get id of template used to create tenant.

Specified by:

getTenantTemplateId in interface ITenant

Returns:

setTenantTemplateId

public void setTenantTemplateId(java.lang.String tenantTemplateId)

getEngineState

public ITenantRuntimeState getEngineState()

Description copied from interface: ITenant

Get runtime state of tenant engine.

Specified by:

getEngineState in interface ITenant

Returns:

setEngineState

public void setEngineState(ITenantRuntimeState engineState)

copy

public static Tenant copy(ITenant input)
                   throws SiteWhereException

Copy contents from the SPI class.

Parameters:

input -

Returns:

Throws:

SiteWhereException