com.sitewhere.spi.tenant

Interface ITenant

All Superinterfaces:

IMetadataProvider, IMetadataProviderEntity, ISiteWhereEntity

All Known Implementing Classes:

Tenant

public interface ITenant
extends IMetadataProviderEntity

Interface for information about a tenant.

Method Summary

Modifier and Type	Method and Description
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.

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

Method Detail

getId

java.lang.String getId()

Get unique tenant id.

Returns:

getName

java.lang.String getName()

Get tenant name.

Returns:

getAuthenticationToken

java.lang.String getAuthenticationToken()

Get token that devices pass to identify tenant.

Returns:

getLogoUrl

java.lang.String getLogoUrl()

Get URL for tenant logo.

Returns:

getAuthorizedUserIds

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

Get list of users authorized to access the tenant.

Returns:

getTenantTemplateId

java.lang.String getTenantTemplateId()

Get id of template used to create tenant.

Returns:

getEngineState

ITenantRuntimeState getEngineState()

Get runtime state of tenant engine.

Returns: