Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W Z 

A

AccountStatus - Enum in com.sitewhere.spi.user
Enumeration of possible account status values.
addAlert(String, IDeviceAlert) - Method in interface com.sitewhere.spi.device.IAssignmentStateManager
Add new alert state for an assignment.
addDeviceAlert(String, IDeviceAlertCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add alert for a given device assignment.
addDeviceCommandInvocation(String, IDeviceCommand, IDeviceCommandInvocationCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add a device command invocation event for the given assignment.
addDeviceCommandResponse(String, IDeviceCommandResponseCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Adds a new device command response event.
addDeviceEvent(IDeviceEvent) - Method in class com.sitewhere.rest.model.SiteWhereContext
Helper function for add an arbitrary device event.
addDeviceEventBatch(String, IDeviceEventBatch) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add a batch of events for the given assignment.
addDeviceGroupElements(String, List<IDeviceGroupElementCreateRequest>, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Add elements to a device group.
addDeviceLocation(String, IDeviceLocationCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add location for a given device assignment.
addDeviceMeasurements(String, IDeviceMeasurementsCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add measurements for a given device assignment.
addDeviceStateChange(String, IDeviceStateChangeCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Adds a new device state change event.
addDeviceStreamData(String, IDeviceStreamDataCreateRequest) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Add a chunk of stream data for a given device assignment.
addGrantedAuthorities(String, List<String>) - Method in interface com.sitewhere.spi.user.IUserManagement
Add user authorities.
addListener(ICacheListener<V>) - Method in interface com.sitewhere.spi.cache.ICache
Add a listener for changes to the cache.
addLocation(String, IDeviceLocation) - Method in interface com.sitewhere.spi.device.IAssignmentStateManager
Add new location state for an assignment.
addMeasurements(String, IDeviceMeasurements) - Method in interface com.sitewhere.spi.device.IAssignmentStateManager
Add new measurements state for an assignment.
addOrReplaceMeasurement(String, Double) - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
addOrReplaceMeasurement(String, Double) - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
addOrReplaceMeasurement(String, Double) - Method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
addOrReplaceMeasurement(String, Double) - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
addOrReplaceMeasurement(String, Double) - Method in interface com.sitewhere.spi.device.event.IMeasurementsProvider
Add or replace measurement data.
addOrReplaceMetadata(String, String) - Method in class com.sitewhere.rest.model.common.MetadataProvider
 
addOrReplaceMetadata(String, String) - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
addOrReplaceMetadata(String, String) - Method in interface com.sitewhere.spi.common.IMetadataProvider
Add or replace a metadata field.
addSlot(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceElementSchemaBuilder
 
addSlot(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceUnitBuilder
 
addStateChange(String, IDeviceStateChange) - Method in interface com.sitewhere.spi.device.IAssignmentStateManager
Add new state change for an assignment.
addStep(ILifecycleStep) - Method in interface com.sitewhere.spi.server.lifecycle.ICompositeLifecycleStep
Add a step to the list.
addTenantGroupElements(String, List<ITenantGroupElementCreateRequest>) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Add elements to a tenant group.
addUnit(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceElementSchemaBuilder
 
addUnit(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceUnitBuilder
 
ADMIN_CONSOLE - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role for access to administrative console
ADMINISTER_TENANT_SELF - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role to administer all system tenants
ADMINISTER_TENANTS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role to administer all system tenants
ADMINISTER_USER_SELF - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role to administer own user account
ADMINISTER_USERS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role to administer all system users
AlertLevel - Enum in com.sitewhere.spi.device.event
Indicates severity of alert.
AlertSource - Enum in com.sitewhere.spi.device.event
Indicates source that generated an alert.
ALL - Static variable in class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
Search criteria for getting all records
ALL - Static variable in class com.sitewhere.rest.model.search.SearchCriteria
Search criteria for getting all records
allAssetsInModule(String) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
appliesTo(ICompositeDeviceEventDecoder.IDeviceContext<T>) - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IDecoderChoice
Indicates if this choice applies for the given context.
asGroup() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest.Builder
 
Asset - Class in com.sitewhere.rest.model.asset
Base model class for an asset.
Asset() - Constructor for class com.sitewhere.rest.model.asset.Asset
 
asset - Variable in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
Associated asset
AssetCategory - Class in com.sitewhere.rest.model.asset
REST model implementation of IAssetCategory.
AssetCategory() - Constructor for class com.sitewhere.rest.model.asset.AssetCategory
 
AssetCategoryCreateRequest - Class in com.sitewhere.rest.model.asset.request
REST model implementation of IAssetCategoryCreateRequest.
AssetCategoryCreateRequest() - Constructor for class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
AssetCategoryCreateRequest.Builder - Class in com.sitewhere.rest.model.asset.request
 
AssetCreateRequest - Class in com.sitewhere.rest.model.asset.request
REST model implementation of IAssetCreateRequest.
AssetCreateRequest() - Constructor for class com.sitewhere.rest.model.asset.request.AssetCreateRequest
 
AssetManagementRequestBuilder - Class in com.sitewhere.rest.model.asset.request.scripting
Builder that supports creating asset management entities.
AssetManagementRequestBuilder(IAssetManagement, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
AssetModule - Class in com.sitewhere.rest.model.asset
Model object used to show asset module information externally.
AssetModule() - Constructor for class com.sitewhere.rest.model.asset.AssetModule
 
AssetModule(String, String, AssetType) - Constructor for class com.sitewhere.rest.model.asset.AssetModule
 
ASSETS_FOLDER - Static variable in interface com.sitewhere.spi.configuration.IDefaultResourcePaths
Folder containing tenant asset resources
AssetSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain assets.
AssetSearchResults() - Constructor for class com.sitewhere.rest.model.search.AssetSearchResults
 
AssetSearchResults(List<Asset>) - Constructor for class com.sitewhere.rest.model.search.AssetSearchResults
 
AssetType - Enum in com.sitewhere.spi.asset
Indicates the general type of an asset.
ASSIGNMENT_TOKEN - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.CommandInvocation
Token of assignment to target
AssignmentScope(IDeviceManagement, IDeviceEventManagement, String) - Constructor for class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
AssignmentSearchCriteria - Class in com.sitewhere.rest.model.search.device
Default implementation of IAssignmentSearchCriteria.
AssignmentSearchCriteria(int, int) - Constructor for class com.sitewhere.rest.model.search.device.AssignmentSearchCriteria
 
AssignmentsForAssetSearchCriteria - Class in com.sitewhere.rest.model.search.device
Criteria used to search for assignments associated with a given asset type.
AssignmentsForAssetSearchCriteria(int, int) - Constructor for class com.sitewhere.rest.model.search.device.AssignmentsForAssetSearchCriteria
 
asSystemAlert() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
AUTH_ADMIN_CONSOLE - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to access administrative console
AUTH_ADMINISTER_SCHEDULES - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to administer all system schedules
AUTH_ADMINISTER_TENANT_SELF - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to administer own tenant
AUTH_ADMINISTER_TENANTS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to administer all system tenants
AUTH_ADMINISTER_USER_SELF - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to administer own user account
AUTH_ADMINISTER_USERS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to administer all system users
AUTH_REST - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to access REST services
AUTH_SCHEDULE_COMMANDS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to schedule commands
AUTH_VIEW_SERVER_INFO - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Authority to view server information
authenticate(String, String) - Method in interface com.sitewhere.spi.user.IUserManagement
Authenticate the given username and password.

B

BatchCommandForCriteriaRequest - Class in com.sitewhere.rest.model.device.request
Model implementation of IBatchCommandForCriteriaRequest.
BatchCommandForCriteriaRequest() - Constructor for class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
BatchCommandInvocationRequest - Class in com.sitewhere.rest.model.device.request
Parameters for a batch operation that executes a command for all devices in the batch.
BatchCommandInvocationRequest() - Constructor for class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
BatchElement - Class in com.sitewhere.rest.model.device.batch
Model object for a batch element.
BatchElement() - Constructor for class com.sitewhere.rest.model.device.batch.BatchElement
 
BatchElementSearchCriteria - Class in com.sitewhere.rest.model.search.device
Search criteria specific to searching a list of batch operation elements.
BatchElementSearchCriteria(int, int) - Constructor for class com.sitewhere.rest.model.search.device.BatchElementSearchCriteria
 
BatchElementUpdateRequest - Class in com.sitewhere.rest.model.device.request
Holds information needed to update a batch operation element.
BatchElementUpdateRequest() - Constructor for class com.sitewhere.rest.model.device.request.BatchElementUpdateRequest
 
BatchOperation - Class in com.sitewhere.rest.model.device.batch
Model object for a batch operation.
BatchOperation() - Constructor for class com.sitewhere.rest.model.device.batch.BatchOperation
 
BatchOperationCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds information needed to create a batch operation.
BatchOperationCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
BatchOperationStatus - Enum in com.sitewhere.spi.device.batch
Status indicators for batch operation processing.
BatchOperationUpdateRequest - Class in com.sitewhere.rest.model.device.request
Holds information needed to update a batch operation.
BatchOperationUpdateRequest() - Constructor for class com.sitewhere.rest.model.device.request.BatchOperationUpdateRequest
 
build() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceElementSchemaBuilder
 
build() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceUnitBuilder
 
build() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.resource.request.ResourceCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupElementCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest.Builder
 
build() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest.Builder
 
build(IDeviceEvent, IDevice, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.event.processor.routing.IRouteBuilder
Build a route based on information about a device event.
Builder(IAssetCategory) - Constructor for class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
Builder(IHardwareAsset) - Constructor for class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest.Builder
 
Builder(ILocationAsset) - Constructor for class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest.Builder
 
Builder(IPersonAsset) - Constructor for class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest.Builder
 
Builder() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest.Builder
 
Builder(double, double) - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest.Builder
 
Builder() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest.Builder
 
Builder(IDeviceAssignment) - Constructor for class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest.Builder
 
Builder(IDeviceCommand) - Constructor for class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest.Builder
 
Builder(IDevice) - Constructor for class com.sitewhere.rest.model.device.request.DeviceCreateRequest.Builder
 
Builder(String, String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceCreateRequest.Builder
 
Builder(IDeviceGroup) - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest.Builder
 
Builder(IDeviceGroupElement) - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest.Builder
 
Builder(IDeviceSpecification) - Constructor for class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
Builder(String, String, String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
Builder(ISite) - Constructor for class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.device.request.ZoneCreateRequest.Builder
 
Builder(IResource) - Constructor for class com.sitewhere.rest.model.resource.request.ResourceCreateRequest.Builder
 
Builder(ISchedule) - Constructor for class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest.Builder
 
Builder(String, String, String, String, String) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantCreateRequest.Builder
 
Builder(ITenant) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest.Builder
 
Builder(String, String) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest.Builder
 
Builder(ITenantGroup) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantGroupElementCreateRequest.Builder
 
Builder(ITenantGroupElement) - Constructor for class com.sitewhere.rest.model.tenant.request.TenantGroupElementCreateRequest.Builder
 
Builder(String) - Constructor for class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest.Builder
 
Builder(IGrantedAuthority) - Constructor for class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest.Builder
 
Builder(String, String, String, String) - Constructor for class com.sitewhere.rest.model.user.request.UserCreateRequest.Builder
 
Builder(IUser) - Constructor for class com.sitewhere.rest.model.user.request.UserCreateRequest.Builder
 

C

CacheInformation - Class in com.sitewhere.rest.model.cache
Used for marshaling information about a cache.
CacheInformation() - Constructor for class com.sitewhere.rest.model.cache.CacheInformation
 
CacheSummary - Class in com.sitewhere.rest.model.cache
Holds information about one or more caches.
CacheSummary() - Constructor for class com.sitewhere.rest.model.cache.CacheSummary
 
CacheType - Enum in com.sitewhere.spi.cache
 
calculateRoutes(IDeviceEvent, IDevice, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.event.processor.multicast.IDeviceEventMulticaster
Calculates the list of routes to which an event should be sent.
canPause() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Indicates to framework whether component can be paused.
ChartEntry<T> - Class in com.sitewhere.rest.model.device.charting
Chart entry implementation.
ChartEntry() - Constructor for class com.sitewhere.rest.model.device.charting.ChartEntry
 
ChartSeries<T> - Class in com.sitewhere.rest.model.device.charting
Chart series implementation.
ChartSeries() - Constructor for class com.sitewhere.rest.model.device.charting.ChartSeries
 
clear() - Method in interface com.sitewhere.spi.cache.ICache
Clear all elements from cache.
clearMeasurements() - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
clearMeasurements() - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
clearMeasurements() - Method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
clearMeasurements() - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
clearMeasurements() - Method in interface com.sitewhere.spi.device.event.IMeasurementsProvider
Clear all measurements.
clearMetadata() - Method in class com.sitewhere.rest.model.common.MetadataProvider
 
clearMetadata() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
clearMetadata() - Method in interface com.sitewhere.spi.common.IMetadataProvider
Clear existing metadata.
com.sitewhere.rest - package com.sitewhere.rest
 
com.sitewhere.rest.model - package com.sitewhere.rest.model
 
com.sitewhere.rest.model.asset - package com.sitewhere.rest.model.asset
 
com.sitewhere.rest.model.asset.request - package com.sitewhere.rest.model.asset.request
 
com.sitewhere.rest.model.asset.request.scripting - package com.sitewhere.rest.model.asset.request.scripting
 
com.sitewhere.rest.model.cache - package com.sitewhere.rest.model.cache
 
com.sitewhere.rest.model.command - package com.sitewhere.rest.model.command
 
com.sitewhere.rest.model.common - package com.sitewhere.rest.model.common
 
com.sitewhere.rest.model.datatype - package com.sitewhere.rest.model.datatype
 
com.sitewhere.rest.model.device - package com.sitewhere.rest.model.device
 
com.sitewhere.rest.model.device.asset - package com.sitewhere.rest.model.device.asset
 
com.sitewhere.rest.model.device.batch - package com.sitewhere.rest.model.device.batch
 
com.sitewhere.rest.model.device.charting - package com.sitewhere.rest.model.device.charting
 
com.sitewhere.rest.model.device.command - package com.sitewhere.rest.model.device.command
 
com.sitewhere.rest.model.device.communication - package com.sitewhere.rest.model.device.communication
 
com.sitewhere.rest.model.device.element - package com.sitewhere.rest.model.device.element
 
com.sitewhere.rest.model.device.event - package com.sitewhere.rest.model.device.event
 
com.sitewhere.rest.model.device.event.request - package com.sitewhere.rest.model.device.event.request
 
com.sitewhere.rest.model.device.event.request.scripting - package com.sitewhere.rest.model.device.event.request.scripting
 
com.sitewhere.rest.model.device.event.scripting - package com.sitewhere.rest.model.device.event.scripting
 
com.sitewhere.rest.model.device.event.view - package com.sitewhere.rest.model.device.event.view
 
com.sitewhere.rest.model.device.group - package com.sitewhere.rest.model.device.group
 
com.sitewhere.rest.model.device.request - package com.sitewhere.rest.model.device.request
 
com.sitewhere.rest.model.device.request.scripting - package com.sitewhere.rest.model.device.request.scripting
 
com.sitewhere.rest.model.device.streaming - package com.sitewhere.rest.model.device.streaming
 
com.sitewhere.rest.model.device.support - package com.sitewhere.rest.model.device.support
 
com.sitewhere.rest.model.monitoring - package com.sitewhere.rest.model.monitoring
 
com.sitewhere.rest.model.resource - package com.sitewhere.rest.model.resource
 
com.sitewhere.rest.model.resource.request - package com.sitewhere.rest.model.resource.request
 
com.sitewhere.rest.model.scheduling - package com.sitewhere.rest.model.scheduling
 
com.sitewhere.rest.model.scheduling.request - package com.sitewhere.rest.model.scheduling.request
 
com.sitewhere.rest.model.scheduling.request.scripting - package com.sitewhere.rest.model.scheduling.request.scripting
 
com.sitewhere.rest.model.search - package com.sitewhere.rest.model.search
 
com.sitewhere.rest.model.search.device - package com.sitewhere.rest.model.search.device
 
com.sitewhere.rest.model.search.external - package com.sitewhere.rest.model.search.external
 
com.sitewhere.rest.model.search.tenant - package com.sitewhere.rest.model.search.tenant
 
com.sitewhere.rest.model.search.user - package com.sitewhere.rest.model.search.user
 
com.sitewhere.rest.model.system - package com.sitewhere.rest.model.system
 
com.sitewhere.rest.model.tenant - package com.sitewhere.rest.model.tenant
 
com.sitewhere.rest.model.tenant.request - package com.sitewhere.rest.model.tenant.request
 
com.sitewhere.rest.model.tenant.request.scripting - package com.sitewhere.rest.model.tenant.request.scripting
 
com.sitewhere.rest.model.user - package com.sitewhere.rest.model.user
 
com.sitewhere.rest.model.user.request - package com.sitewhere.rest.model.user.request
 
com.sitewhere.spi - package com.sitewhere.spi
 
com.sitewhere.spi.asset - package com.sitewhere.spi.asset
 
com.sitewhere.spi.asset.request - package com.sitewhere.spi.asset.request
 
com.sitewhere.spi.cache - package com.sitewhere.spi.cache
 
com.sitewhere.spi.command - package com.sitewhere.spi.command
 
com.sitewhere.spi.common - package com.sitewhere.spi.common
 
com.sitewhere.spi.configuration - package com.sitewhere.spi.configuration
 
com.sitewhere.spi.device - package com.sitewhere.spi.device
 
com.sitewhere.spi.device.asset - package com.sitewhere.spi.device.asset
 
com.sitewhere.spi.device.batch - package com.sitewhere.spi.device.batch
 
com.sitewhere.spi.device.charting - package com.sitewhere.spi.device.charting
 
com.sitewhere.spi.device.command - package com.sitewhere.spi.device.command
 
com.sitewhere.spi.device.communication - package com.sitewhere.spi.device.communication
 
com.sitewhere.spi.device.communication.socket - package com.sitewhere.spi.device.communication.socket
 
com.sitewhere.spi.device.element - package com.sitewhere.spi.device.element
 
com.sitewhere.spi.device.event - package com.sitewhere.spi.device.event
 
com.sitewhere.spi.device.event.processor - package com.sitewhere.spi.device.event.processor
 
com.sitewhere.spi.device.event.processor.multicast - package com.sitewhere.spi.device.event.processor.multicast
 
com.sitewhere.spi.device.event.processor.routing - package com.sitewhere.spi.device.event.processor.routing
 
com.sitewhere.spi.device.event.request - package com.sitewhere.spi.device.event.request
 
com.sitewhere.spi.device.event.state - package com.sitewhere.spi.device.event.state
 
com.sitewhere.spi.device.group - package com.sitewhere.spi.device.group
 
com.sitewhere.spi.device.presence - package com.sitewhere.spi.device.presence
 
com.sitewhere.spi.device.request - package com.sitewhere.spi.device.request
 
com.sitewhere.spi.device.streaming - package com.sitewhere.spi.device.streaming
 
com.sitewhere.spi.device.symbology - package com.sitewhere.spi.device.symbology
 
com.sitewhere.spi.device.util - package com.sitewhere.spi.device.util
 
com.sitewhere.spi.error - package com.sitewhere.spi.error
 
com.sitewhere.spi.geospatial - package com.sitewhere.spi.geospatial
 
com.sitewhere.spi.monitoring - package com.sitewhere.spi.monitoring
 
com.sitewhere.spi.resource - package com.sitewhere.spi.resource
 
com.sitewhere.spi.resource.request - package com.sitewhere.spi.resource.request
 
com.sitewhere.spi.scheduling - package com.sitewhere.spi.scheduling
 
com.sitewhere.spi.scheduling.request - package com.sitewhere.spi.scheduling.request
 
com.sitewhere.spi.search - package com.sitewhere.spi.search
 
com.sitewhere.spi.search.device - package com.sitewhere.spi.search.device
 
com.sitewhere.spi.search.external - package com.sitewhere.spi.search.external
 
com.sitewhere.spi.search.user - package com.sitewhere.spi.search.user
 
com.sitewhere.spi.server - package com.sitewhere.spi.server
 
com.sitewhere.spi.server.hazelcast - package com.sitewhere.spi.server.hazelcast
 
com.sitewhere.spi.server.lifecycle - package com.sitewhere.spi.server.lifecycle
 
com.sitewhere.spi.system - package com.sitewhere.spi.system
 
com.sitewhere.spi.tenant - package com.sitewhere.spi.tenant
 
com.sitewhere.spi.tenant.request - package com.sitewhere.spi.tenant.request
 
com.sitewhere.spi.user - package com.sitewhere.spi.user
 
com.sitewhere.spi.user.request - package com.sitewhere.spi.user.request
 
COMMAND_TOKEN - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.CommandInvocation
Token of command to invoke
CommandInitiator - Enum in com.sitewhere.spi.device.event
Enumerates actors that can initiate commands.
CommandParameter - Class in com.sitewhere.rest.model.device.command
Model object for a command parameter.
CommandParameter() - Constructor for class com.sitewhere.rest.model.device.command.CommandParameter
 
CommandParameter(String, ParameterType, boolean) - Constructor for class com.sitewhere.rest.model.device.command.CommandParameter
 
CommandResponse - Class in com.sitewhere.rest.model.command
Model object for a command response.
CommandResponse() - Constructor for class com.sitewhere.rest.model.command.CommandResponse
 
CommandResponse(CommandResult, String) - Constructor for class com.sitewhere.rest.model.command.CommandResponse
 
CommandResult - Enum in com.sitewhere.spi.command
Indicates the result status for a command.
CommandStatus - Enum in com.sitewhere.spi.device.event
Status indicator for a command.
CommandTarget - Enum in com.sitewhere.spi.device.event
Enumerates actors that can act as command targets.
Comparators - Class in com.sitewhere.spi.common
Commonly used comparators for SiteWhere entities.
Comparators() - Constructor for class com.sitewhere.spi.common.Comparators
 
Comparators.InverseCreatedDateComparator - Class in com.sitewhere.spi.common
Lists objects with newest created first.
compare(ISiteWhereEntity, ISiteWhereEntity) - Method in class com.sitewhere.spi.common.Comparators.InverseCreatedDateComparator
 
compareTo(IAsset) - Method in class com.sitewhere.rest.model.asset.Asset
 
compareTo(IDeviceEvent) - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
compareTo(IChartEntry<T>) - Method in class com.sitewhere.rest.model.device.charting.ChartEntry
 
compareTo(IDeviceEvent) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
coord(double, double) - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest.Builder
 
copy(IAssetCategory) - Static method in class com.sitewhere.rest.model.asset.AssetCategory
Create a copy of an SPI object.
copy(IAssetModule<?>) - Static method in class com.sitewhere.rest.model.asset.AssetModule
Create a copy of an SPI object.
copy(ICommandResponse) - Static method in class com.sitewhere.rest.model.command.CommandResponse
Copy an SPI object to one that can marshaled.
copy(ILocation) - Static method in class com.sitewhere.rest.model.common.Location
Create a copy of an SPI object.
copy(IMetadataProvider, MetadataProvider) - Static method in class com.sitewhere.rest.model.common.MetadataProvider
Copy contents of one metadata provider to another.
copy(Map<String, String>, MetadataProvider) - Static method in class com.sitewhere.rest.model.common.MetadataProvider
Copy values from a map into a MetadataProvider.
copy(IMetadataProviderEntity, MetadataProviderEntity) - Static method in class com.sitewhere.rest.model.common.MetadataProviderEntity
Copy fields from source to target.
copy(IBatchOperation) - Static method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
copy(IDeviceCommand) - Static method in class com.sitewhere.rest.model.device.command.DeviceCommand
Create a copy of an SPI object.
copy(IDeviceAssignmentState) - Static method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
copy(IDeviceElementMapping) - Static method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
copy(IDeviceAlert) - Static method in class com.sitewhere.rest.model.device.event.DeviceAlert
Create a copy of an SPI object.
copy(IDeviceCommandResponse) - Static method in class com.sitewhere.rest.model.device.event.DeviceCommandResponse
Create a copy of an SPI object.
copy(IDeviceEvent, DeviceEvent) - Static method in class com.sitewhere.rest.model.device.event.DeviceEvent
Create a copy of an SPI object.
copy(IDeviceLocation) - Static method in class com.sitewhere.rest.model.device.event.DeviceLocation
Create a copy of an SPI object.
copy(IDeviceMeasurement) - Static method in class com.sitewhere.rest.model.device.event.DeviceMeasurement
Create a copy of an SPI object.
copy(IDeviceMeasurements) - Static method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
Create a copy of an SPI object.
copy(IDeviceStateChange) - Static method in class com.sitewhere.rest.model.device.event.DeviceStateChange
Create a copy of an SPI object.
copy(IMeasurementsProvider, MeasurementsProvider) - Static method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
Copy contents of one measurements provider to another.
copy(IDeviceGroup) - Static method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
copy(ISite) - Static method in class com.sitewhere.rest.model.device.Site
Create a copy of an SPI object.
copy(ISiteMapData) - Static method in class com.sitewhere.rest.model.device.SiteMapData
Copy map information from an SPI object.
copy(IDeviceStream) - Static method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
copy(IZone) - Static method in class com.sitewhere.rest.model.device.Zone
Create a copy of an SPI object.
copy(SearchResults<IDeviceMeasurements>) - Static method in class com.sitewhere.rest.model.search.DeviceMeasurementsSearchResults
Copy the API version of results so they can be marshaled.
copy(ISearchProvider) - Static method in class com.sitewhere.rest.model.search.external.SearchProvider
Create copy of an ISearchProvider for marshaling.
copy(ITenant) - Static method in class com.sitewhere.rest.model.tenant.Tenant
Copy contents from the SPI class.
copy(ITenantGroup) - Static method in class com.sitewhere.rest.model.tenant.TenantGroup
 
copy(IGrantedAuthority) - Static method in class com.sitewhere.rest.model.user.GrantedAuthority
Copy contents from the SPI class.
copy(IUser) - Static method in class com.sitewhere.rest.model.user.User
Copy contents from the SPI class.
copyTemplateResourcesToTenant(String, String, ResourceCreateMode) - Method in interface com.sitewhere.spi.resource.IResourceManager
Copies resources from a tenant template into a tenant with the given id.
createAssetCategory(IAssetCategoryCreateRequest) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Create a new asset category.
createBatchCommandInvocation(IBatchCommandInvocationRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Creates an ISearchResults that will invoke a command on multiple devices.
createBatchOperation(IBatchOperationCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Creates an IBatchOperation to perform an operation on multiple devices.
createDevice(IDeviceCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new device.
createDeviceAssignment(IDeviceAssignmentCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new device assignment.
createDeviceCommand(IDeviceSpecification, IDeviceCommandCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Creates a device command associated with an existing device specification.
createDeviceElementMapping(String, IDeviceElementMapping) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create an IDeviceElementMapping for a nested device.
createDeviceGroup(IDeviceGroupCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new device group.
createDeviceSpecification(IDeviceSpecificationCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new device specification.
createDeviceStream(String, IDeviceStreamCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new IDeviceStream associated with an assignment.
createExecution(IDeviceCommand, IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.communication.ICommandExecutionBuilder
Create an execution from a command and invocation details.
createGlobalResources(List<IResourceCreateRequest>, ResourceCreateMode) - Method in interface com.sitewhere.spi.resource.IResourceManager
Create one or more global resources.
createGrantedAuthority(IGrantedAuthorityCreateRequest) - Method in interface com.sitewhere.spi.user.IUserManagement
Create a new granted authority.
createHardwareAsset(String, IHardwareAssetCreateRequest) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Create a new IHardwareAsset.
createLocation(String, double, double, double, boolean) - Method in interface com.sitewhere.spi.device.IDeviceActions
Create a new location for the given assignment.
createLocationAsset(String, ILocationAssetCreateRequest) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Create a new ILocationAsset.
createPersonAsset(String, IPersonAssetCreateRequest) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Create a new IPersonAsset.
createSchedule(IScheduleCreateRequest) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Create a new schedule.
createScheduledJob(IScheduledJobCreateRequest) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Create a new scheduled job.
createSite(ISiteCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a site based on the given input.
createTenant(ITenantCreateRequest) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Create a new tenant.
createTenantGroup(ITenantGroupCreateRequest) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Create a new tenant group.
createTenantResources(String, List<IResourceCreateRequest>, ResourceCreateMode) - Method in interface com.sitewhere.spi.resource.IResourceManager
Create one or more tenant resources.
createUser(IUserCreateRequest, boolean) - Method in interface com.sitewhere.spi.user.IUserManagement
Create a new user based on the given input.
createZone(ISite, IZoneCreateRequest) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Create a new zone.
critical() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
CRON_EXPRESSION - Static variable in interface com.sitewhere.spi.scheduling.TriggerConstants.CronTrigger
Cron expression that defines trigger schedule

D

data() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
 
DATA_HARDWARE_ID - Static variable in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
Data map identifier for hardware id
DATA_SITE_TOKEN - Static variable in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
Data map identifier for 'reply to' address
DATA_SPECIFICATION_TOKEN - Static variable in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
Data map identifier for specification token
DateRangeSearchCriteria - Class in com.sitewhere.rest.model.search
Extends search criteria with ability to specify a date range.
DateRangeSearchCriteria(int, int, Date, Date) - Constructor for class com.sitewhere.rest.model.search.DateRangeSearchCriteria
 
decode(T, Map<String, Object>) - Method in interface com.sitewhere.spi.device.communication.IDeviceEventDecoder
Decodes a payload into one or more IDecodedDeviceRequest objects.
DecodedDeviceRequest<T> - Class in com.sitewhere.rest.model.device.communication
Default implementation of IDecodedDeviceRequest.
DecodedDeviceRequest() - Constructor for class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
DecodedDeviceRequest(String, String, T) - Constructor for class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
deleteAsset(String, String) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Delete the asset with the given id in the given category.
deleteAssetCategory(String) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Delete an asset category and all contained assets.
deleteBatchOperation(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Deletes a batch operation and its elements.
deleteDevice(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete an existing device.
deleteDeviceAssignment(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete a device assignment.
deleteDeviceCommand(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete an existing device command.
deleteDeviceElementMapping(String, String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete an exising IDeviceElementMapping from a device.
deleteDeviceGroup(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete a device group.
deleteDeviceSpecification(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete an existing device specification.
deleteGlobalResource(String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Delete global resource at the given path.
deleteGrantedAuthority(String) - Method in interface com.sitewhere.spi.user.IUserManagement
Delete a granted authority.
deleteSchedule(String, boolean) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Delete an existing schedule.
deleteScheduledJob(String, boolean) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Delete an existing scheduled job.
deleteSite(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete a site based on unique site token.
deleteTenant(String, boolean) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Delete an existing tenant.
deleteTenantGroup(String, boolean) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Delete an existing tenant group based on its unique id.
deleteTenantResource(String, String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Delete tenant resource at the given path.
deleteUser(String, boolean) - Method in interface com.sitewhere.spi.user.IUserManagement
Delete the user with the given username.
deleteZone(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Delete a zone given its unique token.
deliver(IDeviceNestingContext, IDeviceAssignment, IDeviceCommandExecution, T, P) - Method in interface com.sitewhere.spi.device.communication.ICommandDeliveryProvider
Deliver the given encoded invocation.
deliverCommand(IDeviceCommandExecution, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Deliver a command.
deliverCommand(IDeviceCommunication, IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.communication.ICommandProcessingStrategy
Send a command using the given communication subsystem implementation.
deliverCommand(IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Deliver a command invocation.
deliverSystemCommand(IDeviceNestingContext, IDeviceAssignment, T, P) - Method in interface com.sitewhere.spi.device.communication.ICommandDeliveryProvider
Delivers a system command.
deliverSystemCommand(ISystemCommand, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Deliver a system command.
deliverSystemCommand(IDeviceCommunication, String, ISystemCommand) - Method in interface com.sitewhere.spi.device.communication.ICommandProcessingStrategy
Delivers a system command using the given communication subsystem implementation.
deliverSystemCommand(String, ISystemCommand) - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Deliver a system command.
Device - Class in com.sitewhere.rest.model.device
Model object for device information.
Device() - Constructor for class com.sitewhere.rest.model.device.Device
 
DeviceAlert - Class in com.sitewhere.rest.model.device.event
Model object for an alert event from a remote device.
DeviceAlert() - Constructor for class com.sitewhere.rest.model.device.event.DeviceAlert
 
DeviceAlertCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new DeviceAlert via REST APIs.
DeviceAlertCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest
 
DeviceAlertCreateRequest.Builder - Class in com.sitewhere.rest.model.device.event.request
 
DeviceAlertSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device alerts.
DeviceAlertSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceAlertSearchResults
 
DeviceAlertSearchResults(List<DeviceAlert>) - Constructor for class com.sitewhere.rest.model.search.DeviceAlertSearchResults
 
DeviceAlertWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a DeviceAlert so that information about the asset associated with its assignment is available.
DeviceAlertWithAsset(IDeviceAlert, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceAlertWithAsset
 
DeviceAssignment - Class in com.sitewhere.rest.model.device
Device assignment value object used for marshaling.
DeviceAssignment() - Constructor for class com.sitewhere.rest.model.device.DeviceAssignment
 
DeviceAssignmentCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a device assignment.
DeviceAssignmentCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
DeviceAssignmentCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceAssignmentHistoryEntry - Class in com.sitewhere.rest.model.device.support
Entry used in InterpolatedAssignmentHistory.
DeviceAssignmentHistoryEntry() - Constructor for class com.sitewhere.rest.model.device.support.DeviceAssignmentHistoryEntry
 
DeviceAssignmentSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device assignments.
DeviceAssignmentSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceAssignmentSearchResults
 
DeviceAssignmentSearchResults(List<DeviceAssignment>) - Constructor for class com.sitewhere.rest.model.search.DeviceAssignmentSearchResults
 
DeviceAssignmentState - Class in com.sitewhere.rest.model.device
Model object for device assignment state.
DeviceAssignmentState() - Constructor for class com.sitewhere.rest.model.device.DeviceAssignmentState
 
DeviceAssignmentStatus - Enum in com.sitewhere.spi.device
Used as a clear indicator of the current status of a device assignment.
DeviceAssignmentType - Enum in com.sitewhere.spi.device
Indicates what type of asset is linked via the assignment.
DeviceCommand - Class in com.sitewhere.rest.model.device.command
Model object for a command that can be invoked on a device.
DeviceCommand() - Constructor for class com.sitewhere.rest.model.device.command.DeviceCommand
 
DeviceCommandCreateRequest - Class in com.sitewhere.rest.model.device.request
Arguments needed to create a new device command.
DeviceCommandCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
DeviceCommandCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceCommandExecution - Class in com.sitewhere.rest.model.device.command
Default implementation of the IDeviceCommandExecution interface.
DeviceCommandExecution() - Constructor for class com.sitewhere.rest.model.device.command.DeviceCommandExecution
 
DeviceCommandInvocation - Class in com.sitewhere.rest.model.device.event
Implementation of IDeviceCommandInvocation.
DeviceCommandInvocation() - Constructor for class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
DeviceCommandInvocationCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new DeviceCommandInvocation via REST APIs.
DeviceCommandInvocationCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
DeviceCommandInvocationCreateRequest.Builder - Class in com.sitewhere.rest.model.device.event.request
 
DeviceCommandInvocationSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device command invocations.
DeviceCommandInvocationSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceCommandInvocationSearchResults
 
DeviceCommandInvocationSearchResults(List<DeviceCommandInvocation>) - Constructor for class com.sitewhere.rest.model.search.DeviceCommandInvocationSearchResults
 
DeviceCommandInvocationSummary - Class in com.sitewhere.rest.model.device.event.view
Merges information from an IDeviceCommand and an IDeviceCommandInvocation in a form that is easy to use in a user interface.
DeviceCommandInvocationSummary() - Constructor for class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
DeviceCommandInvocationSummary.Parameter - Class in com.sitewhere.rest.model.device.event.view
Holder for parameter information
DeviceCommandInvocationSummary.Response - Class in com.sitewhere.rest.model.device.event.view
Information about a response to the invocation
DeviceCommandInvocationWithAsset - Class in com.sitewhere.rest.model.device.asset
 
DeviceCommandInvocationWithAsset(IDeviceCommandInvocation, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
DeviceCommandNamespace - Class in com.sitewhere.rest.model.device.command
Used to group device commands that use the same namespace.
DeviceCommandNamespace() - Constructor for class com.sitewhere.rest.model.device.command.DeviceCommandNamespace
 
DeviceCommandResponse - Class in com.sitewhere.rest.model.device.event
Implementation of IDeviceCommandResponse.
DeviceCommandResponse() - Constructor for class com.sitewhere.rest.model.device.event.DeviceCommandResponse
 
DeviceCommandResponseCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new IDeviceCommandResponse via REST APIs.
DeviceCommandResponseCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceCommandResponseCreateRequest
 
DeviceCommandResponseWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a DeviceCommandResponse so that information about the asset associated with its assignment is available.
DeviceCommandResponseWithAsset(IDeviceCommandResponse, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceCommandResponseWithAsset
 
DeviceCommandSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device commands.
DeviceCommandSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceCommandSearchResults
 
DeviceCommandSearchResults(List<DeviceCommand>) - Constructor for class com.sitewhere.rest.model.search.DeviceCommandSearchResults
 
DeviceContainerPolicy - Enum in com.sitewhere.spi.device
Used to differentiate between device container policies.
DeviceCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a new device.
DeviceCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
DeviceCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceElement - Class in com.sitewhere.rest.model.device.element
Default implementation of IDeviceElement.
DeviceElement() - Constructor for class com.sitewhere.rest.model.device.element.DeviceElement
 
DeviceElementMapping - Class in com.sitewhere.rest.model.device
Model implementation of IDeviceElementMapping.
DeviceElementMapping() - Constructor for class com.sitewhere.rest.model.device.DeviceElementMapping
 
DeviceElementSchema - Class in com.sitewhere.rest.model.device.element
Default implementation of IDeviceElementSchema.
DeviceElementSchema() - Constructor for class com.sitewhere.rest.model.device.element.DeviceElementSchema
 
DeviceElementSchemaBuilder() - Constructor for class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceElementSchemaBuilder
 
DeviceEvent - Class in com.sitewhere.rest.model.device.event
Model object for an event originating from a remote device.
DeviceEvent(DeviceEventType) - Constructor for class com.sitewhere.rest.model.device.event.DeviceEvent
 
DeviceEventBatch - Class in com.sitewhere.rest.model.device.event
A batch of new events to create for a given device.
DeviceEventBatch() - Constructor for class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
DeviceEventBatchResponse - Class in com.sitewhere.rest.model.device.event
Response from device event batch create operation.
DeviceEventBatchResponse() - Constructor for class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
DeviceEventCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Holds common fields for creating DeviceEvent subclasses.
DeviceEventCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest
 
DeviceEventCreateRequest.Builder<T extends DeviceEventCreateRequest> - Class in com.sitewhere.rest.model.device.event.request
Uses builder pattern to create device event requests.
DeviceEventOriginator - Class in com.sitewhere.rest.model.device.event
Default implementation of IDeviceEventOriginator.
DeviceEventOriginator(IDeviceEvent) - Constructor for class com.sitewhere.rest.model.device.event.DeviceEventOriginator
 
DeviceEventRequestBuilder - Class in com.sitewhere.rest.model.device.event.request.scripting
Exposes builders for creating SiteWhere events.
DeviceEventRequestBuilder(IDeviceManagement, IDeviceEventManagement) - Constructor for class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
DeviceEventRequestBuilder.AssignmentScope - Class in com.sitewhere.rest.model.device.event.request.scripting
 
DeviceEventSupport - Class in com.sitewhere.rest.model.device.event.scripting
Provides support for common operations on device events in scripting operations.
DeviceEventSupport(IDeviceEvent) - Constructor for class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
 
DeviceEventType - Enum in com.sitewhere.spi.device.event
Indicates event type.
DeviceEventWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a device event and provides extra information the associated asset from its assignment.
DeviceEventWithAsset(IDeviceEvent, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
DeviceGroup - Class in com.sitewhere.rest.model.device.group
Model object for a device group.
DeviceGroup() - Constructor for class com.sitewhere.rest.model.device.group.DeviceGroup
 
DeviceGroupCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a new device group.
DeviceGroupCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
DeviceGroupCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceGroupElement - Class in com.sitewhere.rest.model.device.group
Model object for an element in an IDeviceGroup.
DeviceGroupElement() - Constructor for class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
DeviceGroupElementCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a new device group element.
DeviceGroupElementCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest
 
DeviceGroupElementCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceGroupElementSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device group elements.
DeviceGroupElementSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceGroupElementSearchResults
 
DeviceGroupElementSearchResults(List<DeviceGroupElement>) - Constructor for class com.sitewhere.rest.model.search.DeviceGroupElementSearchResults
 
DeviceGroupSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device groups.
DeviceGroupSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceGroupSearchResults
 
DeviceGroupSearchResults(List<DeviceGroup>) - Constructor for class com.sitewhere.rest.model.search.DeviceGroupSearchResults
 
DeviceLocation - Class in com.sitewhere.rest.model.device.event
Represents the location of a device at a moment in time.
DeviceLocation() - Constructor for class com.sitewhere.rest.model.device.event.DeviceLocation
 
DeviceLocationCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new DeviceLocation via REST APIs.
DeviceLocationCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest
 
DeviceLocationCreateRequest.Builder - Class in com.sitewhere.rest.model.device.event.request
 
DeviceLocationSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device locations.
DeviceLocationSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceLocationSearchResults
 
DeviceLocationSearchResults(List<DeviceLocation>) - Constructor for class com.sitewhere.rest.model.search.DeviceLocationSearchResults
 
DeviceLocationWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a DeviceLocation so that information about the asset associated with its assignment is available.
DeviceLocationWithAsset(IDeviceLocation, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceLocationWithAsset
 
DeviceManagementRequestBuilder - Class in com.sitewhere.rest.model.device.request.scripting
Builder that supports creating device management entities.
DeviceManagementRequestBuilder(IDeviceManagement) - Constructor for class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
DeviceMappingAckCommand - Class in com.sitewhere.rest.model.device.command
Default implementation of IDeviceMappingAckCommand.
DeviceMappingAckCommand() - Constructor for class com.sitewhere.rest.model.device.command.DeviceMappingAckCommand
 
DeviceMappingCreateRequest - Class in com.sitewhere.rest.model.device.request
Request for mapping a device to a path on a composite device.
DeviceMappingCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceMappingCreateRequest
 
DeviceMappingResult - Enum in com.sitewhere.spi.device.command
Enumeration of results for device mapping operations.
DeviceMeasurement - Class in com.sitewhere.rest.model.device.event
Model object for a single measurement.
DeviceMeasurement() - Constructor for class com.sitewhere.rest.model.device.event.DeviceMeasurement
 
DeviceMeasurements - Class in com.sitewhere.rest.model.device.event
Implementation of device measurements.
DeviceMeasurements() - Constructor for class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
DeviceMeasurementsCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new DeviceMeasurements via REST APIs.
DeviceMeasurementsCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
DeviceMeasurementsCreateRequest.Builder - Class in com.sitewhere.rest.model.device.event.request
 
DeviceMeasurementsSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device measurements.
DeviceMeasurementsSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceMeasurementsSearchResults
 
DeviceMeasurementsSearchResults(List<DeviceMeasurements>) - Constructor for class com.sitewhere.rest.model.search.DeviceMeasurementsSearchResults
 
DeviceMeasurementsWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a DeviceMeasurements so that information about the asset associated with its assignment is available.
DeviceMeasurementsWithAsset(IDeviceMeasurements, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
DeviceRegistrationRequest - Class in com.sitewhere.rest.model.device.event.request
Default model implementation of IDeviceRegistrationRequest.
DeviceRegistrationRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
 
DeviceRequest - Class in com.sitewhere.rest.model.device.communication
Used for marshaling device request data to JSON.
DeviceRequest() - Constructor for class com.sitewhere.rest.model.device.communication.DeviceRequest
 
DeviceRequest.Type - Enum in com.sitewhere.rest.model.device.communication
Enumerates types of expected requests.
DeviceSearchCriteria - Class in com.sitewhere.rest.model.search.device
Adds options specific to device searches.
DeviceSearchCriteria(int, int, Date, Date) - Constructor for class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
DeviceSearchCriteria(String, String, boolean, int, int, Date, Date) - Constructor for class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
DeviceSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain devices.
DeviceSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceSearchResults
 
DeviceSearchResults(List<Device>) - Constructor for class com.sitewhere.rest.model.search.DeviceSearchResults
 
DeviceSlot - Class in com.sitewhere.rest.model.device.element
Default implementation of IDeviceSlot.
DeviceSlot() - Constructor for class com.sitewhere.rest.model.device.element.DeviceSlot
 
DeviceSpecification - Class in com.sitewhere.rest.model.device
Model object for device specification information.
DeviceSpecification() - Constructor for class com.sitewhere.rest.model.device.DeviceSpecification
 
DeviceSpecificationCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a new device specification.
DeviceSpecificationCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
DeviceSpecificationCreateRequest.Builder - Class in com.sitewhere.rest.model.device.request
 
DeviceSpecificationCreateRequest.DeviceElementSchemaBuilder - Class in com.sitewhere.rest.model.device.request
 
DeviceSpecificationCreateRequest.DeviceUnitBuilder - Class in com.sitewhere.rest.model.device.request
 
DeviceSpecificationSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device specifications.
DeviceSpecificationSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceSpecificationSearchResults
 
DeviceSpecificationSearchResults(List<DeviceSpecification>) - Constructor for class com.sitewhere.rest.model.search.DeviceSpecificationSearchResults
 
DeviceSpecificationUtils - Class in com.sitewhere.spi.device.util
Helper methods for common operations on IDeviceSpecification objects.
DeviceSpecificationUtils() - Constructor for class com.sitewhere.spi.device.util.DeviceSpecificationUtils
 
DeviceStateChange - Class in com.sitewhere.rest.model.device.event
Model object for a state change reported by a remote device.
DeviceStateChange() - Constructor for class com.sitewhere.rest.model.device.event.DeviceStateChange
 
DeviceStateChangeCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Represents a change in state for a device.
DeviceStateChangeCreateRequest(StateChangeCategory, StateChangeType, String, String) - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
DeviceStateChangeWithAsset - Class in com.sitewhere.rest.model.device.asset
Wraps a IDeviceStateChange so that information about the asset associated with its assignment is available.
DeviceStateChangeWithAsset(IDeviceStateChange, IAssetModuleManager) - Constructor for class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
DeviceStatus - Enum in com.sitewhere.spi.device
Status indicator for device.
DeviceStream - Class in com.sitewhere.rest.model.device.streaming
Model object for a stream of binary data received from a device.
DeviceStream() - Constructor for class com.sitewhere.rest.model.device.streaming.DeviceStream
 
DeviceStreamAckCommand - Class in com.sitewhere.rest.model.device.command
Command sent to a device to indicate status of creating a device stream.
DeviceStreamAckCommand() - Constructor for class com.sitewhere.rest.model.device.command.DeviceStreamAckCommand
 
DeviceStreamCreateRequest - Class in com.sitewhere.rest.model.device.request
Holds fields needed to create a new device stream.
DeviceStreamCreateRequest() - Constructor for class com.sitewhere.rest.model.device.request.DeviceStreamCreateRequest
 
DeviceStreamData - Class in com.sitewhere.rest.model.device.event
Holds a single chunk of data from a binary stream.
DeviceStreamData() - Constructor for class com.sitewhere.rest.model.device.event.DeviceStreamData
 
DeviceStreamDataCreateRequest - Class in com.sitewhere.rest.model.device.event.request
Model object used to create a new DeviceStreamData via REST APIs.
DeviceStreamDataCreateRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.DeviceStreamDataCreateRequest
 
DeviceStreamDataSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device stream data.
DeviceStreamDataSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceStreamDataSearchResults
 
DeviceStreamDataSearchResults(List<DeviceStreamData>) - Constructor for class com.sitewhere.rest.model.search.DeviceStreamDataSearchResults
 
DeviceStreamSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain device streams.
DeviceStreamSearchResults() - Constructor for class com.sitewhere.rest.model.search.DeviceStreamSearchResults
 
DeviceStreamSearchResults(List<DeviceStream>) - Constructor for class com.sitewhere.rest.model.search.DeviceStreamSearchResults
 
DeviceStreamStatus - Enum in com.sitewhere.spi.device.command
Enumerates possible status values for IDeviceStreamAckCommand.
DeviceUnit - Class in com.sitewhere.rest.model.device.element
Default implementation of IDeviceUnit.
DeviceUnit() - Constructor for class com.sitewhere.rest.model.device.element.DeviceUnit
 
DeviceUnitBuilder(String, String) - Constructor for class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.DeviceUnitBuilder
 
DeviceUtils - Class in com.sitewhere.spi.device.util
Helper methods for common operations on IDevice objects.
DeviceUtils() - Constructor for class com.sitewhere.spi.device.util.DeviceUtils
 

E

ElementProcessingStatus - Enum in com.sitewhere.spi.device.batch
Indicates the processing status of a single IBatchElement.
EMPTY_TEMPLATE_NAME - Static variable in interface com.sitewhere.spi.configuration.IDefaultResourcePaths
Template that does not load any device data
encode(IDeviceCommandExecution, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.ICommandExecutionEncoder
Encodes a command execution.
encode(IDecodedDeviceRequest<?>) - Method in interface com.sitewhere.spi.device.communication.IDeviceEventEncoder
Encode an IDecodedDeviceRequest into another representation.
encodeSystemCommand(ISystemCommand, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.ICommandExecutionEncoder
Encodes a SiteWhere system command.
END_DATE - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.BatchCommandInvocation
Indicates if results should be narrowed by devices created on or before a date
endDeviceAssignment(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Ends a device assignment.
error() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
ErrorCode - Enum in com.sitewhere.spi.error
Enumerates various system error conditions and gives them unique codes.
ErrorLevel - Enum in com.sitewhere.spi.error
Indicates severity of an error.
EventDecodeException - Exception in com.sitewhere.spi.device.communication
Exception thrown when an event payload can not be decoded.
EventDecodeException() - Constructor for exception com.sitewhere.spi.device.communication.EventDecodeException
 
EventDecodeException(String, Throwable) - Constructor for exception com.sitewhere.spi.device.communication.EventDecodeException
 
EventDecodeException(String) - Constructor for exception com.sitewhere.spi.device.communication.EventDecodeException
 
EventDecodeException(Throwable) - Constructor for exception com.sitewhere.spi.device.communication.EventDecodeException
 
execute(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleStep
Execute the step.
executeQuery(String) - Method in interface com.sitewhere.spi.search.external.IDeviceEventSearchProvider
Executes an arbitrary event query against the search provider.
extractDeliveryParameters(IDeviceNestingContext, IDeviceAssignment, IDeviceCommandExecution) - Method in interface com.sitewhere.spi.device.communication.ICommandDeliveryParameterExtractor
Extract required delivery parameters from the given sources.
extractMetadata(T, Map<String, Object>) - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IMessageMetadataExtractor
Extract metadata about payload.

F

findComponentsOfType(LifecycleComponentType) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Find components (including this component and nested components) that are of the given type.
findMappingFor(IDevice, String) - Static method in class com.sitewhere.spi.device.util.DeviceUtils
Find IDeviceElementMapping for the given nested device hardware id.
forAssignment(String) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
forDeviceAssets() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
forHardwareAssets() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
forLocationAssets() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
forPersonAssets() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest.Builder
 
forSameAssignmentAs(DeviceEventSupport) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
forSameAssignmentAs(IDeviceEvent) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
fromCode(long) - Static method in enum com.sitewhere.spi.error.ErrorCode
Look up the enum based on error code.
fromDevice(IDevice) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
fromStatusCode(char) - Static method in enum com.sitewhere.spi.user.AccountStatus
Get AccountStatus from status code.
fromType(char) - Static method in enum com.sitewhere.spi.error.ErrorLevel
Get ErrorLevel from type indicator.

G

get(K) - Method in interface com.sitewhere.spi.cache.ICache
Get value based on a given key.
getActiveDate() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getActiveDate() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get the date/time at which the assignment was made active.
getAlerts() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
getAlerts() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatch
Get a list of device alert create requests.
getAsHtml() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getAsset() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getAsset(String, String) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Get the asset for the given id in the given category.
getAsset(String) - Method in interface com.sitewhere.spi.asset.IAssetModule
Get an asset by unique id.
getAssetById(String, String) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Finds an asset in a given module.
getAssetCategory(String) - Method in interface com.sitewhere.spi.asset.IAssetManagement
Get an asset category by id.
getAssetCategoryCache() - Method in interface com.sitewhere.spi.asset.IAssetManagementCacheProvider
Gets cache mapping asset category ids to IAssetCategory objects.
getAssetCategoryId() - Method in class com.sitewhere.rest.model.asset.Asset
 
getAssetCategoryId() - Method in interface com.sitewhere.spi.asset.IAsset
Get id of parent asset category.
getAssetId() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getAssetId() - Method in class com.sitewhere.rest.model.device.Device
 
getAssetId() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssetId() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getAssetId() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getAssetId() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getAssetId() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getAssetId() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get id of asset if associated.
getAssetId() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get the asset identifier.
getAssetId() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Get unique id within asset module.
getAssetId() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get assigned asset id.
getAssetId() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get id for specification asset type.
getAssetImageUrl() - Method in class com.sitewhere.rest.model.device.Device
 
getAssetImageUrl() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssetImageUrl() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getAssetManagement() - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getAssetModuleId() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getAssetModuleId() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get id of asset module.
getAssetModuleId() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get id of referenced asset module.
getAssetModuleId() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Get asset module id.
getAssetModuleId() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get asset module id.
getAssetModuleId() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get id for asset module.
getAssetModuleManager() - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
getAssetName() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getAssetName() - Method in class com.sitewhere.rest.model.device.Device
 
getAssetName() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssetName() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getAssetName() - Method in interface com.sitewhere.spi.device.asset.IDeviceEventWithAsset
Get human-readable asset name.
getAssetType() - Method in class com.sitewhere.rest.model.asset.AssetCategory
 
getAssetType() - Method in class com.sitewhere.rest.model.asset.AssetModule
 
getAssetType() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
getAssetType() - Method in interface com.sitewhere.spi.asset.IAssetCategory
Indicates the type of assets provided.
getAssetType() - Method in interface com.sitewhere.spi.asset.request.IAssetCategoryCreateRequest
Get type of assets held in category.
getAssignment() - Method in class com.sitewhere.rest.model.device.Device
 
getAssignmentToken() - Method in class com.sitewhere.rest.model.device.Device
 
getAssignmentToken() - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
getAssignmentToken() - Method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
getAssignmentToken() - Method in interface com.sitewhere.spi.device.IDevice
Get the current device assignment token if assigned.
getAssignmentToken() - Method in interface com.sitewhere.spi.device.streaming.IDeviceStream
Get assignment stream belongs to.
getAssignmentType() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getAssignmentType() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssignmentType() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getAssignmentType() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getAssignmentType() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get assignment type.
getAssignmentType() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get the referenced asset type.
getAssignmentType() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get assignment type.
getAssociatedHardware() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssociatedLocation() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAssociatedPerson() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getAuthenticationToken() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getAuthenticationToken() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getAuthenticationToken() - Method in interface com.sitewhere.spi.tenant.ITenant
Get token that devices pass to identify tenant.
getAuthenticationToken() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get token that devices pass to identify tenant.
getAuthorities() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getAuthorities() - Method in class com.sitewhere.rest.model.user.User
 
getAuthorities() - Method in interface com.sitewhere.spi.user.IUser
Get the list of granted authorities.
getAuthorities() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the list of granted authorities.
getAuthority() - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
getAuthority() - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
getAuthority(String) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Get an existing authority by name.
getAuthority() - Method in interface com.sitewhere.spi.user.IGrantedAuthority
Get the authority name.
getAuthority() - Method in interface com.sitewhere.spi.user.request.IGrantedAuthorityCreateRequest
Get the authority name.
getAuthorizedUserIds() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getAuthorizedUserIds() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getAuthorizedUserIds() - Method in interface com.sitewhere.spi.tenant.ITenant
Get list of users authorized to access the tenant.
getAuthorizedUserIds() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get list of users authorized to access the tenant.
getAutoAssignSiteToken() - Method in interface com.sitewhere.spi.device.communication.IRegistrationManager
Gets the token used for automatic site assignment.
getBatchOperation(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get an IBatchOperation by unique token.
getBatchOperationManager() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the configured batch operation manager.
getBatchOperationToken() - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
getBatchOperationToken() - Method in interface com.sitewhere.spi.device.batch.IBatchElement
Get token for parent IBatchOperation.
getBorderColor() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getBorderColor() - Method in class com.sitewhere.rest.model.device.Zone
 
getBorderColor() - Method in interface com.sitewhere.spi.device.IZone
Get the border color.
getBorderColor() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get border color for UI.
getBuildTimestamp() - Method in class com.sitewhere.rest.model.system.Version
 
getBuildTimestamp() - Method in interface com.sitewhere.spi.system.IVersion
Gets the build timestamp.
getByCode(char) - Static method in enum com.sitewhere.spi.device.batch.BatchOperationStatus
 
getByCode(char) - Static method in enum com.sitewhere.spi.device.batch.ElementProcessingStatus
 
getCaches() - Method in class com.sitewhere.rest.model.cache.CacheSummary
 
getCacheType() - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
getCategory() - Method in class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
getCategory() - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
getCategory() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
getCategory() - Method in interface com.sitewhere.spi.device.event.IDeviceStateChange
Get category of state change.
getCategory() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStateChangeCreateRequest
Get category of state change.
getCode() - Method in enum com.sitewhere.spi.device.batch.BatchOperationStatus
 
getCode() - Method in enum com.sitewhere.spi.device.batch.ElementProcessingStatus
 
getCode() - Method in enum com.sitewhere.spi.error.ErrorCode
 
getCode() - Method in exception com.sitewhere.spi.error.ResourceExistsException
 
getCode() - Method in exception com.sitewhere.spi.SiteWhereSystemException
Get the error code.
getCommand() - Method in class com.sitewhere.rest.model.device.command.DeviceCommandExecution
 
getCommand() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getCommand() - Method in interface com.sitewhere.spi.device.command.IDeviceCommandExecution
Get the command being executed.
getCommandDeliveryParameterExtractor() - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Get the configured command delivery parameter extractor.
getCommandDeliveryProvider() - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Gets the configured command delivery provider.
getCommandDestinations() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the list of command destinations that can deliver commands to devices.
getCommandExecutionEncoder() - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Gets the configured command execution encoder.
getCommandProcessingStrategy() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the command processing strategy.
getCommands() - Method in class com.sitewhere.rest.model.device.command.DeviceCommandNamespace
 
getCommands() - Method in interface com.sitewhere.spi.device.command.IDeviceCommandNamespace
List of commands in namespace.
getCommandTargetResolver() - Method in interface com.sitewhere.spi.device.communication.ICommandProcessingStrategy
Get the ICommandTargetResolver implementation.
getCommandToken() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getCommandToken() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getCommandToken() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getCommandToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getCommandToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
getCommandToken() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get the unique token of the command to be executed.
getCommandToken() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get unique token for command to invoke.
getCommandToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
Get token for command to be executed.
getCommandToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Get token for command to be executed.
getComments() - Method in class com.sitewhere.rest.model.device.Device
 
getComments() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getComments() - Method in interface com.sitewhere.spi.device.IDevice
Get device comments.
getComments() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get comments associated with device.
getComponent() - Method in exception com.sitewhere.spi.ServerStartupException
 
getComponentHierarchyState() - Method in interface com.sitewhere.spi.server.ITenantRuntimeState
Get state of tenant engine component hierarchy.
getComponentId() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get the unique component id.
getComponentName() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get human-readable name shown for component.
getComponentType() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get component type.
getCompositeDeviceHardwareId() - Method in class com.sitewhere.rest.model.device.request.DeviceMappingCreateRequest
 
getCompositeDeviceHardwareId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceMappingCreateRequest
Get hardware id of composite device that will add device mapping.
getContainerPolicy() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getContainerPolicy() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getContainerPolicy() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Indicates whether this device contains other devices.
getContainerPolicy() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get container policy.
getContainment() - Method in interface com.sitewhere.spi.geospatial.IZoneRelationship
Get containment indicator.
getContent() - Method in class com.sitewhere.rest.model.resource.request.ResourceCreateRequest
 
getContent() - Method in class com.sitewhere.rest.model.resource.Resource
 
getContent() - Method in interface com.sitewhere.spi.resource.IResource
Get resource content.
getContent() - Method in interface com.sitewhere.spi.resource.request.IResourceCreateRequest
Get resource content.
getContentType() - Method in class com.sitewhere.rest.model.device.request.DeviceStreamCreateRequest
 
getContentType() - Method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
getContentType() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamCreateRequest
Get content type of stream data.
getContentType() - Method in interface com.sitewhere.spi.device.streaming.IDeviceStream
Get content type of stream data.
getContext() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getCoordinates() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getCoordinates() - Method in class com.sitewhere.rest.model.device.Zone
 
getCoordinates() - Method in interface com.sitewhere.spi.device.IZone
Get list of coordinates that defines the zone.
getCoordinates() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get zone coordinates.
getCreatedAlerts() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
getCreatedAlerts() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatchResponse
List of alerts that were created.
getCreatedBy() - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
getCreatedBy() - Method in interface com.sitewhere.spi.common.ISiteWhereEntity
Get username that created entity.
getCreatedDate() - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
getCreatedDate() - Method in interface com.sitewhere.spi.common.ISiteWhereEntity
Get date when entity was created.
getCreatedDate() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get date the component was created.
getCreatedLocations() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
getCreatedLocations() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatchResponse
List of locations that were created.
getCreatedMeasurements() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
getCreatedMeasurements() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatchResponse
List of measurements that were created.
getCreatedResources() - Method in class com.sitewhere.rest.model.resource.MultiResourceCreateResponse
 
getCreatedResources() - Method in interface com.sitewhere.spi.resource.IMultiResourceCreateResponse
Get list of created resources.
getCurrentDeviceAssignment(IDevice) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Gets the current assignment for a device.
getCurrentOperation() - Method in class com.sitewhere.rest.model.monitoring.ProgressMessage
 
getCurrentOperation() - Method in interface com.sitewhere.spi.monitoring.IProgressMessage
Get index of current operation.
getData() - Method in class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
getData() - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
getData() - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
getData() - Method in class com.sitewhere.rest.model.device.event.DeviceStreamData
 
getData() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
getData() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStreamDataCreateRequest
 
getData() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
 
getData() - Method in interface com.sitewhere.spi.device.command.ISendDeviceStreamDataCommand
Get data.
getData() - Method in interface com.sitewhere.spi.device.event.IDeviceStateChange
Get data associated with the state change.
getData() - Method in interface com.sitewhere.spi.device.event.IDeviceStreamData
Get chunk data.
getData() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStateChangeCreateRequest
Get data associated with the state change.
getData() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamDataCreateRequest
Get chunk data.
getDate() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Response
 
getDecoderChoices() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder
Get list of potential decoder choices.
getDefaultSymbolGenerator() - Method in interface com.sitewhere.spi.device.symbology.ISymbolGeneratorManager
Get the default symbol generator.
getDescription() - Method in class com.sitewhere.rest.model.asset.HardwareAsset
 
getDescription() - Method in class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest
 
getDescription() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getDescription() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Response
 
getDescription() - Method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
getDescription() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getDescription() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
getDescription() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getDescription() - Method in class com.sitewhere.rest.model.device.Site
 
getDescription() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest
 
getDescription() - Method in class com.sitewhere.rest.model.tenant.TenantGroup
 
getDescription() - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
getDescription() - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
getDescription() - Method in interface com.sitewhere.spi.asset.IHardwareAsset
Get the asset description.
getDescription() - Method in interface com.sitewhere.spi.asset.request.IHardwareAssetCreateRequest
Get the asset description.
getDescription() - Method in enum com.sitewhere.spi.device.batch.OperationType
 
getDescription() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Get a description of the command.
getDescription() - Method in interface com.sitewhere.spi.device.group.IDeviceGroup
Get the group description.
getDescription() - Method in interface com.sitewhere.spi.device.ISite
Get the description.
getDescription() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Get command description.
getDescription() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupCreateRequest
Get the group description.
getDescription() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Get site description.
getDescription() - Method in exception com.sitewhere.spi.ServerStartupException
 
getDescription() - Method in interface com.sitewhere.spi.tenant.ITenantGroup
Get description for group.
getDescription() - Method in interface com.sitewhere.spi.tenant.request.ITenantGroupCreateRequest
Get description for group.
getDescription() - Method in interface com.sitewhere.spi.user.IGrantedAuthority
Get the description.
getDescription() - Method in interface com.sitewhere.spi.user.request.IGrantedAuthorityCreateRequest
Get the description.
getDescription() - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
getDestinationId() - Method in interface com.sitewhere.spi.device.communication.ICommandDestination
Get unique identifier for destination.
getDevice() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getDevice() - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
getDevice() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getDevice() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IDeviceContext
Get referenced device.
getDeviceAlerts() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceAlerts() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get the IDeviceAlert events.
getDeviceAssigmentSymbol(IDeviceAssignment, IEntityUriProvider) - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get symbol for a device assignment.
getDeviceAssignment() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceAssignment() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get current assignment for device associated with the request.
getDeviceAssignmentByToken(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a device assignment by unique token.
getDeviceAssignmentCache() - Method in interface com.sitewhere.spi.device.IDeviceManagementCacheProvider
Get cache mapping assignment tokens to IDeviceAssignment objects.
getDeviceAssignmentHistory(String, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get the device assignment history for a given device.
getDeviceAssignmentIdentifier(IDeviceAssignment) - Method in interface com.sitewhere.spi.device.symbology.IEntityUriProvider
Get unique identifier for a device assignment.
getDeviceAssignmentsForAsset(String, String, IAssignmentsForAssetSearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a list of device assignments associated with a given asset.
getDeviceAssignmentsForSite(String, IAssignmentSearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a list of device assignments for a site.
getDeviceAssignmentsWithLastInteraction(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Finds all device assignments for a site with a last interaction date in the given date range.
getDeviceAssignmentToken() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getDeviceAssignmentToken() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getDeviceAssignmentToken() - Method in class com.sitewhere.rest.model.device.support.InterpolatedAssignmentHistory
 
getDeviceAssignmentToken() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get the device assignment the event pertains to.
getDeviceByHardwareId(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Gets a device by unique hardware id.
getDeviceCache() - Method in interface com.sitewhere.spi.device.IDeviceManagementCacheProvider
Gets cache mapping hardware ids to IDevice objects.
getDeviceCommandByToken(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a device command by unique token.
getDeviceCommandInvocations() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceCommandInvocations() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get the IDeviceCommandInvocation events.
getDeviceCommandResponses() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceCommandResponses() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get the IDeviceCommandResponse events.
getDeviceElementByPath(IDeviceSpecification, String) - Static method in class com.sitewhere.spi.device.util.DeviceSpecificationUtils
Get an IDeviceElement located at the given path.
getDeviceElementMappings() - Method in class com.sitewhere.rest.model.device.Device
 
getDeviceElementMappings() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getDeviceElementMappings() - Method in interface com.sitewhere.spi.device.IDevice
Gets mappings of IDeviceElementSchema paths to hardware ids for nested devices.
getDeviceElementMappings() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get the list of device element mappings.
getDeviceElementSchema() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getDeviceElementSchema() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getDeviceElementSchema() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Get schema that describes how nested devices are arranged.
getDeviceElementSchema() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get IDeviceElementSchema for locating nested devices.
getDeviceElementSchemaPath() - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
getDeviceElementSchemaPath() - Method in interface com.sitewhere.spi.device.IDeviceElementMapping
Get path in IDeviceElementSchema being mapped.
getDeviceEventById(String) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Get a device event by unique id.
getDeviceEventDecoder() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IDecoderChoice
Get decoder for this choice.
getDeviceForAssignment(IDeviceAssignment) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get the device associated with an assignment.
getDeviceGroup() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getDeviceGroup(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a device network by unique token.
getDeviceHardwareId() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getDeviceHardwareId() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getDeviceHardwareId() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get hardware id for assigned device.
getDeviceHardwareId() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get the unique device hardware id.
getDeviceIdentifier(IDevice) - Method in interface com.sitewhere.spi.device.symbology.IEntityUriProvider
Get unique identifier for a device.
getDeviceIndex() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupCursor
Get index of current device in list.
getDeviceLocations() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceLocations() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get the IDeviceLocation events.
getDeviceManagement() - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
getDeviceManagement() - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
getDeviceManagement() - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Get the device management implementation.
getDeviceMeasurements() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getDeviceMeasurements() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get the IDeviceMeasurements events.
getDevicePresenceManager() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the configured device presence manager.
getDeviceSlotByPath(IDeviceSpecification, String) - Static method in class com.sitewhere.spi.device.util.DeviceSpecificationUtils
Get an IDeviceSlot given relative path in IDeviceElementSchema.
getDeviceSlots() - Method in class com.sitewhere.rest.model.device.element.DeviceUnit
 
getDeviceSlots() - Method in interface com.sitewhere.spi.device.element.IDeviceUnit
Get list of slots associated with the unit.
getDeviceSpecification() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IDeviceContext
Get referenced device specification.
getDeviceSpecificationByToken(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a device specification by unique token.
getDeviceSpecificationCache() - Method in interface com.sitewhere.spi.device.IDeviceManagementCacheProvider
Gets cache mapping specification tokens for IDeviceSpecification objects.
getDeviceSpecificationIdentifier(IDeviceSpecification) - Method in interface com.sitewhere.spi.device.symbology.IEntityUriProvider
Get unique identifier for a device specification.
getDeviceSpecificationSymbol(IDeviceSpecification, IEntityUriProvider) - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get symbol for a device specification.
getDeviceStream(String, String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get an exsiting IDeviceStream for an assignment based on unique stream id.
getDeviceStreamData(String, String, long) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Get a single chunk of data from a device stream.
getDeviceStreamManager() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the configured device stream manager.
getDeviceSymbol(IDevice, IEntityUriProvider) - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get symbol for a device.
getDeviceUnits() - Method in class com.sitewhere.rest.model.device.element.DeviceUnit
 
getDeviceUnits() - Method in interface com.sitewhere.spi.device.element.IDeviceUnit
Get list of subordinate units associated with the unit.
getDisplayName() - Method in interface com.sitewhere.spi.device.communication.IInboundEventReceiver
Get name shown in user interfaces when referencing receiver.
getEdition() - Method in class com.sitewhere.rest.model.system.Version
 
getEdition() - Method in interface com.sitewhere.spi.system.IVersion
Get full edition name.
getEditionIdentifier() - Method in class com.sitewhere.rest.model.system.Version
 
getEditionIdentifier() - Method in interface com.sitewhere.spi.system.IVersion
Get the short identifier for edition.
getElementCount() - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
getElementCount() - Method in interface com.sitewhere.spi.cache.ICache
Get count of elements currently in cache.
getElementId() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getElementId() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest
 
getElementId() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupElement
Get element id (relative to element type).
getElementId() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupElementCreateRequest
Get the element id (relative to element type).
getElevation() - Method in class com.sitewhere.rest.model.asset.LocationAsset
 
getElevation() - Method in class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest
 
getElevation() - Method in class com.sitewhere.rest.model.common.Location
 
getElevation() - Method in class com.sitewhere.rest.model.device.asset.DeviceLocationWithAsset
 
getElevation() - Method in class com.sitewhere.rest.model.device.event.DeviceLocation
 
getElevation() - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest
 
getElevation() - Method in interface com.sitewhere.spi.asset.ILocationAsset
Get location elevation.
getElevation() - Method in interface com.sitewhere.spi.asset.request.ILocationAssetCreateRequest
Get location elevation.
getElevation() - Method in interface com.sitewhere.spi.common.ILocation
Get elevation measurement.
getElevation() - Method in interface com.sitewhere.spi.device.event.IDeviceLocation
Get elevation value.
getElevation() - Method in interface com.sitewhere.spi.device.event.request.IDeviceLocationCreateRequest
Get elevation.s
getEmailAddress() - Method in class com.sitewhere.rest.model.asset.PersonAsset
 
getEmailAddress() - Method in class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest
 
getEmailAddress() - Method in interface com.sitewhere.spi.asset.IPersonAsset
Get the email address.
getEmailAddress() - Method in interface com.sitewhere.spi.asset.request.IPersonAssetCreateRequest
Get the email address.
getEndDate() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getEndDate() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getEndDate() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getEndDate() - Method in class com.sitewhere.rest.model.search.DateRangeSearchCriteria
 
getEndDate() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
Get date range end.
getEndDate() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Get date schedule is no longer in effect.
getEndDate() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Get date schedule is no longer in effect.
getEndDate() - Method in interface com.sitewhere.spi.search.IDateRangeSearchCriteria
Get date range end.
getEngineState() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getEngineState() - Method in interface com.sitewhere.spi.tenant.ITenant
Get runtime state of tenant engine.
getEntries() - Method in class com.sitewhere.rest.model.device.charting.ChartSeries
 
getEntries() - Method in interface com.sitewhere.spi.device.charting.IChartSeries
Get data entries for the series.
getErrorMessage() - Method in class com.sitewhere.rest.model.device.command.RegistrationFailureCommand
 
getErrorMessage() - Method in interface com.sitewhere.spi.device.command.IRegistrationFailureCommand
Get error message.
getErrors() - Method in class com.sitewhere.rest.model.resource.MultiResourceCreateResponse
 
getErrors() - Method in interface com.sitewhere.spi.resource.IMultiResourceCreateResponse
Get list of errors creating resources.
getEventDate() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getEventDate() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getEventDate() - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest
 
getEventDate() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get the date the event occurred.
getEventDate() - Method in interface com.sitewhere.spi.device.event.request.IDeviceEventCreateRequest
Get the date on which the event occurred.
getEventId() - Method in class com.sitewhere.rest.model.device.event.DeviceEventOriginator
 
getEventId() - Method in interface com.sitewhere.spi.device.event.IDeviceEventOriginator
Gets event id of originator.
getEventManagement() - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
getEventSource() - Method in interface com.sitewhere.spi.device.communication.IInboundEventReceiver
Get the parent event source.
getEventType() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getEventType() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getEventType() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get event type indicator.
getFillColor() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getFillColor() - Method in class com.sitewhere.rest.model.device.Zone
 
getFillColor() - Method in interface com.sitewhere.spi.device.IZone
Get the fill color.
getFillColor() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get fill color for UI.
getFilters() - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Get the list of configured filters.
getFirstName() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getFirstName() - Method in class com.sitewhere.rest.model.user.User
 
getFirstName() - Method in interface com.sitewhere.spi.user.IUser
Get the common name.
getFirstName() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the common name.
getGateway() - Method in interface com.sitewhere.spi.device.IDeviceNestingContext
Get gateway device that should be contacted.
getGlobalResource(String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Get a global resource registered for the given path.
getGlobalResources() - Method in interface com.sitewhere.spi.resource.IResourceManager
Get list of all global resources.
getGrantedAuthorities(String) - Method in interface com.sitewhere.spi.user.IUserManagement
Get the granted authorities for a specific user.
getGrantedAuthorityByName(String) - Method in interface com.sitewhere.spi.user.IUserManagement
Get a granted authority by name.
getGroupsWithRole() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getGroupsWithRole() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
If set, only devices in groups with the given role will be sent the command.
getGroupToken() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getGroupToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getGroupToken() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupCursor
Get unique network token.
getGroupToken() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupElement
Get token for parent group.
getGroupToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
If set, only devices in the given group will be sent the command.
getHardwareId() - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.communication.DeviceRequest
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.Device
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
 
getHardwareId() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getHardwareId() - Method in interface com.sitewhere.spi.device.batch.IBatchElement
Get hardware id of device.
getHardwareId() - Method in interface com.sitewhere.spi.device.command.ISendDeviceStreamDataCommand
Hardware id of device to receive data.
getHardwareId() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IMessageMetadata
Get parsed hardware id.
getHardwareId() - Method in interface com.sitewhere.spi.device.communication.IDecodedDeviceRequest
Get hardware id the request pertains to.
getHardwareId() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatch
Unique device hardware id.
getHardwareId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceRegistrationRequest
Get hardware id to be registered.
getHardwareId() - Method in interface com.sitewhere.spi.device.IDevice
Get the unique hardware id of the device.
getHardwareId() - Method in interface com.sitewhere.spi.device.IDeviceElementMapping
Get hardware id of IDevice being mapped.
getHardwareId() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get the unique device hardware id.
getHardwareIds() - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
getHardwareIds() - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
getHardwareIds() - Method in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Get the list of targeted device hardware ids.
getHardwareIds() - Method in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Get list of hardware ids for devices to be operated on.
getHashedPassword() - Method in class com.sitewhere.rest.model.user.User
 
getHashedPassword() - Method in interface com.sitewhere.spi.user.IUser
Get the password.
getHitCount() - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
getHitCount() - Method in interface com.sitewhere.spi.cache.ICache
Get the number of cache hits.
getHitRatio() - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
getHostname() - Method in interface com.sitewhere.spi.common.IInternetConnected
Get hostname to connect to.
getHttpResponseCode() - Method in exception com.sitewhere.spi.SiteWhereSystemException
Get HTTP response code.
getId() - Method in class com.sitewhere.rest.model.asset.Asset
 
getId() - Method in class com.sitewhere.rest.model.asset.AssetCategory
 
getId() - Method in class com.sitewhere.rest.model.asset.AssetModule
 
getId() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
getId() - Method in class com.sitewhere.rest.model.asset.request.AssetCreateRequest
 
getId() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getId() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getId() - Method in class com.sitewhere.rest.model.search.external.SearchProvider
 
getId() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getId() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getId() - Method in interface com.sitewhere.spi.asset.IAsset
Unique asset id.
getId() - Method in interface com.sitewhere.spi.asset.IAssetCategory
Get the unique module identifier.
getId() - Method in interface com.sitewhere.spi.asset.request.IAssetCategoryCreateRequest
Get category id.
getId() - Method in interface com.sitewhere.spi.asset.request.IAssetCreateRequest
Unique asset id.
getId() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get a string that uniquely identifies the event.
getId() - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get unique generator id.
getId() - Method in interface com.sitewhere.spi.search.external.ISearchProvider
Get unique id of search provider.
getId() - Method in interface com.sitewhere.spi.server.ITenantEngineComponent
Get component id.
getId() - Method in interface com.sitewhere.spi.tenant.ITenant
Get unique tenant id.
getId() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get unique tenant id.
getImageUrl() - Method in class com.sitewhere.rest.model.asset.Asset
 
getImageUrl() - Method in class com.sitewhere.rest.model.asset.request.AssetCreateRequest
 
getImageUrl() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getImageUrl() - Method in class com.sitewhere.rest.model.device.Site
 
getImageUrl() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest
 
getImageUrl() - Method in class com.sitewhere.rest.model.tenant.TenantGroup
 
getImageUrl() - Method in interface com.sitewhere.spi.asset.IAsset
Get URL for asset image.
getImageUrl() - Method in interface com.sitewhere.spi.asset.request.IAssetCreateRequest
Get URL for asset image.
getImageUrl() - Method in interface com.sitewhere.spi.device.ISite
Get the image URL.
getImageUrl() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Get URL for site logo image.
getImageUrl() - Method in interface com.sitewhere.spi.tenant.ITenantGroup
Get URL for image associated with group.
getImageUrl() - Method in interface com.sitewhere.spi.tenant.request.ITenantGroupCreateRequest
Get URL for image associated with group.
getInboundEventProcessorChain() - Method in interface com.sitewhere.spi.device.event.IEventProcessing
Get chain of processor that will act on inbound data.
getInboundEventSources() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the list of sources that bring device event data into the system.
getInboundProcessingStrategy() - Method in interface com.sitewhere.spi.device.event.IEventProcessing
Get the strategy for moving decoded events into the inbound chain.
getIndex() - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
getIndex() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getIndex() - Method in interface com.sitewhere.spi.device.batch.IBatchElement
Get index that corresponds to this entry.
getIndex() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupElement
Get index that corresponds to this entry.
getInitiator() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getInitiator() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getInitiator() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getInitiator() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get actor type that initiated the command.
getInitiator() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get command initiator type.
getInitiatorId() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getInitiatorId() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getInitiatorId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getInitiatorId() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get unique id of command initiated.
getInitiatorId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get unique id of command inititator.
getInvocation() - Method in class com.sitewhere.rest.model.device.command.DeviceCommandExecution
 
getInvocation() - Method in interface com.sitewhere.spi.device.command.IDeviceCommandExecution
Get the invocation details.
getInvocationDate() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
getJobConfiguration() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getJobConfiguration() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getJobConfiguration() - Method in interface com.sitewhere.spi.scheduling.IScheduledJob
Get job configuration values.
getJobConfiguration() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get job configuration values.
getJobState() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getJobState() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getJobState() - Method in interface com.sitewhere.spi.scheduling.IScheduledJob
Get job scheduling state.
getJobState() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get job scheduling state.
getJobType() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getJobType() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getJobType() - Method in interface com.sitewhere.spi.scheduling.IScheduledJob
Get job type.
getJobType() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get job type.
getLastInteractionDate() - Method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
getLastInteractionDate() - Method in interface com.sitewhere.spi.device.IDeviceAssignmentState
Date of last interaction with device.
getLastLocation() - Method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
getLastLocation() - Method in interface com.sitewhere.spi.device.IDeviceAssignmentState
Get last device location.
getLastLogin() - Method in class com.sitewhere.rest.model.user.User
 
getLastLogin() - Method in interface com.sitewhere.spi.user.IUser
Get the last login date.
getLastModified() - Method in class com.sitewhere.rest.model.resource.Resource
 
getLastModified() - Method in interface com.sitewhere.spi.resource.IResource
Get last modified date for resource.
getLastName() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getLastName() - Method in class com.sitewhere.rest.model.user.User
 
getLastName() - Method in interface com.sitewhere.spi.user.IUser
Get the surname.
getLastName() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the surname.
getLatestAlerts() - Method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
getLatestAlerts() - Method in interface com.sitewhere.spi.device.IDeviceAssignmentState
Get last alert for each alert type.
getLatestMeasurements() - Method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
getLatestMeasurements() - Method in interface com.sitewhere.spi.device.IDeviceAssignmentState
Get last measurement for each measurement id.
getLatitude() - Method in class com.sitewhere.rest.model.asset.LocationAsset
 
getLatitude() - Method in class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest
 
getLatitude() - Method in class com.sitewhere.rest.model.common.Location
 
getLatitude() - Method in class com.sitewhere.rest.model.device.asset.DeviceLocationWithAsset
 
getLatitude() - Method in class com.sitewhere.rest.model.device.event.DeviceLocation
 
getLatitude() - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest
 
getLatitude() - Method in interface com.sitewhere.spi.asset.ILocationAsset
Get location latitude.
getLatitude() - Method in interface com.sitewhere.spi.asset.request.ILocationAssetCreateRequest
Get location latitude.
getLatitude() - Method in interface com.sitewhere.spi.common.ILocation
Get latitude measurement.
getLatitude() - Method in interface com.sitewhere.spi.device.event.IDeviceLocation
Get latitude value.
getLatitude() - Method in interface com.sitewhere.spi.device.event.request.IDeviceLocationCreateRequest
Get latitude.
getLevel() - Method in class com.sitewhere.rest.model.device.asset.DeviceAlertWithAsset
 
getLevel() - Method in class com.sitewhere.rest.model.device.event.DeviceAlert
 
getLevel() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest
 
getLevel() - Method in interface com.sitewhere.spi.device.event.IDeviceAlert
Get severity of alert.
getLevel() - Method in interface com.sitewhere.spi.device.event.request.IDeviceAlertCreateRequest
Get alert severity.
getLevel() - Method in exception com.sitewhere.spi.SiteWhereSystemException
Get the error level.
getLifecycleComponentById(String) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot
Gets an ILifecycleComponent by unique id.
getLifecycleComponents() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get map of contained ILifecycleComponent elements by unique id.
getLifecycleError() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Gets the last lifecycle error that occurred.
getLifecycleStatus() - Method in interface com.sitewhere.spi.server.ITenantRuntimeState
Get lifecycle status of tenant engine.
getLifecycleStatus() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get current lifecycle status.
getLocation() - Method in class com.sitewhere.rest.model.device.support.DeviceAssignmentHistoryEntry
 
getLocation() - Method in interface com.sitewhere.spi.geospatial.IZoneMatcher
Get location being matched.
getLocation() - Method in interface com.sitewhere.spi.geospatial.IZoneRelationship
Get device location.
getLocations() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
getLocations() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatch
Get a list of device location create requests.
getLocationsNear(double, double, double, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.search.external.IDeviceEventSearchProvider
Get a list of device locations near the given lat/long in the given time period.
getLogger() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Get component logger.
getLogoUrl() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getLogoUrl() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getLogoUrl() - Method in interface com.sitewhere.spi.tenant.ITenant
Get URL for tenant logo.
getLogoUrl() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get URL for tenant logo.
getLongitude() - Method in class com.sitewhere.rest.model.asset.LocationAsset
 
getLongitude() - Method in class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest
 
getLongitude() - Method in class com.sitewhere.rest.model.common.Location
 
getLongitude() - Method in class com.sitewhere.rest.model.device.asset.DeviceLocationWithAsset
 
getLongitude() - Method in class com.sitewhere.rest.model.device.event.DeviceLocation
 
getLongitude() - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest
 
getLongitude() - Method in interface com.sitewhere.spi.asset.ILocationAsset
Get location longitude.
getLongitude() - Method in interface com.sitewhere.spi.asset.request.ILocationAssetCreateRequest
Get location longitude.
getLongitude() - Method in interface com.sitewhere.spi.common.ILocation
Get longitude measurement.
getLongitude() - Method in interface com.sitewhere.spi.device.event.IDeviceLocation
Get longitude value.
getLongitude() - Method in interface com.sitewhere.spi.device.event.request.IDeviceLocationCreateRequest
Get longitude.
getMap() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getMap() - Method in class com.sitewhere.rest.model.device.Site
 
getMap() - Method in interface com.sitewhere.spi.device.ISite
Get map information.
getMap() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Get map information.
getMappingPath() - Method in class com.sitewhere.rest.model.device.request.DeviceMappingCreateRequest
 
getMappingPath() - Method in interface com.sitewhere.spi.device.event.request.IDeviceMappingCreateRequest
Get path in device element schema to be mapped.
getMeasurement(String) - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
getMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
getMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
getMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
getMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Attempts to get the named measurement if the event is a measurements event.
getMeasurement(String) - Method in interface com.sitewhere.spi.device.event.IMeasurementsProvider
Get measurement by name.
getMeasurementDate() - Method in class com.sitewhere.rest.model.device.charting.ChartEntry
 
getMeasurementDate() - Method in interface com.sitewhere.spi.device.charting.IChartEntry
Get date the value was measured.
getMeasurementId() - Method in class com.sitewhere.rest.model.device.charting.ChartSeries
 
getMeasurementId() - Method in interface com.sitewhere.spi.device.charting.IChartSeries
Get id a measurement represented by the series.
getMeasurements() - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
getMeasurements() - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
getMeasurements() - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
getMeasurements() - Method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
getMeasurements() - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
getMeasurements() - Method in interface com.sitewhere.spi.device.event.IDeviceEventBatch
Get a list of device measurements create requests.
getMeasurements() - Method in interface com.sitewhere.spi.device.event.IMeasurementsProvider
Get map of all measurements.
getMeasurementsSummary() - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
getMeasurementsSummary() - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
getMeasurementsSummary() - Method in interface com.sitewhere.spi.device.event.IDeviceMeasurements
Get a simple string that lists the measurements.
getMessage() - Method in class com.sitewhere.rest.model.command.CommandResponse
 
getMessage() - Method in class com.sitewhere.rest.model.device.asset.DeviceAlertWithAsset
 
getMessage() - Method in class com.sitewhere.rest.model.device.event.DeviceAlert
 
getMessage() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest
 
getMessage() - Method in class com.sitewhere.rest.model.monitoring.ProgressMessage
 
getMessage() - Method in interface com.sitewhere.spi.command.ICommandResponse
Get a detail message for the result.
getMessage() - Method in interface com.sitewhere.spi.device.event.IDeviceAlert
Get the alert message.
getMessage() - Method in interface com.sitewhere.spi.device.event.request.IDeviceAlertCreateRequest
Get the alert message.
getMessage() - Method in enum com.sitewhere.spi.error.ErrorCode
 
getMessage() - Method in interface com.sitewhere.spi.monitoring.IProgressMessage
Get message shown for current operation.
getMetadata(String) - Method in class com.sitewhere.rest.model.common.MetadataProvider
 
getMetadata() - Method in class com.sitewhere.rest.model.common.MetadataProvider
 
getMetadata(String) - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getMetadata() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getMetadata() - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.BatchElementUpdateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.BatchOperationUpdateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.DeviceStreamCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getMetadata() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getMetadata(String) - Method in interface com.sitewhere.spi.common.IMetadataProvider
Get value of metadata field.
getMetadata() - Method in interface com.sitewhere.spi.common.IMetadataProvider
Get a map of all metadata.
getMetadata() - Method in interface com.sitewhere.spi.device.event.request.IDeviceEventCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamCreateRequest
Get metadata associated with stream.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IBatchElementUpdateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Get metadata entries.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IBatchOperationUpdateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Get metadata values.
getMetadata() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get metadata values.
getMetadataExtractor() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder
Get metadata extractor implementation.
getMissingDeviceAssignments(String, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Find all device assignments that have been marked missing by the presence manager.
getModule(String) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Get asset module by unique id.
getMulticaster() - Method in interface com.sitewhere.spi.device.event.processor.IMulticastingOutboundEventProcessor
Get the configured multcaster implementation.
getName() - Method in class com.sitewhere.rest.model.asset.Asset
 
getName() - Method in class com.sitewhere.rest.model.asset.AssetCategory
 
getName() - Method in class com.sitewhere.rest.model.asset.AssetModule
 
getName() - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.asset.request.AssetCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.command.CommandParameter
 
getName() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getName() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getName() - Method in class com.sitewhere.rest.model.device.element.DeviceElement
 
getName() - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurement
 
getName() - Method in class com.sitewhere.rest.model.device.event.MeasurementEntry
 
getName() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
getName() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Parameter
 
getName() - Method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
getName() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.device.Site
 
getName() - Method in class com.sitewhere.rest.model.device.Zone
 
getName() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getName() - Method in class com.sitewhere.rest.model.search.external.SearchProvider
 
getName() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest
 
getName() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getName() - Method in class com.sitewhere.rest.model.tenant.TenantGroup
 
getName() - Method in interface com.sitewhere.spi.asset.IAsset
Get asset name.
getName() - Method in interface com.sitewhere.spi.asset.IAssetCategory
Get the module name.
getName() - Method in interface com.sitewhere.spi.asset.request.IAssetCategoryCreateRequest
Get category name.
getName() - Method in interface com.sitewhere.spi.asset.request.IAssetCreateRequest
Get asset name.
getName() - Method in interface com.sitewhere.spi.device.command.ICommandParameter
Get parameter name.
getName() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Get command name.
getName() - Method in interface com.sitewhere.spi.device.element.IDeviceElement
Get human-readable name for element.
getName() - Method in interface com.sitewhere.spi.device.event.IMeasurementEntry
Get measurement name.
getName() - Method in interface com.sitewhere.spi.device.group.IDeviceGroup
Get the group name.
getName() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Get name that describes specification.
getName() - Method in interface com.sitewhere.spi.device.ISite
Get the site name.
getName() - Method in interface com.sitewhere.spi.device.IZone
Get display name.
getName() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Get command name.
getName() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupCreateRequest
Get the group name.
getName() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Get name that describes specification.
getName() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Get site name.
getName() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get zone name.
getName() - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get name of symbol generator.
getName() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Schedule name.
getName() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Schedule name.
getName() - Method in interface com.sitewhere.spi.search.external.ISearchProvider
Get a human-readable name for the search provider.
getName() - Method in interface com.sitewhere.spi.server.ITenantEngineComponent
Get component name.
getName() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleStep
Get the step name.
getName() - Method in interface com.sitewhere.spi.tenant.ITenant
Get tenant name.
getName() - Method in interface com.sitewhere.spi.tenant.ITenantGroup
Get name for group.
getName() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get tenant name.
getName() - Method in interface com.sitewhere.spi.tenant.request.ITenantGroupCreateRequest
Get name for group.
getName() - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
getNamespace() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getNamespace() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
getNamespace() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getNamespace() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Optional namespace for distinguishing commands.
getNamespace() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Optional namespace for distinguishing commands.
getNested() - Method in interface com.sitewhere.spi.device.IDeviceNestingContext
Get nested device being addressed.
getNewState() - Method in class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
getNewState() - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
getNewState() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
getNewState() - Method in interface com.sitewhere.spi.device.event.IDeviceStateChange
Get the requested new state.
getNewState() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStateChangeCreateRequest
Get the requested new state.
getNumResults() - Method in class com.sitewhere.rest.model.search.SearchResults
 
getNumResults() - Method in interface com.sitewhere.spi.search.ISearchResults
Get the total number of results.
getOpacity() - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
getOpacity() - Method in class com.sitewhere.rest.model.device.Zone
 
getOpacity() - Method in interface com.sitewhere.spi.device.IZone
Get the opacity value.
getOpacity() - Method in interface com.sitewhere.spi.device.request.IZoneCreateRequest
Get opacity for UI.
getOperationCount() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleStep
Counts the number of operations that make up this step.
getOperationType() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getOperationType() - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
getOperationType() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Gets the type of operation to be performed.
getOperationType() - Method in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Get operation to be performed.
getOriginatingEventId() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandResponseWithAsset
 
getOriginatingEventId() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandResponse
 
getOriginatingEventId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandResponseCreateRequest
 
getOriginatingEventId() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandResponse
Get id of IDeviceCommandInvocation that triggered the response.
getOriginatingEventId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandResponseCreateRequest
Get id of IDeviceCommandInvocation that triggered the response.
getOriginator() - Method in class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
getOriginator() - Method in class com.sitewhere.rest.model.device.communication.DeviceRequest
 
getOriginator() - Method in interface com.sitewhere.spi.device.communication.IDecodedDeviceRequest
Get event originator if available.
getOutboundCommandRouter() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the router that chooses which destination will process a command.
getOutboundEventProcessorChain() - Method in interface com.sitewhere.spi.device.event.IEventProcessing
Get chain of processors that will act on outbound data.
getOutboundProcessingStrategy() - Method in interface com.sitewhere.spi.device.event.IEventProcessing
Get the strategy for moving processed events into the outbound chain.
getPageNumber() - Method in class com.sitewhere.rest.model.search.SearchCriteria
 
getPageNumber() - Method in interface com.sitewhere.spi.search.ISearchCriteria
Get offset from beginning of dataset.
getPageSize() - Method in class com.sitewhere.rest.model.search.SearchCriteria
 
getPageSize() - Method in interface com.sitewhere.spi.search.ISearchCriteria
Get number of records per page of data.
getParameters() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getParameters() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getParameters() - Method in class com.sitewhere.rest.model.device.command.DeviceCommandExecution
 
getParameters() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
getParameters() - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
getParameters() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getParameters() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Operation parameters.
getParameters() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Get list of parameters.
getParameters() - Method in interface com.sitewhere.spi.device.command.IDeviceCommandExecution
Get parameters populated with data from the invocation.
getParameters() - Method in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Get operation parameters.
getParameters() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Get list of parameters.
getParameterValues() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getParameterValues() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getParameterValues() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getParameterValues() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getParameterValues() - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
getParameterValues() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get the list of parameter names mapped to values.
getParameterValues() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get the list of parameter names mapped to values.
getParameterValues() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
Get the list of parameter names mapped to values.
getParameterValues() - Method in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Get the list of parameter names mapped to values.
getParent() - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
getParent() - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
getParent() - Method in interface com.sitewhere.spi.user.IGrantedAuthority
Get parent authority.
getParent() - Method in interface com.sitewhere.spi.user.request.IGrantedAuthorityCreateRequest
Get parent authority.
getParent() - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
getParentHardwareId() - Method in class com.sitewhere.rest.model.device.Device
 
getParentHardwareId() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getParentHardwareId() - Method in interface com.sitewhere.spi.device.IDevice
If contained by a parent device, returns the parent hardware id.
getParentHardwareId() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get the parent hardware id (if nested).
getParentId() - Method in interface com.sitewhere.spi.server.ITenantEngineComponent
Get parent component id.
getPassword() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getPassword() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the password.
getPath() - Method in class com.sitewhere.rest.model.device.element.DeviceElement
 
getPath() - Method in class com.sitewhere.rest.model.resource.request.ResourceCreateRequest
 
getPath() - Method in class com.sitewhere.rest.model.resource.Resource
 
getPath() - Method in class com.sitewhere.rest.model.resource.ResourceCreateError
 
getPath() - Method in interface com.sitewhere.spi.device.element.IDeviceElement
Get relative path to element from parent.
getPath() - Method in interface com.sitewhere.spi.device.IDeviceNestingContext
Get path in parent device IDeviceElementSchema mapped to target device.
getPath() - Method in interface com.sitewhere.spi.resource.IResource
Get unique resource path.
getPath() - Method in interface com.sitewhere.spi.resource.IResourceCreateError
Get path being created.
getPath() - Method in interface com.sitewhere.spi.resource.request.IResourceCreateRequest
Get unique resource path.
getPayload() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IDeviceContext
Get payload to be parsed.
getPayload() - Method in interface com.sitewhere.spi.device.communication.ICompositeDeviceEventDecoder.IMessageMetadata
Get parsed payload.
getPort() - Method in interface com.sitewhere.spi.common.IInternetConnected
Get port to connect to.
getPresenceMissingDate() - Method in class com.sitewhere.rest.model.device.DeviceAssignmentState
 
getPresenceMissingDate() - Method in interface com.sitewhere.spi.device.IDeviceAssignmentState
Date when presence was determined to be missing.
getPresenceNotificationStrategy() - Method in interface com.sitewhere.spi.device.presence.IDevicePresenceManager
Get notification strategy that controls how often presence events are sent.
getPreviousState() - Method in class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
getPreviousState() - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
getPreviousState() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
getPreviousState() - Method in interface com.sitewhere.spi.device.event.IDeviceStateChange
Get the previous (or assumed previous) state.
getPreviousState() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStateChangeCreateRequest
Get the previous (or assumed previous) state.
getProcessedDate() - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
getProcessedDate() - Method in class com.sitewhere.rest.model.device.request.BatchElementUpdateRequest
 
getProcessedDate() - Method in interface com.sitewhere.spi.device.batch.IBatchElement
Get the date on which the element was processed.
getProcessedDate() - Method in interface com.sitewhere.spi.device.request.IBatchElementUpdateRequest
Get date element was processed.
getProcessingEndedDate() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getProcessingEndedDate() - Method in class com.sitewhere.rest.model.device.request.BatchOperationUpdateRequest
 
getProcessingEndedDate() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Get the date when processing of the operation ended.
getProcessingEndedDate() - Method in interface com.sitewhere.spi.device.request.IBatchOperationUpdateRequest
Get updated processing end date.
getProcessingStartedDate() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getProcessingStartedDate() - Method in class com.sitewhere.rest.model.device.request.BatchOperationUpdateRequest
 
getProcessingStartedDate() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Get the date when processing of the operation started.
getProcessingStartedDate() - Method in interface com.sitewhere.spi.device.request.IBatchOperationUpdateRequest
Get updated processing start date.
getProcessingStatus() - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
getProcessingStatus() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getProcessingStatus() - Method in class com.sitewhere.rest.model.device.request.BatchElementUpdateRequest
 
getProcessingStatus() - Method in class com.sitewhere.rest.model.device.request.BatchOperationUpdateRequest
 
getProcessingStatus() - Method in class com.sitewhere.rest.model.search.device.BatchElementSearchCriteria
 
getProcessingStatus() - Method in interface com.sitewhere.spi.device.batch.IBatchElement
Get processing status indicator.
getProcessingStatus() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Get processing status for the batch operation.
getProcessingStatus() - Method in interface com.sitewhere.spi.device.request.IBatchElementUpdateRequest
Get processing status indicator.
getProcessingStatus() - Method in interface com.sitewhere.spi.device.request.IBatchOperationUpdateRequest
Get updated processing status for the batch operation.
getProcessingStatus() - Method in interface com.sitewhere.spi.search.device.IBatchElementSearchCriteria
Gets processing status to match.
getProcessors() - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessorChain
Get the list of chained processors.
getProcessors() - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessorChain
Get the list of chained processors.
getProperties() - Method in class com.sitewhere.rest.model.asset.Asset
 
getProperties() - Method in class com.sitewhere.rest.model.asset.request.AssetCreateRequest
 
getProperties() - Method in interface com.sitewhere.spi.asset.IAsset
Get properties associated with asset.
getProperties() - Method in interface com.sitewhere.spi.asset.request.IAssetCreateRequest
Get properties associated with asset.
getQuery() - Method in interface com.sitewhere.spi.asset.IAssetSearchCriteria
Get the search query.
getReason() - Method in class com.sitewhere.rest.model.device.command.RegistrationAckCommand
 
getReason() - Method in class com.sitewhere.rest.model.device.command.RegistrationFailureCommand
 
getReason() - Method in class com.sitewhere.rest.model.resource.ResourceCreateError
 
getReason() - Method in interface com.sitewhere.spi.device.command.IRegistrationAckCommand
Indicates why registration was successful.
getReason() - Method in interface com.sitewhere.spi.device.command.IRegistrationFailureCommand
Get reason for registration failure.
getReason() - Method in interface com.sitewhere.spi.resource.IResourceCreateError
Get reason for failure.
getReceivedDate() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getReceivedDate() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getReceivedDate() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get the date this event was received.
getRegisteredLifecycleComponents() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleHierarchyRoot
Get list of components that have registered to participate in the server component lifecycle.
getRegistrationManager() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get the configured registration manager.
getRelationship(String) - Method in interface com.sitewhere.spi.geospatial.IZoneMatcher
Get relationship with the given zone.
getRelationships() - Method in interface com.sitewhere.spi.geospatial.IZoneMatcher
Get the map of all relationships.
getReleasedDate() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getReleasedDate() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get the date/time at which the assignment was released.
getReplyTo() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getReplyTo() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get information for replying to originator.
getRequest() - Method in class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
getRequest() - Method in class com.sitewhere.rest.model.device.communication.DeviceRequest
 
getRequest() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
getRequest() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest.Builder
 
getRequest() - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest.Builder
 
getRequest() - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest.Builder
 
getRequest() - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest.Builder
 
getRequest() - Method in interface com.sitewhere.spi.device.communication.IDecodedDeviceRequest
Get event create request.
getRequestCount() - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
getRequestCount() - Method in interface com.sitewhere.spi.cache.ICache
Get the number of requests made to the cache.
getResourceType() - Method in class com.sitewhere.rest.model.resource.request.ResourceCreateRequest
 
getResourceType() - Method in class com.sitewhere.rest.model.resource.Resource
 
getResourceType() - Method in interface com.sitewhere.spi.resource.IResource
Get type of resource.
getResourceType() - Method in interface com.sitewhere.spi.resource.request.IResourceCreateRequest
Get type of resource.
getResponse() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandResponseWithAsset
 
getResponse() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandResponse
 
getResponse() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandResponseCreateRequest
 
getResponse() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandResponse
Get response payload.
getResponse() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandResponseCreateRequest
Get response payload.
getResponseEventId() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandResponseWithAsset
 
getResponseEventId() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandResponse
 
getResponseEventId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandResponseCreateRequest
 
getResponseEventId() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandResponse
Get id of event sent as a response.
getResponseEventId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandResponseCreateRequest
Get id of event sent as a response.
getResponses() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary
 
getResult() - Method in class com.sitewhere.rest.model.command.CommandResponse
 
getResult() - Method in class com.sitewhere.rest.model.device.command.DeviceMappingAckCommand
 
getResult() - Method in interface com.sitewhere.spi.command.ICommandResponse
Get the command result.
getResult() - Method in interface com.sitewhere.spi.device.command.IDeviceMappingAckCommand
Indicates result of device mapping operation.
getResults() - Method in class com.sitewhere.rest.model.search.Pager
 
getResults() - Method in class com.sitewhere.rest.model.search.SearchResults
 
getResults() - Method in interface com.sitewhere.spi.search.ISearchResults
Get the results.
getRoleName() - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
getRoles() - Method in class com.sitewhere.rest.model.asset.PersonAsset
 
getRoles() - Method in class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest
 
getRoles() - Method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
getRoles() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getRoles() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
getRoles() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest
 
getRoles() - Method in interface com.sitewhere.spi.asset.IPersonAsset
Get a list of roles for the person.
getRoles() - Method in interface com.sitewhere.spi.asset.request.IPersonAssetCreateRequest
Get a list of roles for the person.
getRoles() - Method in interface com.sitewhere.spi.device.group.IDeviceGroup
Get list of roles associated with element.
getRoles() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupElement
Get list of roles associated with element.
getRoles() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupCreateRequest
Get list of roles associated with group.
getRoles() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupElementCreateRequest
Get list of roles associated with element.
getRouteBuilder() - Method in interface com.sitewhere.spi.device.event.processor.IMulticastingOutboundEventProcessor
Get the configured route builder implementation.
getScheduleByToken(String) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Get a schedule by unique token.
getScheduledJobByToken(String) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
Get a scheduled job by unique token.
getScheduleManagement() - Method in class com.sitewhere.rest.model.scheduling.request.scripting.ScheduleManagementRequestBuilder
 
getScheduleToken() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getScheduleToken() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getScheduleToken() - Method in interface com.sitewhere.spi.scheduling.IScheduledJob
Get unique schedule token.
getScheduleToken() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get unique schedule token.
getSearchCriteria() - Method in class com.sitewhere.rest.model.search.Pager
 
getSearchProvider(String) - Method in interface com.sitewhere.spi.search.external.ISearchProviderManager
Get search provider with the given unique id.
getSearchProviders() - Method in interface com.sitewhere.spi.search.external.ISearchProviderManager
Get list of available search providers.
getSequenceNumber() - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
getSequenceNumber() - Method in class com.sitewhere.rest.model.device.event.DeviceStreamData
 
getSequenceNumber() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStreamDataCreateRequest
 
getSequenceNumber() - Method in class com.sitewhere.rest.model.device.event.request.SendDeviceStreamDataRequest
 
getSequenceNumber() - Method in interface com.sitewhere.spi.device.command.ISendDeviceStreamDataCommand
Get sequence number of data chunk.
getSequenceNumber() - Method in interface com.sitewhere.spi.device.event.IDeviceStreamData
Get sequence number for ordering chunks.
getSequenceNumber() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamDataCreateRequest
Get sequence number for ordering chunks.
getSequenceNumber() - Method in interface com.sitewhere.spi.device.event.request.ISendDeviceStreamDataRequest
Get sequence number of chunk to send.
getServerClass() - Method in class com.sitewhere.rest.model.system.Version
 
getSite() - Method in class com.sitewhere.rest.model.device.Device
 
getSite() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getSiteByToken(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a site by unique token.
getSiteCache() - Method in interface com.sitewhere.spi.device.IDeviceManagementCacheProvider
Gets cache mapping site tokens to ISite objects.
getSiteForAssignment(IDeviceAssignment) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get the site associated with an assignment.
getSiteIdentifier(ISite) - Method in interface com.sitewhere.spi.device.symbology.IEntityUriProvider
Get unique identifier for a site.
getSiteSymbol(ISite, IEntityUriProvider) - Method in interface com.sitewhere.spi.device.symbology.ISymbolGenerator
Get symbol for a site.
getSiteToken() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.Device
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getSiteToken() - Method in class com.sitewhere.rest.model.device.Zone
 
getSiteToken() - Method in class com.sitewhere.rest.model.search.device.AssignmentsForAssetSearchCriteria
 
getSiteToken() - Method in class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
getSiteToken() - Method in interface com.sitewhere.spi.device.event.IDeviceEvent
Get token for site the event pertains to.
getSiteToken() - Method in interface com.sitewhere.spi.device.event.request.IDeviceRegistrationRequest
Get token for site to which device should be assigned.
getSiteToken() - Method in interface com.sitewhere.spi.device.IDevice
Get token for associated site.
getSiteToken() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get token for assigned site.
getSiteToken() - Method in interface com.sitewhere.spi.device.IZone
Get token for associated site.
getSiteToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
If set, only devices associated with the given site will be sent the command.
getSiteToken() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get the site token.
getSiteToken() - Method in interface com.sitewhere.spi.search.device.IAssignmentsForAssetSearchCriteria
Limits search to a given site.
getSiteToken() - Method in interface com.sitewhere.spi.search.device.IDeviceSearchCriteria
Get token if filtered by site.
getSku() - Method in class com.sitewhere.rest.model.asset.HardwareAsset
 
getSku() - Method in class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest
 
getSku() - Method in interface com.sitewhere.spi.asset.IHardwareAsset
Get the stock keeping unit (SKU).
getSku() - Method in interface com.sitewhere.spi.asset.request.IHardwareAssetCreateRequest
Get the stock keeping unit (SKU).
getSlots() - Method in class com.sitewhere.rest.model.device.support.InterpolatedAssignmentHistory
 
getSource() - Method in class com.sitewhere.rest.model.device.asset.DeviceAlertWithAsset
 
getSource() - Method in class com.sitewhere.rest.model.device.event.DeviceAlert
 
getSource() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest
 
getSource() - Method in interface com.sitewhere.spi.device.event.IDeviceAlert
Get source of the alert.
getSource() - Method in interface com.sitewhere.spi.device.event.request.IDeviceAlertCreateRequest
Get source of device alert.
getSourceId() - Method in interface com.sitewhere.spi.device.communication.IInboundEventSource
Get unique id for event source.
getSpecification() - Method in class com.sitewhere.rest.model.device.Device
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.device.Device
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getSpecificationToken() - Method in class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
getSpecificationToken() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Get token for the parent specification.
getSpecificationToken() - Method in interface com.sitewhere.spi.device.event.request.IDeviceRegistrationRequest
Get token for device hardware specification.
getSpecificationToken() - Method in interface com.sitewhere.spi.device.IDevice
Get token for device specification.
getSpecificationToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
If set, only devices with the given specification token will be sent the command.
getSpecificationToken() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get the device specification token.
getSpecificationToken() - Method in interface com.sitewhere.spi.search.device.IDeviceSearchCriteria
Get token if filtered by specification.
getStartDate() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getStartDate() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getStartDate() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getStartDate() - Method in class com.sitewhere.rest.model.search.DateRangeSearchCriteria
 
getStartDate() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
Get date range start.
getStartDate() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Get date schedule takes effect.
getStartDate() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Get date schedule takes effect.
getStartDate() - Method in interface com.sitewhere.spi.search.IDateRangeSearchCriteria
Get date range start.
getState() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getState() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get latest state information for the assignment.
getStatus() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getStatus() - Method in class com.sitewhere.rest.model.device.command.DeviceStreamAckCommand
 
getStatus() - Method in class com.sitewhere.rest.model.device.Device
 
getStatus() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getStatus() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getStatus() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getStatus() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
getStatus() - Method in class com.sitewhere.rest.model.search.device.AssignmentSearchCriteria
 
getStatus() - Method in class com.sitewhere.rest.model.search.device.AssignmentsForAssetSearchCriteria
 
getStatus() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getStatus() - Method in class com.sitewhere.rest.model.user.User
 
getStatus() - Method in interface com.sitewhere.spi.device.command.IDeviceStreamAckCommand
Get status of stream creation.
getStatus() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get status of command.
getStatus() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get status of command.
getStatus() - Method in interface com.sitewhere.spi.device.IDevice
Get most recent device status.
getStatus() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get the device assignement status.
getStatus() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Get device status indicator.
getStatus() - Method in interface com.sitewhere.spi.search.device.IAssignmentSearchCriteria
Only return assignments with the given status.
getStatus() - Method in interface com.sitewhere.spi.search.device.IAssignmentsForAssetSearchCriteria
Only return assignments with the given status.
getStatus() - Method in interface com.sitewhere.spi.server.ITenantEngineComponent
Get component status.
getStatus() - Method in interface com.sitewhere.spi.user.IUser
Get the account status.
getStatus() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the account status.
getStatusCode() - Method in enum com.sitewhere.spi.user.AccountStatus
Get the status code.
getSteps() - Method in interface com.sitewhere.spi.server.lifecycle.ICompositeLifecycleStep
Get an ordered list of steps to be executed.
getStreamId() - Method in class com.sitewhere.rest.model.device.command.DeviceStreamAckCommand
 
getStreamId() - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
getStreamId() - Method in class com.sitewhere.rest.model.device.event.DeviceStreamData
 
getStreamId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStreamDataCreateRequest
 
getStreamId() - Method in class com.sitewhere.rest.model.device.event.request.SendDeviceStreamDataRequest
 
getStreamId() - Method in class com.sitewhere.rest.model.device.request.DeviceStreamCreateRequest
 
getStreamId() - Method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
getStreamId() - Method in interface com.sitewhere.spi.device.command.IDeviceStreamAckCommand
Get unique id of stream being created.
getStreamId() - Method in interface com.sitewhere.spi.device.command.ISendDeviceStreamDataCommand
Get id of stream data belongs to.
getStreamId() - Method in interface com.sitewhere.spi.device.event.IDeviceStreamData
Get id that ties all related chunks together.
getStreamId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamCreateRequest
Get unique identifier for stream within assignment.
getStreamId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStreamDataCreateRequest
Get id of stream data belongs to.
getStreamId() - Method in interface com.sitewhere.spi.device.event.request.ISendDeviceStreamDataRequest
Get stream id to send from.
getStreamId() - Method in interface com.sitewhere.spi.device.streaming.IDeviceStream
Get unique identifier for stream within assignment.
getSymbolGenerator(String) - Method in interface com.sitewhere.spi.device.symbology.ISymbolGeneratorManager
Get a symbol generator by id.
getSymbolGeneratorManager() - Method in interface com.sitewhere.spi.device.communication.IDeviceCommunication
Get manager for generating symbols for entities.
getSymbolGenerators() - Method in interface com.sitewhere.spi.device.symbology.ISymbolGeneratorManager
Get the list of available symbol generators.
getTarget() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getTarget() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getTarget() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getTarget() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get actor type that received command.
getTarget() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get command target type.
getTargetId() - Method in class com.sitewhere.rest.model.device.asset.DeviceCommandInvocationWithAsset
 
getTargetId() - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
getTargetId() - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
getTargetId() - Method in interface com.sitewhere.spi.device.event.IDeviceCommandInvocation
Get unique id of command target.
getTargetId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandInvocationCreateRequest
Get unique id of command target.
getTaskName() - Method in class com.sitewhere.rest.model.monitoring.ProgressMessage
 
getTaskName() - Method in interface com.sitewhere.spi.monitoring.IProgressMessage
Get name of overall task being monitored.
getTenant(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Get tenant by unique id.
getTenant() - Method in class com.sitewhere.rest.model.tenant.TenantGroupElement
 
getTenant() - Method in interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent
Get tenant for component.
getTenantByAuthenticationToken(String) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Get a tenant by authentication token sent by devices.
getTenantById(String) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Get a tenant by tenant id.
getTenantGroup(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Get a tenant group by token.
getTenantGroupByToken(String) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Get a tenant group by unique token.
getTenantGroupToken() - Method in class com.sitewhere.rest.model.tenant.TenantGroupElement
 
getTenantGroupToken() - Method in interface com.sitewhere.spi.tenant.ITenantGroupElement
Get token of tenant group element belongs to.
getTenantId() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupElementCreateRequest
 
getTenantId() - Method in class com.sitewhere.rest.model.tenant.TenantGroupElement
 
getTenantId() - Method in interface com.sitewhere.spi.tenant.ITenantGroupElement
Get id of tenant referenced by element.
getTenantId() - Method in interface com.sitewhere.spi.tenant.request.ITenantGroupElementCreateRequest
Get id of tenant referenced by element.
getTenantManagement() - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
 
getTenantResource(String, String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Get a tenant resource registered for the given path.
getTenantResources(String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Get list of all resources for the given tenant.
getTenantTemplateId() - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
getTenantTemplateId() - Method in class com.sitewhere.rest.model.tenant.Tenant
 
getTenantTemplateId() - Method in interface com.sitewhere.spi.tenant.ITenant
Get id of template used to create tenant.
getTenantTemplateId() - Method in interface com.sitewhere.spi.tenant.request.ITenantCreateRequest
Get id of template used to create tenant.
getTenantTemplateResources(String) - Method in interface com.sitewhere.spi.resource.IResourceManager
Gets resources associated with the given tenant template.
getTenantTemplateRoots() - Method in interface com.sitewhere.spi.resource.IResourceManager
Get root names for tenant template resource trees.
getTextSearch() - Method in class com.sitewhere.rest.model.search.tenant.TenantSearchCriteria
 
getTextSearch() - Method in interface com.sitewhere.spi.search.user.ITenantSearchCriteria
Get text search phrase to match against tenant id and name.
getTimeSlot() - Method in class com.sitewhere.rest.model.device.support.DeviceAssignmentHistoryEntry
 
getToken() - Method in class com.sitewhere.rest.model.device.batch.BatchOperation
 
getToken() - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
getToken() - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
getToken() - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
getToken() - Method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
getToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.device.Site
 
getToken() - Method in class com.sitewhere.rest.model.device.Zone
 
getToken() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getToken() - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
getToken() - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest
 
getToken() - Method in class com.sitewhere.rest.model.tenant.TenantGroup
 
getToken() - Method in interface com.sitewhere.spi.device.batch.IBatchOperation
Get the unique group token.
getToken() - Method in interface com.sitewhere.spi.device.command.IDeviceCommand
Get the unique command token.
getToken() - Method in interface com.sitewhere.spi.device.group.IDeviceGroup
Get the unique group token.
getToken() - Method in interface com.sitewhere.spi.device.IDeviceAssignment
Get token that uniquely identifies the assignment.
getToken() - Method in interface com.sitewhere.spi.device.IDeviceSpecification
Get unique device specification token.
getToken() - Method in interface com.sitewhere.spi.device.ISite
Get unique token.
getToken() - Method in interface com.sitewhere.spi.device.IZone
Get unique zone token.
getToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandForCriteriaRequest
Get unique token for batch request.
getToken() - Method in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Get unique token for batch request.
getToken() - Method in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Get the unique token.
getToken() - Method in interface com.sitewhere.spi.device.request.IDeviceAssignmentCreateRequest
Get token for assignment.
getToken() - Method in interface com.sitewhere.spi.device.request.IDeviceCommandCreateRequest
Get unique command token.
getToken() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupCreateRequest
Get the unique token.
getToken() - Method in interface com.sitewhere.spi.device.request.IDeviceSpecificationCreateRequest
Allows the specification id to be specified.
getToken() - Method in interface com.sitewhere.spi.device.request.ISiteCreateRequest
Site token.
getToken() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Unique token for schedule.
getToken() - Method in interface com.sitewhere.spi.scheduling.IScheduledJob
Get unique job token.
getToken() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Unique token for schedule.
getToken() - Method in interface com.sitewhere.spi.scheduling.request.IScheduledJobCreateRequest
Get unique job token.
getToken() - Method in interface com.sitewhere.spi.tenant.ITenantGroup
Get unique token for group.
getToken() - Method in interface com.sitewhere.spi.tenant.request.ITenantGroupCreateRequest
Get unique token for group.
getTotal() - Method in class com.sitewhere.rest.model.search.Pager
 
getTotalOperations() - Method in class com.sitewhere.rest.model.monitoring.ProgressMessage
 
getTotalOperations() - Method in interface com.sitewhere.spi.monitoring.IProgressMessage
Get count of all operations to be performed.
getTriggerConfiguration() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getTriggerConfiguration() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getTriggerConfiguration() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Get trigger configuration values.
getTriggerConfiguration() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Get trigger configuration values.
getTriggerType() - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
getTriggerType() - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
getTriggerType() - Method in interface com.sitewhere.spi.scheduling.ISchedule
Get type of trigger for schedule.
getTriggerType() - Method in interface com.sitewhere.spi.scheduling.request.IScheduleCreateRequest
Get type of trigger for schedule.
getType() - Method in class com.sitewhere.rest.model.asset.Asset
 
getType() - Method in class com.sitewhere.rest.model.device.asset.DeviceAlertWithAsset
 
getType() - Method in class com.sitewhere.rest.model.device.asset.DeviceStateChangeWithAsset
 
getType() - Method in class com.sitewhere.rest.model.device.command.CommandParameter
 
getType() - Method in class com.sitewhere.rest.model.device.command.SystemCommand
 
getType() - Method in class com.sitewhere.rest.model.device.communication.DeviceRequest
 
getType() - Method in class com.sitewhere.rest.model.device.event.DeviceAlert
 
getType() - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
getType() - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest
 
getType() - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
getType() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Parameter
 
getType() - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
getType() - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest
 
getType() - Method in class com.sitewhere.rest.model.device.SiteMapData
 
getType() - Method in interface com.sitewhere.spi.asset.IAsset
Get the asset type indicator.
getType() - Method in interface com.sitewhere.spi.cache.ICache
Get the cache type.
getType() - Method in interface com.sitewhere.spi.device.command.ICommandParameter
Get parameter datatype.
getType() - Method in interface com.sitewhere.spi.device.command.ISystemCommand
Gets the command type.
getType() - Method in interface com.sitewhere.spi.device.event.IDeviceAlert
Get the alert type indicator.
getType() - Method in interface com.sitewhere.spi.device.event.IDeviceStateChange
Get type of state change.
getType() - Method in interface com.sitewhere.spi.device.event.request.IDeviceAlertCreateRequest
Get the alert type indicator.
getType() - Method in interface com.sitewhere.spi.device.event.request.IDeviceStateChangeCreateRequest
Get type of state change.
getType() - Method in interface com.sitewhere.spi.device.group.IDeviceGroupElement
Get group element type.
getType() - Method in interface com.sitewhere.spi.device.ISiteMapData
Get the map type.
getType() - Method in interface com.sitewhere.spi.device.request.IDeviceGroupElementCreateRequest
Get the element type.
getType() - Method in enum com.sitewhere.spi.error.ErrorLevel
Get the area type.
getType() - Method in interface com.sitewhere.spi.server.ITenantEngineComponent
Get component type.
getUnsavedDeviceAlerts() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getUnsavedDeviceAlerts() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get a list of device alerts that have not been persisted.
getUnsavedDeviceLocations() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getUnsavedDeviceLocations() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get a list of device locations that have not been persisted.
getUnsavedDeviceMeasurements() - Method in class com.sitewhere.rest.model.SiteWhereContext
 
getUnsavedDeviceMeasurements() - Method in interface com.sitewhere.spi.ISiteWhereContext
Get a list of device measurements that have not been persisted.
getUpdatedBy() - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
getUpdatedBy() - Method in interface com.sitewhere.spi.common.ISiteWhereEntity
Get username that last updated entity.
getUpdatedDate() - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
getUpdatedDate() - Method in interface com.sitewhere.spi.common.ISiteWhereEntity
Get date when entity was last updated.
getUserByUsername(String) - Method in interface com.sitewhere.spi.user.IUserManagement
Get a user given unique username.
getUserId() - Method in class com.sitewhere.rest.model.search.tenant.TenantSearchCriteria
 
getUserId() - Method in interface com.sitewhere.spi.search.user.ITenantSearchCriteria
Search for tenants for which the given user is authorized.
getUserManagement() - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
 
getUserName() - Method in class com.sitewhere.rest.model.asset.PersonAsset
 
getUserName() - Method in class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest
 
getUsername() - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
getUsername() - Method in class com.sitewhere.rest.model.user.User
 
getUserName() - Method in interface com.sitewhere.spi.asset.IPersonAsset
Get the unique username.
getUserName() - Method in interface com.sitewhere.spi.asset.request.IPersonAssetCreateRequest
Get the unique username.
getUsername() - Method in interface com.sitewhere.spi.user.IUser
Get the username.
getUsername() - Method in interface com.sitewhere.spi.user.request.IUserCreateRequest
Get the username.
getValue() - Method in class com.sitewhere.rest.model.device.charting.ChartEntry
 
getValue() - Method in class com.sitewhere.rest.model.device.command.DeviceCommandNamespace
 
getValue() - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurement
 
getValue() - Method in class com.sitewhere.rest.model.device.event.MeasurementEntry
 
getValue() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Parameter
 
getValue() - Method in interface com.sitewhere.spi.device.charting.IChartEntry
Get value for the entry.
getValue() - Method in interface com.sitewhere.spi.device.command.IDeviceCommandNamespace
Namespace value.
getValue() - Method in interface com.sitewhere.spi.device.event.IMeasurementEntry
Get measurement value.
getVersionIdentifier() - Method in class com.sitewhere.rest.model.system.Version
 
getVersionIdentifier() - Method in interface com.sitewhere.spi.system.IVersion
Gets the Maven version identifier.
getWrapped() - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
getZone(String) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a zone by its unique token.
getZone() - Method in interface com.sitewhere.spi.geospatial.IZoneRelationship
Get zone.
getZones() - Method in class com.sitewhere.rest.model.device.Site
 
GLOBAL_CONFIG_FILE_NAME - Static variable in interface com.sitewhere.spi.configuration.IDefaultResourcePaths
File name for SiteWhere global configuration file
GLOBAL_FOLDER_NAME - Static variable in interface com.sitewhere.spi.configuration.IDefaultResourcePaths
Folder containing global resources
GrantedAuthority - Class in com.sitewhere.rest.model.user
Model object for a granted authority.
GrantedAuthority() - Constructor for class com.sitewhere.rest.model.user.GrantedAuthority
 
GrantedAuthorityCreateRequest - Class in com.sitewhere.rest.model.user.request
Holds fields needed to create a new granted authority.
GrantedAuthorityCreateRequest() - Constructor for class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
GrantedAuthorityCreateRequest.Builder - Class in com.sitewhere.rest.model.user.request
 
GrantedAuthoritySearchCriteria - Class in com.sitewhere.rest.model.user
Implementation of IGrantedAuthoritySearchCriteria.
GrantedAuthoritySearchCriteria() - Constructor for class com.sitewhere.rest.model.user.GrantedAuthoritySearchCriteria
 
GROUP_ROLE - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.BatchCommandInvocation
Indicates if results should be narrowed by groups that have a given role
GROUP_TOKEN - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.BatchCommandInvocation
Indicates if results should be narrowed by group
GroupElementType - Enum in com.sitewhere.spi.device.group
Defines group element type.
GRP_ACCESS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Group for system access authorities
GRP_SCHEDULES - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Group for schedule authorities
GRP_SERVER - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Group for global server administration
GRP_TENANTS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Group for tenant authorities
GRP_USERS - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Group for user authorities

H

handleDeviceMapping(String, IDeviceMappingCreateRequest) - Method in interface com.sitewhere.spi.device.communication.IRegistrationManager
Handle mapping of a device to a path on a composite device.
handleDeviceRegistration(IDeviceRegistrationRequest) - Method in interface com.sitewhere.spi.device.communication.IRegistrationManager
Handle registration of a new device.
handleDeviceStreamDataRequest(String, IDeviceStreamDataCreateRequest) - Method in interface com.sitewhere.spi.device.communication.IDeviceStreamManager
Handle request for creating new IDeviceStreamData.
handleDeviceStreamRequest(String, IDeviceStreamCreateRequest) - Method in interface com.sitewhere.spi.device.communication.IDeviceStreamManager
Handle request for creating a new IDeviceStream.
handleSendDeviceStreamDataRequest(String, ISendDeviceStreamDataRequest) - Method in interface com.sitewhere.spi.device.communication.IDeviceStreamManager
Handle request for sending data from an IDeviceStream to a remote device.
HardwareAsset - Class in com.sitewhere.rest.model.asset
Model class for a hardware asset.
HardwareAsset() - Constructor for class com.sitewhere.rest.model.asset.HardwareAsset
 
HardwareAssetCreateRequest - Class in com.sitewhere.rest.model.asset.request
REST model implementation of IHardwareAssetCreateRequest.
HardwareAssetCreateRequest() - Constructor for class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest
 
HardwareAssetCreateRequest.Builder - Class in com.sitewhere.rest.model.asset.request
 
HardwareAssetSearchResults - Class in com.sitewhere.rest.model.search
Search results that contain hardware assets.
HardwareAssetSearchResults() - Constructor for class com.sitewhere.rest.model.search.HardwareAssetSearchResults
 
HardwareAssetSearchResults(List<HardwareAsset>) - Constructor for class com.sitewhere.rest.model.search.HardwareAssetSearchResults
 
hasAuthority(String) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Indicates if the system already contains the given authority.
hasHttpResponseCode() - Method in exception com.sitewhere.spi.SiteWhereSystemException
Check whether an HTTP response code was set.
hasMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Indicates if event has a measurement with the given name.
hasTenant(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Indicates whether a tenant exists for the given id.
hasTenantGroup(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Indicates whether a tenant group exists for the given id.
hasUsers() - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Indicates if the system has users defined.
HEADER_SITEWHERE_ERROR - Static variable in interface com.sitewhere.rest.ISiteWhereWebConstants
Header that holds SiteWhere error string on error response
HEADER_SITEWHERE_ERROR_CODE - Static variable in interface com.sitewhere.rest.ISiteWhereWebConstants
Header that holds SiteWhere error code on error response
HEADER_TENANT_TOKEN - Static variable in interface com.sitewhere.rest.ISiteWhereWebConstants
Header that holds SiteWhere tenant authentication token

I

IAsset - Interface in com.sitewhere.spi.asset
Unique item to which a device may be associated.
IAssetCategory - Interface in com.sitewhere.spi.asset
Groups related assets of a given type.
IAssetCategoryCreateRequest - Interface in com.sitewhere.spi.asset.request
Contains information needed to create an asset category.
IAssetCreateRequest - Interface in com.sitewhere.spi.asset.request
Information needed to create a new asset.
IAssetManagement - Interface in com.sitewhere.spi.asset
Asset management interface implemented by datastores that can store assets.
IAssetManagementCacheProvider - Interface in com.sitewhere.spi.asset
Interface for entity that provides caching for asset management objects.
IAssetModule<T extends IAsset> - Interface in com.sitewhere.spi.asset
Interface for a module that provides access to assets of a given type.
IAssetModuleManager - Interface in com.sitewhere.spi.asset
Interface for interacting with the asset module manager.
IAssetSearchCriteria - Interface in com.sitewhere.spi.asset
Criteria used to search for assets.
IAssignmentSearchCriteria - Interface in com.sitewhere.spi.search.device
Criteria available for filtering assignment search results.
IAssignmentsForAssetSearchCriteria - Interface in com.sitewhere.spi.search.device
Search criteria for locating assignments for a given asset type.
IAssignmentStateManager - Interface in com.sitewhere.spi.device
Manages concurrent updates to assignment state to prevent thrashing as the result of high event throughput with state updates.
IBatchCommandForCriteriaRequest - Interface in com.sitewhere.spi.device.request
Provides values needed for sending a IBatchCommandInvocationRequest based on devices that meet given criteria.
IBatchCommandInvocationRequest - Interface in com.sitewhere.spi.device.request
Parameters for a batch operation that executes a command for all devices in the batch.
IBatchElement - Interface in com.sitewhere.spi.device.batch
Holds information about a single device operation within an IBatchOperation.
IBatchElementSearchCriteria - Interface in com.sitewhere.spi.search.device
Extends search criteria to add batch element fields.
IBatchElementUpdateRequest - Interface in com.sitewhere.spi.device.request
Defines fields that can be updated on an IBatchElement.
IBatchOperation - Interface in com.sitewhere.spi.device.batch
Interface for an operation that is applied to multiple devices.
IBatchOperationCreateRequest - Interface in com.sitewhere.spi.device.request
Provides information needex to create an IBatchOperation.
IBatchOperationManager - Interface in com.sitewhere.spi.device.batch
Interface for interacting with a batch operation manager.
IBatchOperationUpdateRequest - Interface in com.sitewhere.spi.device.request
Defines fields that can be updated on an IBatchOperation.
ICache<K,V> - Interface in com.sitewhere.spi.cache
Interface for a cache that stores objects by id.
ICacheListener<T> - Interface in com.sitewhere.spi.cache
Allows for notification when cache events occur.
ICachingAssetManagement - Interface in com.sitewhere.spi.asset
Implemented by IAssetManagement implementations that support caching.
ICachingDeviceManagement - Interface in com.sitewhere.spi.device
Interface implemented by IDeviceManagement implementations that can use caching mechanisms.
IChartEntry<T> - Interface in com.sitewhere.spi.device.charting
Specifies a single measurement entry for a chart.
IChartSeries<T> - Interface in com.sitewhere.spi.device.charting
Specifies a series of chart entries that may be rendered.
ICommandDeliveryParameterExtractor<T> - Interface in com.sitewhere.spi.device.communication
Extracts delivery parameters from
ICommandDeliveryProvider<T,P> - Interface in com.sitewhere.spi.device.communication
Handles delivery of encoded command information on an underlying transport.
ICommandDestination<T,P> - Interface in com.sitewhere.spi.device.communication
Delivers commands to devices by encoding the commands, finding the list of target devices, then using a delivery provider to send the encoded commands.
ICommandExecutionBuilder - Interface in com.sitewhere.spi.device.communication
ICommandExecutionEncoder<T> - Interface in com.sitewhere.spi.device.communication
Encodes an IDeviceCommandExecution into a format that can be transmitted.
ICommandParameter - Interface in com.sitewhere.spi.device.command
A parameter assocaiated with a IDeviceCommand.
ICommandProcessingStrategy - Interface in com.sitewhere.spi.device.communication
Defines the flow executed for processing a command for delivery.
ICommandResponse - Interface in com.sitewhere.spi.command
Response for a command issued to the server.
ICommandTargetResolver - Interface in com.sitewhere.spi.device.communication
Allows an IDeviceCommandInvocation to be resolved to one or more IDeviceAssignment records that should receive the command.
ICompositeDeviceEventDecoder<T> - Interface in com.sitewhere.spi.device.communication
Device event decoder that delegates to one or more nested decoders.
ICompositeDeviceEventDecoder.IDecoderChoice<T> - Interface in com.sitewhere.spi.device.communication
Represents a potential choice for decoding a payload.
ICompositeDeviceEventDecoder.IDeviceContext<T> - Interface in com.sitewhere.spi.device.communication
 
ICompositeDeviceEventDecoder.IMessageMetadata<T> - Interface in com.sitewhere.spi.device.communication
Provides metadata about a message, which is used to decide which decoder to use.
ICompositeDeviceEventDecoder.IMessageMetadataExtractor<T> - Interface in com.sitewhere.spi.device.communication
Extracts device criteria from payload.
ICompositeLifecycleStep - Interface in com.sitewhere.spi.server.lifecycle
Implementation of ILifecycleStep that executes multiple steps in sequence.
IDateRangeSearchCriteria - Interface in com.sitewhere.spi.search
Extends basic search criteria with ability to search by a date range.
IDecodedDeviceRequest<T> - Interface in com.sitewhere.spi.device.communication
Contains information decoded by an IDeviceEventDecoder includng hardware id and originator of the event.
IDefaultResourcePaths - Interface in com.sitewhere.spi.configuration
Static constants for default resource paths.
IDevice - Interface in com.sitewhere.spi.device
Interface for a SiteWhere device.
IDeviceActions - Interface in com.sitewhere.spi.device
Provides simple methods for invoking commonly used SiteWhere actions.
IDeviceAlert - Interface in com.sitewhere.spi.device.event
Interface for an event from a device indiacating and exceptional condition.
IDeviceAlertCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a device alert.
IDeviceAssignment - Interface in com.sitewhere.spi.device
Assigns a device to a physical entity being monitored.
IDeviceAssignmentCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device assignment.
IDeviceAssignmentState - Interface in com.sitewhere.spi.device
Holds event state for a device assignment including most recent location, measurements and alerts.
IDeviceCommand - Interface in com.sitewhere.spi.device.command
A parameterized command issued to a device.
IDeviceCommandCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device command.
IDeviceCommandExecution - Interface in com.sitewhere.spi.device.command
Represents an IDeviceCommand combined with an IDeviceCommandInvocation to represent the actual call made to the target.
IDeviceCommandInvocation - Interface in com.sitewhere.spi.device.event
Captures information about the invocation of a command.
IDeviceCommandInvocationCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a device command invocation.
IDeviceCommandNamespace - Interface in com.sitewhere.spi.device.command
Used for grouping device commands by namespace.
IDeviceCommandResponse - Interface in com.sitewhere.spi.device.event
Represents a response from a device regarding a previously sent command.
IDeviceCommandResponseCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a device command response.
IDeviceCommunication - Interface in com.sitewhere.spi.device.communication
Base interface for system components that empower device communication.
IDeviceCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device.
IDeviceElement - Interface in com.sitewhere.spi.device.element
Common base class for elements in the IDeviceElementSchema hierarchy.
IDeviceElementMapping - Interface in com.sitewhere.spi.device
Maps a location in an IDeviceElementSchema to an IDevice.
IDeviceElementSchema - Interface in com.sitewhere.spi.device.element
Specifies a schema for referencing nested devices within a parent device.
IDeviceEvent - Interface in com.sitewhere.spi.device.event
Event that originates from a device.
IDeviceEventBatch - Interface in com.sitewhere.spi.device.event
Used to create multiple events for a given device.
IDeviceEventBatchResponse - Interface in com.sitewhere.spi.device.event
Response generated when a batch of events has been processed.
IDeviceEventCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a device event.
IDeviceEventDecoder<T> - Interface in com.sitewhere.spi.device.communication
Decodes inbound device event messages.
IDeviceEventEncoder<T> - Interface in com.sitewhere.spi.device.communication
Encodes a device event into another representation.
IDeviceEventFilter - Interface in com.sitewhere.spi.device.event.processor
Simple interface to support event filtering.
IDeviceEventManagement - Interface in com.sitewhere.spi.device.event
Interface for device event management operations.
IDeviceEventMulticaster<T> - Interface in com.sitewhere.spi.device.event.processor.multicast
Adds ability to send events to multiple desinations.
IDeviceEventOriginator - Interface in com.sitewhere.spi.device.event
Wrapper for device event originator information.
IDeviceEventSearchProvider - Interface in com.sitewhere.spi.search.external
Search provider that provides information about SiteWhere device events.
IDeviceEventWithAsset - Interface in com.sitewhere.spi.device.asset
Extends device event information with extra data from the asset associated with its assignment.
IDeviceGroup - Interface in com.sitewhere.spi.device.group
Interface for a group of related devices.
IDeviceGroupCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device group.
IDeviceGroupCursor - Interface in com.sitewhere.spi.device.group
Provides a stateful cursor for processing entries in an IDeviceGroup.
IDeviceGroupElement - Interface in com.sitewhere.spi.device.group
Interface for an entry in an IDeviceGroup.
IDeviceGroupElementCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device group element.
IDeviceLocation - Interface in com.sitewhere.spi.device.event
Location associated with a device assignment.
IDeviceLocationCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a device location.
IDeviceManagement - Interface in com.sitewhere.spi.device
Interface for device management operations.
IDeviceManagementCacheProvider - Interface in com.sitewhere.spi.device
Interface for entity that provides caching for device management objects.
IDeviceMappingAckCommand - Interface in com.sitewhere.spi.device.command
Sends information about a pending device mapping operation to an interested device.
IDeviceMappingCreateRequest - Interface in com.sitewhere.spi.device.event.request
Information needed to map a device to a slot on a composite device.
IDeviceMeasurement - Interface in com.sitewhere.spi.device.event
Single measurement associated with a device assignment.
IDeviceMeasurements - Interface in com.sitewhere.spi.device.event
Measurements associated with a device assignment at a point in time.
IDeviceMeasurementsCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create device measurements.
IDeviceNestingContext - Interface in com.sitewhere.spi.device
Provides context information for addressing a nested device.
IDevicePresenceManager - Interface in com.sitewhere.spi.device.presence
Manages monitoring of device assignment state to determine when device presence changes.
IDeviceRegistrationRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to register a device.
IDeviceSearchCriteria - Interface in com.sitewhere.spi.search.device
Search criteria particular to device searches.
IDeviceSlot - Interface in com.sitewhere.spi.device.element
Available position where an IDevice may be inserted into a parent device.
IDeviceSpecification - Interface in com.sitewhere.spi.device
Specifies details about a given type of device.
IDeviceSpecificationCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a device specification.
IDeviceStateChange - Interface in com.sitewhere.spi.device.event
Event that captures a change of state (either requested or after the fact) for a device.
IDeviceStateChangeCreateRequest - Interface in com.sitewhere.spi.device.event.request
Request from a device to update its state in SiteWhere.
IDeviceStream - Interface in com.sitewhere.spi.device.streaming
A data stream associated with a device assignment.
IDeviceStreamAckCommand - Interface in com.sitewhere.spi.device.command
Acknowledges device stream create request.
IDeviceStreamCreateRequest - Interface in com.sitewhere.spi.device.event.request
Information needed to create a new IDeviceStream.
IDeviceStreamData - Interface in com.sitewhere.spi.device.event
A single chunk of data that is part of a stream coming from a device.
IDeviceStreamDataCreateRequest - Interface in com.sitewhere.spi.device.event.request
Interface for arguments needed to create a chunk of stream data for a device.
IDeviceStreamManager - Interface in com.sitewhere.spi.device.communication
Manages creation of IDeviceStream entities based on requests from devices.
IDeviceUnit - Interface in com.sitewhere.spi.device.element
Used to group related IDeviceSlot elements into logical units.
IDiscoverableTenantLifecycleComponent - Interface in com.sitewhere.spi.server.lifecycle
Marker interface for beans that implement ITenantLifecycleComponent and can be discovered at runtime by introspecting the application context.
IEntityUriProvider - Interface in com.sitewhere.spi.device.symbology
Translates a SiteWhere entity into a unique URL that identifies it.
IEventProcessing - Interface in com.sitewhere.spi.device.event
Base interface for system components that enable the event processing pipeline.
IFilter<T> - Interface in com.sitewhere.spi.common
Determines whether a record should be filtered from a result set.
IFilteredOutboundEventProcessor - Interface in com.sitewhere.spi.device.event.processor
Adds concept of filtering to outbound event processors.
IGrantedAuthority - Interface in com.sitewhere.spi.user
Interface for granted authority information.
IGrantedAuthorityCreateRequest - Interface in com.sitewhere.spi.user.request
Interface for arguments needed to create a granted authority.
IGrantedAuthoritySearchCriteria - Interface in com.sitewhere.spi.user
Placeholder for future search criteria.
IHardwareAsset - Interface in com.sitewhere.spi.asset
Interface for an asset that is a piece of hardware.
IHardwareAssetCreateRequest - Interface in com.sitewhere.spi.asset.request
Get information needed to create an IHardwareAsset.
IInboundEventProcessor - Interface in com.sitewhere.spi.device.event.processor
Allows interested entities to interact with SiteWhere inbound event processing.
IInboundEventProcessorChain - Interface in com.sitewhere.spi.device.event.processor
Holds a list of IInboundEventProcessor objects that are invoked in order.
IInboundEventReceiver<T> - Interface in com.sitewhere.spi.device.communication
Handles receipt of device event information from an underlying transport.
IInboundEventSource<T> - Interface in com.sitewhere.spi.device.communication
Entity that receives events from one or more IInboundEventReceiver, decodes them, and forwards them for processing.
IInboundProcessingStrategy - Interface in com.sitewhere.spi.device.communication
Provides a strategy for moving decoded events from an IInboundEventSource onto the IInboundEventProcessorChain.
IInternetConnected - Interface in com.sitewhere.spi.common
Interface for components that SiteWhere connects to using a hostname and port.
ILifecycleComponent - Interface in com.sitewhere.spi.server.lifecycle
Lifecycle methods used in SiteWhere components.
ILifecycleConstraints - Interface in com.sitewhere.spi.server.lifecycle
Used to provide extra information to lifecycle operations.
ILifecycleHierarchyRoot - Interface in com.sitewhere.spi.server.lifecycle
Offers operations for a hierarchy of nested lifecycle components.
ILifecycleProgressMonitor - Interface in com.sitewhere.spi.server.lifecycle
Allows progress to be monitored on long-running lifecycle tasks.
ILifecycleStep - Interface in com.sitewhere.spi.server.lifecycle
Single step executed as part of a lifecycle operation.
ILocation - Interface in com.sitewhere.spi.common
Coordinates that identify a point in 3d space.
ILocationAsset - Interface in com.sitewhere.spi.asset
Interface for an asset that represents a location.
ILocationAssetCreateRequest - Interface in com.sitewhere.spi.asset.request
Information needed to create an ILocationAsset.
IMeasurementEntry - Interface in com.sitewhere.spi.device.event
Contains information about a single measurement.
IMeasurementsProvider - Interface in com.sitewhere.spi.device.event
Class that stores measurement metadata.
IMetadataProvider - Interface in com.sitewhere.spi.common
Interface for an entity that has associated metadata.
IMetadataProviderEntity - Interface in com.sitewhere.spi.common
Interface that merges metadata provider and base entity.
importUser(IUser, boolean) - Method in interface com.sitewhere.spi.user.IUserManagement
Imports a user (including encrypted password) from an external system.
IMulticastingOutboundEventProcessor<T> - Interface in com.sitewhere.spi.device.event.processor
Extends IOutboundEventProcessor with routing capabilities.
IMultiResourceCreateResponse - Interface in com.sitewhere.spi.resource
Indicates status of creating multiple resources.
initialize(List<ICommandDestination<?, ?>>) - Method in interface com.sitewhere.spi.device.communication.IOutboundCommandRouter
Initialize the router with destination information.
initialize(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Initialize the component.
initializeNestedComponent(ILifecycleComponent, ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Initialize a nested component.
InterpolatedAssignmentHistory - Class in com.sitewhere.rest.model.device.support
Holds interpolated locations for an assignment in one-minute intervals.
InterpolatedAssignmentHistory() - Constructor for class com.sitewhere.rest.model.device.support.InterpolatedAssignmentHistory
 
InverseCreatedDateComparator() - Constructor for class com.sitewhere.spi.common.Comparators.InverseCreatedDateComparator
 
IOutboundCommandRouter - Interface in com.sitewhere.spi.device.communication
Routes commands to one or more ICommandDestination implementations.
IOutboundEventProcessor - Interface in com.sitewhere.spi.device.event.processor
Allows intereseted entities to interact with SiteWhere outbound event processing.
IOutboundEventProcessorChain - Interface in com.sitewhere.spi.device.event.processor
Holds a list of IOutboundEventProcessor objects that are invoked in order.
IOutboundProcessingStrategy - Interface in com.sitewhere.spi.device.communication
Provides a strategy for reporting system events to interested IOutboundEventProcessor elements registered on the IOutboundEventProcessorChain.
IPersonAsset - Interface in com.sitewhere.spi.asset
Interface for an asset that is a person.
IPersonAssetCreateRequest - Interface in com.sitewhere.spi.asset.request
Information needed to create an IPersonAsset.
IPresenceNotificationStrategy - Interface in com.sitewhere.spi.device.presence
Indicates how often events should be generated for non-present devices.
IProgressMessage - Interface in com.sitewhere.spi.monitoring
Message sent to indicate progress for a long-running task.
IProgressReporter - Interface in com.sitewhere.spi.monitoring
Allows long-running tasks to report their progress.
IRegistrationAckCommand - Interface in com.sitewhere.spi.device.command
Acknowledges successful registration.
IRegistrationFailureCommand - Interface in com.sitewhere.spi.device.command
Command that indicates device registration failed.
IRegistrationManager - Interface in com.sitewhere.spi.device.communication
Manages how devices are dynamically registered into the system.
IResource - Interface in com.sitewhere.spi.resource
Base interface for persistent system resources such as configuration files and scripts.
IResourceCreateError - Interface in com.sitewhere.spi.resource
Indicates error creating resource.
IResourceCreateRequest - Interface in com.sitewhere.spi.resource.request
Request for creating a new resource.
IResourceManager - Interface in com.sitewhere.spi.resource
Interface for component that manages system resources.
IRouteBuilder<T> - Interface in com.sitewhere.spi.device.event.processor.routing
Builds routes of a given type.
isAlert() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Returns true if event is an alert.
isAlertOfType(String) - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Returns true if event is an alert and has the given type.
isAllowNewDevices() - Method in interface com.sitewhere.spi.device.communication.IRegistrationManager
Indicates whether the registration manager allows new devices to be created as a byproduct of the registration process.
isAutoAssignSite() - Method in interface com.sitewhere.spi.device.communication.IRegistrationManager
Indicates whether all new regsitrations can be automatically assigned to a given site.
ISchedule - Interface in com.sitewhere.spi.scheduling
Represents a named schedule that can be applied to system actions.
IScheduleCreateRequest - Interface in com.sitewhere.spi.scheduling.request
Supplies information needed to create or update a schedule.
IScheduledJob - Interface in com.sitewhere.spi.scheduling
Unit of work that should be executed on a schedule.
IScheduledJobCreateRequest - Interface in com.sitewhere.spi.scheduling.request
Includes values needed to create a scheduled job.
IScheduleManagement - Interface in com.sitewhere.spi.scheduling
Management interface for persistent scheduling implementations.
IScheduleManager - Interface in com.sitewhere.spi.scheduling
Manages a list of schedules that are applied to system actions.
isCommandInvocation() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Indicates a command invocation event.
isCommandResponse() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Indicates a command response event.
isDeleted() - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
isDeleted() - Method in interface com.sitewhere.spi.common.ISiteWhereEntity
Indicates if entity has been deleted.
ISearchCriteria - Interface in com.sitewhere.spi.search
Common base class for searching that includes support for paging.
ISearchProvider - Interface in com.sitewhere.spi.search.external
Implemented by external search providers that index SiteWhere data.
ISearchProviderManager - Interface in com.sitewhere.spi.search.external
Manages a list of search providers that can be used by SiteWhere.
ISearchResults<T> - Interface in com.sitewhere.spi.search
Base interface for results returned from paged queries.
ISendDeviceStreamDataCommand - Interface in com.sitewhere.spi.device.command
Sends a chunk of device stream data to a device.
ISendDeviceStreamDataRequest - Interface in com.sitewhere.spi.device.event.request
Request from a device to send a chunk of device stream data.
isExcludeAssigned() - Method in class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
isExcludeAssigned() - Method in interface com.sitewhere.spi.search.device.IDeviceSearchCriteria
Indicates whether assigned devices should be excluded.
isExcluded(T) - Method in interface com.sitewhere.spi.common.IFilter
Indicates whether the item is excluded.
isFiltered(IDeviceEvent, IDevice, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.event.processor.IDeviceEventFilter
Indicates if an event should be filtered.
isGroup() - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
isGroup() - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
isGroup() - Method in interface com.sitewhere.spi.user.IGrantedAuthority
Indicates if the authority is a group.
isGroup() - Method in interface com.sitewhere.spi.user.request.IGrantedAuthorityCreateRequest
Indicates if the authority is a group.
isGroup() - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
isIncludeDeleted() - Method in class com.sitewhere.rest.model.search.user.UserSearchCriteria
 
isIncludeDeleted() - Method in interface com.sitewhere.spi.user.IUserSearchCriteria
Indicates whether deleted records should be returned.
isIncludeRuntimeInfo() - Method in class com.sitewhere.rest.model.search.tenant.TenantSearchCriteria
 
isIncludeRuntimeInfo() - Method in interface com.sitewhere.spi.search.user.ITenantSearchCriteria
Indicates whether runtime information should be included for the corresponding tenant engine.
ISite - Interface in com.sitewhere.spi.device
A construct that groups together related device assignments and provides common settings for them.
ISiteCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a site.
ISiteMapData - Interface in com.sitewhere.spi.device
Interface for map information associated with a Site.
ISiteMapMetadata - Interface in com.sitewhere.spi.device
Holds constants for site map metadata fields.
ISiteWhereContext - Interface in com.sitewhere.spi
Holds SiteWhere information associated with a reqeust.
ISiteWhereEntity - Interface in com.sitewhere.spi.common
Base interface for entites managed by SiteWhere.
ISiteWhereHazelcast - Interface in com.sitewhere.spi.server.hazelcast
Constants for Hazelcast services used by SiteWhere.
ISiteWhereWebConstants - Interface in com.sitewhere.rest
Interface for constants used in web operations.
isLocation() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Indicates a location event.
isMeasurements() - Method in class com.sitewhere.rest.model.device.event.scripting.DeviceEventSupport
Indicates a measurements event.
ISocketInteractionHandler<T> - Interface in com.sitewhere.spi.device.communication.socket
Interface for handling socket communication with a remote device.
ISocketInteractionHandlerFactory<T> - Interface in com.sitewhere.spi.device.communication.socket
Factory that produces ISocketInteractionHandler instances.
isProcessingEnabled() - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessorChain
Indicates whether processing is enabled.
isRemoveParentHardwareId() - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
isRemoveParentHardwareId() - Method in interface com.sitewhere.spi.device.request.IDeviceCreateRequest
Indicates whether parent reference should be removed.
isRequired() - Method in class com.sitewhere.rest.model.device.command.CommandParameter
 
isRequired() - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Parameter
 
isRequired() - Method in interface com.sitewhere.spi.device.command.ICommandParameter
Indicates if parameter is required for command.
isStaged() - Method in interface com.sitewhere.spi.server.ITenantRuntimeState
Indicates if a new configuration has been staged, but not applied.
isUpdateState() - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest
 
isUpdateState() - Method in interface com.sitewhere.spi.device.event.request.IDeviceEventCreateRequest
Indicates whether state information on the device assignment should be updated to reflect new event.
ISymbolGenerator - Interface in com.sitewhere.spi.device.symbology
Generates symbols which uniquely identify SiteWhere entities.
ISymbolGeneratorManager - Interface in com.sitewhere.spi.device.symbology
Manages a list of symbol generators.
ISystemCommand - Interface in com.sitewhere.spi.device.command
System command issued to device.
ITenant - Interface in com.sitewhere.spi.tenant
Interface for information about a tenant.
ITenantCreateRequest - Interface in com.sitewhere.spi.tenant.request
Interface for arguments needed to create a tenant.
ITenantEngineComponent - Interface in com.sitewhere.spi.server
Interface for tenant engine components.
ITenantGroup - Interface in com.sitewhere.spi.tenant
Information about a group of related tenants.
ITenantGroupCreateRequest - Interface in com.sitewhere.spi.tenant.request
Interface for arguments needed to create a tenant group.
ITenantGroupElement - Interface in com.sitewhere.spi.tenant
Information about an element in a tenant group.
ITenantGroupElementCreateRequest - Interface in com.sitewhere.spi.tenant.request
Information needed to create an element in a tenant group.
ITenantLifecycleComponent - Interface in com.sitewhere.spi.server.lifecycle
Extends ILifecycleComponent with tenant-specific functionality.
ITenantManagement - Interface in com.sitewhere.spi.tenant
Interface for tenant management operations.
ITenantRuntimeState - Interface in com.sitewhere.spi.server
Contains runtime information about a tenant engine.
ITenantSearchCriteria - Interface in com.sitewhere.spi.search.user
Search criteria for tenants.
IUser - Interface in com.sitewhere.spi.user
Interface for accessing user information.
IUserCreateRequest - Interface in com.sitewhere.spi.user.request
Interface for arguments needed to create a user.
IUserManagement - Interface in com.sitewhere.spi.user
Interface for user management operations.
IUserSearchCriteria - Interface in com.sitewhere.spi.user
Criteria used when searching for users.
IVersion - Interface in com.sitewhere.spi.system
Interface for getting version information.
IVersionChecker - Interface in com.sitewhere.spi.system
Executes version checking logic.
IZone - Interface in com.sitewhere.spi.device
A polygonal area associated with a site that can be used to trigger events.
IZoneCreateRequest - Interface in com.sitewhere.spi.device.request
Interface for arguments needed to create a zone.
IZoneMatcher - Interface in com.sitewhere.spi.geospatial
Contains results of matching a location against a list of zones.
IZoneRelationship - Interface in com.sitewhere.spi.geospatial
Represents a relationship between a location and a zone.

J

JobConstants - Interface in com.sitewhere.spi.scheduling
Metadata constants for values used by various job types.
JobConstants.BatchCommandInvocation - Interface in com.sitewhere.spi.scheduling
Constants used for batch command invocations.
JobConstants.CommandInvocation - Interface in com.sitewhere.spi.scheduling
Constants used for single command invocation.
JsonDateSerializer - Class in com.sitewhere.rest.model.datatype
Used for serializing Calendar objects for JSON output.
JsonDateSerializer() - Constructor for class com.sitewhere.rest.model.datatype.JsonDateSerializer
 

L

LifecycleComponentType - Enum in com.sitewhere.spi.server.lifecycle
Enumerates types of components in the system.
lifecycleInitialize(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Initializes the component while keeping up with lifeycle information.
lifecyclePause(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Pauses the component while keeping up with lifecycle information.
lifecycleStart(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Starts the component while keeping up with lifecycle information.
LifecycleStatus - Enum in com.sitewhere.spi.server.lifecycle
Lifecycle status for component.
lifecycleStop(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Stops the component while keeping up with lifecycle information.
lifecycleStop(ILifecycleProgressMonitor, ILifecycleConstraints) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Stops the component while keeping up with lifecycle information.
listAssetCategories(ISearchCriteria) - Method in interface com.sitewhere.spi.asset.IAssetManagement
List asset categories.
listAssets(String, ISearchCriteria) - Method in interface com.sitewhere.spi.asset.IAssetManagement
List assets in a category that meet the given criteria.
listBatchElements(String, IBatchElementSearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Lists elements for an IBatchOperation that meet the given criteria.
listBatchOperations(boolean, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List batch operations based on the given criteria.
listDeviceAlerts(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets the most recent device alert entries for an assignment.
listDeviceAlertsForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device alerts for a site.
listDeviceCommandInvocationResponses(String) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List responses associated with a command invocation.
listDeviceCommandInvocations(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets device command invocations for an assignment based on criteria.
listDeviceCommandInvocationsForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device command invocations for a site.
listDeviceCommandResponses(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets the most recent device command response entries for an assignment.
listDeviceCommandResponsesForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device command responses for a site.
listDeviceCommands(String, boolean) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List device command objects associated with a device specification.
listDeviceEvents(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List all events for the given assignment that meet the search criteria.
listDeviceGroupElements(String, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List device group elements that meet the given criteria.
listDeviceGroups(boolean, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List device groups.
listDeviceGroupsWithRole(String, boolean, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Lists all device groups that have the given role.
listDeviceLocations(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets device location entries for an assignment.
listDeviceLocations(List<String>, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device locations for the given tokens within the given time range.
listDeviceLocationsForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device locations for a site.
listDeviceMeasurements(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets device measurement entries for an assignment based on criteria.
listDeviceMeasurementsForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device measurements for a site.
listDevices(boolean, IDeviceSearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List devices that meet the given criteria.
listDeviceSpecifications(boolean, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List device specifications that match the search criteria.
listDeviceStateChanges(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Gets the most recent device state change entries for an assignment.
listDeviceStateChangesForSite(String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List device state changes for a site.
listDeviceStreamData(String, String, IDateRangeSearchCriteria) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
List all chunks of data in a device assignment that belong to a given stream and meet the criteria.
listDeviceStreams(String, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
List device streams for the assignment that meet the given criteria.
listGrantedAuthorities(IGrantedAuthoritySearchCriteria) - Method in interface com.sitewhere.spi.user.IUserManagement
List granted authorities that match the given criteria.
listModules() - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Get the list of asset modules.
listScheduledJobs(ISearchCriteria) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
List scheduled jobs that match the given criteria.
listSchedules(ISearchCriteria) - Method in interface com.sitewhere.spi.scheduling.IScheduleManagement
List schedules that match the given criteria.
listSites(ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a list of all sites.
listTenantGroupElements(String, ISearchCriteria) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
List elements in a tenant group.
listTenantGroups(ISearchCriteria) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
List tenant groups that meet the given criteria.
listTenants(ITenantSearchCriteria) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Find all tenants that match the given criteria.
listUsers() - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
List all users.
listUsers(IUserSearchCriteria) - Method in interface com.sitewhere.spi.user.IUserManagement
Get the list of all users that meet the given criteria.
listZones(String, ISearchCriteria) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Get a list of all zones associated with a Site.
Location - Class in com.sitewhere.rest.model.common
Model object for a location in 3d space.
Location() - Constructor for class com.sitewhere.rest.model.common.Location
 
Location(Double, Double) - Constructor for class com.sitewhere.rest.model.common.Location
 
LocationAsset - Class in com.sitewhere.rest.model.asset
Default implementation of ILocationAsset.
LocationAsset() - Constructor for class com.sitewhere.rest.model.asset.LocationAsset
 
LocationAssetCreateRequest - Class in com.sitewhere.rest.model.asset.request
REST model implementation of ILocationAssetCreateRequest.
LocationAssetCreateRequest() - Constructor for class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest
 
LocationAssetCreateRequest.Builder - Class in com.sitewhere.rest.model.asset.request
 
logState() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Logs the state of this component and all nested components.

M

makeComposite() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
makeGroup(boolean) - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest.Builder
 
MAP_CENTER_LATITUDE - Static variable in interface com.sitewhere.spi.device.ISiteMapMetadata
Latitude value for initial map position
MAP_CENTER_LONGITUDE - Static variable in interface com.sitewhere.spi.device.ISiteMapMetadata
Longitude value for initial map position
MAP_ZOOM_LEVEL - Static variable in interface com.sitewhere.spi.device.ISiteMapMetadata
Initial zoom level
mapquestMap(double, double, int) - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
measurement(String, Double) - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest.Builder
 
MeasurementEntry - Class in com.sitewhere.rest.model.device.event
A single measurement entry associated with a measurements event.
MeasurementEntry() - Constructor for class com.sitewhere.rest.model.device.event.MeasurementEntry
 
MeasurementsProvider - Class in com.sitewhere.rest.model.device.event
Handles creating/modifying a collection of measurements.
MeasurementsProvider() - Constructor for class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
META_BATCH_OPERATION_ID - Static variable in interface com.sitewhere.spi.device.request.IBatchOperationCreateRequest
Metadata property on events that holds batch id that generated event
META_DEVICE - Static variable in interface com.sitewhere.spi.device.communication.IDeviceEventDecoder
Metadata field used to pass device into nested decoders
META_DEVICE_SPECIFICATION - Static variable in interface com.sitewhere.spi.device.communication.IDeviceEventDecoder
Metadata field used to pass device into nested decoders
META_INVOCATION_EVENT_ID - Static variable in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Metadata property on batch element that holds invocation event id
metadata(String, String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceAlertCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest.Builder
 
metadata(String, String) - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest.Builder
 
MetadataProvider - Class in com.sitewhere.rest.model.common
Holds arbitrary metadata associated with an entity.
MetadataProvider() - Constructor for class com.sitewhere.rest.model.common.MetadataProvider
 
MetadataProviderEntity - Class in com.sitewhere.rest.model.common
Metadata provider that also contains SiteWhere entity information.
MetadataProviderEntity() - Constructor for class com.sitewhere.rest.model.common.MetadataProviderEntity
 
MultiResourceCreateResponse - Class in com.sitewhere.rest.model.resource
Model implementation of IMultiResourceCreateResponse.
MultiResourceCreateResponse() - Constructor for class com.sitewhere.rest.model.resource.MultiResourceCreateResponse
 

N

newAlert(String, String) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
newAssetCategory(String, String) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
newAssignment(String, String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newCommand(String, String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newCommandInvocation(String, String) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
newDevice(String, String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newGrantedAuthority(String) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Create builder for new granted authority request.
newGroup(String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newGroupElement(String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newHardwareAsset(String, String, String) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
newInstance() - Method in interface com.sitewhere.spi.device.communication.socket.ISocketInteractionHandlerFactory
Creates a new ISocketInteractionHandler instance.
newLocation(double, double) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
newLocationAsset(String, String, String) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
newMeasurements() - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
newPersonAsset(String, String, String) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
newSchedule(String) - Method in class com.sitewhere.rest.model.scheduling.request.scripting.ScheduleManagementRequestBuilder
 
newSchedule(String, String) - Method in class com.sitewhere.rest.model.scheduling.request.scripting.ScheduleManagementRequestBuilder
 
newSchema() - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest.Builder
 
newSite(String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newSpecification(String, String, String, String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
newTenant(String, String, String, String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Create builder for new tenant request.
newTenant(String, String, String, String, String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Create builder for new tenant request.
newTenantGroup(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Create builder for new tenant group request.
newTenantGroup(String, String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Create builder for new tenant group request.
newTenantGroupElement(String) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Create builder for a tenant group element.
newUser(String, String, String, String) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Create builder for new user request.
newZone(String) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 

O

on(Date) - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest.Builder
 
onAlert(IDeviceAlert) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device alert has been successfully saved.
onAlertNotFiltered(IDeviceAlert) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if alert data was not filtered.
onAssetCategoryAdded(IAssetCategory, ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Called when an asset category is added.
onAssetCategoryRemoved(IAssetCategory, ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Called when an asset category is removed.
onCommandInvocation(IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device command invocation has been successfully saved.
onCommandInvocationNotFiltered(IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if command invocation data was not filtered.
onCommandResponse(IDeviceCommandResponse) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device command response has been successfully saved.
onCommandResponseNotFiltered(IDeviceCommandResponse) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if command response data was not filtered.
onDeviceAlertCreateRequest(String, String, IDeviceAlertCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceAlert based on the given information.
onDeviceCommandResponseRequest(String, String, IDeviceCommandResponseCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called when an IDeviceCommandResponseCreateRequest is received.
onDeviceLocationCreateRequest(String, String, IDeviceLocationCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceLocation based on the given information.
onDeviceMappingCreateRequest(String, String, IDeviceMappingCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request that a device be mapped to a path on a composite device.
onDeviceMeasurementsCreateRequest(String, String, IDeviceMeasurementsCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceMeasurements based on the given information.
onDeviceStateChangeCreateRequest(String, String, IDeviceStateChangeCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceStateChange based on the given information.
onDeviceStreamCreateRequest(String, String, IDeviceStreamCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceStream based on the given information.
onDeviceStreamDataCreateRequest(String, String, IDeviceStreamDataCreateRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request the creation of a new IDeviceStreamData based on the given information.
onEncodedEventReceived(IInboundEventReceiver<T>, T, Map<String, Object>) - Method in interface com.sitewhere.spi.device.communication.IInboundEventSource
Called by IInboundEventReceiver when an encoded event is received.
onEntryAdded(T) - Method in interface com.sitewhere.spi.cache.ICacheListener
Called when a cache entry is added.
onEntryRemoved(T) - Method in interface com.sitewhere.spi.cache.ICacheListener
Called when a cache entry is removed.
onEntryUpdated(T) - Method in interface com.sitewhere.spi.cache.ICacheListener
Called when a cache entry is updated.
onEventPayloadReceived(T, Map<String, Object>) - Method in interface com.sitewhere.spi.device.communication.IInboundEventReceiver
Called when an event payload is received.
onLocation(IDeviceLocation) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device location has been successfully saved.
onLocationNotFiltered(IDeviceLocation) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if location data was not filtered.
onMeasurements(IDeviceMeasurements) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device measurements have been successfully saved.
onMeasurementsNotFiltered(IDeviceMeasurements) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if measurements data was not filtered.
onRegistrationRequest(String, String, IDeviceRegistrationRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called when a IDeviceRegistrationRequest is received.
onSendDeviceStreamDataRequest(String, String, ISendDeviceStreamDataRequest) - Method in interface com.sitewhere.spi.device.event.processor.IInboundEventProcessor
Called to request that a chunk of IDeviceStreamData be sent to a device.
onStateChange(IDeviceStateChange) - Method in interface com.sitewhere.spi.device.event.processor.IOutboundEventProcessor
Executes code after device state change has been successfully saved.
onStateChangeNotFiltered(IDeviceStateChange) - Method in interface com.sitewhere.spi.device.event.processor.IFilteredOutboundEventProcessor
Called if state change data was not filtered.
openStreetMap(double, double, int) - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest.Builder
 
OperationType - Enum in com.sitewhere.spi.device.batch
Indicates the type of operation being performed in an IBatchOperation.

P

Pager<T> - Class in com.sitewhere.rest.model.search
Encapsulates paging functionality.
Pager(ISearchCriteria) - Constructor for class com.sitewhere.rest.model.search.Pager
 
PARAM_COMMAND_TOKEN - Static variable in interface com.sitewhere.spi.device.request.IBatchCommandInvocationRequest
Batch operation parameter name for command token
Parameter() - Constructor for class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Parameter
 
PARAMETER_PREFIX - Static variable in interface com.sitewhere.spi.scheduling.JobConstants.CommandInvocation
Prefix for command parameter values
ParameterType - Enum in com.sitewhere.spi.device.command
Indicates parameter datatype.
parameterValue(String, String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest.Builder
 
pause(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
Pause the component.
persist(AssetCategoryCreateRequest.Builder) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
persist(String, HardwareAssetCreateRequest.Builder) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
persist(String, LocationAssetCreateRequest.Builder) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
persist(String, PersonAssetCreateRequest.Builder) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
persist(DeviceLocationCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
persist(DeviceMeasurementsCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
persist(DeviceAlertCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
persist(DeviceCommandInvocationCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
persist(SiteCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(ISite, ZoneCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(DeviceSpecificationCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(IDeviceSpecification, DeviceCommandCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(DeviceCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(DeviceAssignmentCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(DeviceGroupCreateRequest.Builder) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(IDeviceGroup, List<DeviceGroupElementCreateRequest.Builder>) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
persist(ScheduleCreateRequest.Builder) - Method in class com.sitewhere.rest.model.scheduling.request.scripting.ScheduleManagementRequestBuilder
 
persist(TenantCreateRequest.Builder) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Persist tenant contructed via builder.
persist(TenantGroupCreateRequest.Builder) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Persist tenant group contructed via builder.
persist(ITenantGroup, List<TenantGroupElementCreateRequest.Builder>) - Method in class com.sitewhere.rest.model.tenant.request.scripting.TenantManagementRequestBuilder
Add elements to a tenant group.
persist(UserCreateRequest.Builder) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Persist user contructed via builder.
persist(GrantedAuthorityCreateRequest.Builder) - Method in class com.sitewhere.rest.model.user.request.UserManagementRequestBuilder
Persist granted authority constructed via builder.
PersonAsset - Class in com.sitewhere.rest.model.asset
Model class for a person asset.
PersonAsset() - Constructor for class com.sitewhere.rest.model.asset.PersonAsset
 
PersonAssetCreateRequest - Class in com.sitewhere.rest.model.asset.request
REST model implementation of IPersonAssetCreateRequest.
PersonAssetCreateRequest() - Constructor for class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest
 
PersonAssetCreateRequest.Builder - Class in com.sitewhere.rest.model.asset.request
 
PREAUTH_REST_AND_TENANT_ADMIN - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
User has REST permissions and tenant administration rights
PREAUTH_REST_AND_USER_ADMIN - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
User has REST permissions and user administration rights
PresenceState - Enum in com.sitewhere.spi.device.event.state
Enumerates possible system presence states.
process(T) - Method in class com.sitewhere.rest.model.search.Pager
Process a record.
process(IBatchOperation) - Method in interface com.sitewhere.spi.device.batch.IBatchOperationManager
Processes an IBatchOperation.
process(Socket, IInboundEventReceiver<T>) - Method in interface com.sitewhere.spi.device.communication.socket.ISocketInteractionHandler
Delegates processing of socket information.
processCreateDeviceMapping(IDecodedDeviceRequest<IDeviceMappingCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceAlert(IDecodedDeviceRequest<IDeviceAlertCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceCommandResponse(IDecodedDeviceRequest<IDeviceCommandResponseCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceLocation(IDecodedDeviceRequest<IDeviceLocationCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceMeasurements(IDecodedDeviceRequest<IDeviceMeasurementsCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceStateChange(IDecodedDeviceRequest<IDeviceStateChangeCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceStream(IDecodedDeviceRequest<IDeviceStreamCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processDeviceStreamData(IDecodedDeviceRequest<IDeviceStreamDataCreateRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processRegistration(IDecodedDeviceRequest<IDeviceRegistrationRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
processSendDeviceStreamData(IDecodedDeviceRequest<ISendDeviceStreamDataRequest>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
ProgressMessage - Class in com.sitewhere.rest.model.monitoring
Contains progress information provided by an ILifecycleProgressMonitor.
ProgressMessage() - Constructor for class com.sitewhere.rest.model.monitoring.ProgressMessage
 
ProgressMessage(String, int, int, String) - Constructor for class com.sitewhere.rest.model.monitoring.ProgressMessage
 
put(K, V) - Method in interface com.sitewhere.spi.cache.ICache
Add or replace value for the given key.
putAsset(String, T) - Method in interface com.sitewhere.spi.asset.IAssetModule
Create or update an asset.

Q

QUEUE_ALL_EVENTS - Static variable in interface com.sitewhere.spi.server.hazelcast.ISiteWhereHazelcast
Queue name for all SiteWhere events

R

refresh(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.asset.IAssetModule
Refresh any cached data in the module.
refreshModules(ILifecycleProgressMonitor) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Calls the refresh method on all asset modules.
RegistrationAckCommand - Class in com.sitewhere.rest.model.device.command
Default implementation of IRegistrationAckCommand.
RegistrationAckCommand() - Constructor for class com.sitewhere.rest.model.device.command.RegistrationAckCommand
 
RegistrationFailureCommand - Class in com.sitewhere.rest.model.device.command
Default implementation of IRegistrationFailureCommand.
RegistrationFailureCommand() - Constructor for class com.sitewhere.rest.model.device.command.RegistrationFailureCommand
 
RegistrationFailureReason - Enum in com.sitewhere.spi.device.command
Enumerates reasons device registration can fail.
RegistrationState - Enum in com.sitewhere.spi.device.event.state
Enumerates possible system registration states.
RegistrationSuccessReason - Enum in com.sitewhere.spi.device.command
Enumerates reasons registration was successful.
remove(K) - Method in interface com.sitewhere.spi.cache.ICache
Remove an element from the cache.
removeAsset(String) - Method in interface com.sitewhere.spi.asset.IAssetModule
Remove an existing asset.
removeDeviceGroupElements(String, List<IDeviceGroupElementCreateRequest>) - Method in interface com.sitewhere.spi.device.IDeviceManagement
Remove selected elements from a device group.
removeGrantedAuthorities(String, List<String>) - Method in interface com.sitewhere.spi.user.IUserManagement
Remove user authorities.
removeMeasurement(String) - Method in class com.sitewhere.rest.model.device.asset.DeviceMeasurementsWithAsset
 
removeMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.DeviceMeasurements
 
removeMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.MeasurementsProvider
 
removeMeasurement(String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceMeasurementsCreateRequest
 
removeMeasurement(String) - Method in interface com.sitewhere.spi.device.event.IMeasurementsProvider
Remove a measurement.
removeMetadata(String) - Method in class com.sitewhere.rest.model.common.MetadataProvider
 
removeMetadata(String) - Method in class com.sitewhere.rest.model.device.asset.DeviceEventWithAsset
 
removeMetadata(String) - Method in interface com.sitewhere.spi.common.IMetadataProvider
Remove a metadata field.
removeTenantGroupElements(String, List<ITenantGroupElementCreateRequest>) - Method in interface com.sitewhere.spi.tenant.ITenantManagement
Remove elements from a tenant group.
REPEAT_COUNT - Static variable in interface com.sitewhere.spi.scheduling.TriggerConstants.SimpleTrigger
Number of times trigger should repeat
REPEAT_INTERVAL - Static variable in interface com.sitewhere.spi.scheduling.TriggerConstants.SimpleTrigger
Interval (in milliseconds) trigger should repeat
reportProgress(IProgressMessage) - Method in interface com.sitewhere.spi.monitoring.IProgressReporter
Report progress for an operation.
REQUEST_TENANT_TOKEN - Static variable in interface com.sitewhere.rest.ISiteWhereWebConstants
Request parameter name for passing tenant authentication token
resolveTargets(IDeviceCommandInvocation) - Method in interface com.sitewhere.spi.device.communication.ICommandTargetResolver
Resolves a command invocation to a list of assignments that should receive the command.
Resource - Class in com.sitewhere.rest.model.resource
Model implementation of IResource.
Resource() - Constructor for class com.sitewhere.rest.model.resource.Resource
 
ResourceCreateError - Class in com.sitewhere.rest.model.resource
Model implementation for IResourceCreateError.
ResourceCreateError() - Constructor for class com.sitewhere.rest.model.resource.ResourceCreateError
 
ResourceCreateFailReason - Enum in com.sitewhere.spi.resource
Enumeration of reasons for resource creation failures.
ResourceCreateMode - Enum in com.sitewhere.spi.resource
Creation mode for
ResourceCreateRequest - Class in com.sitewhere.rest.model.resource.request
Model implementation for IResourceCreateRequest.
ResourceCreateRequest() - Constructor for class com.sitewhere.rest.model.resource.request.ResourceCreateRequest
 
ResourceCreateRequest.Builder - Class in com.sitewhere.rest.model.resource.request
 
ResourceExistsException - Exception in com.sitewhere.spi.error
Indicates that a "create" operation resulted in a duplicate key.
ResourceExistsException(ErrorCode) - Constructor for exception com.sitewhere.spi.error.ResourceExistsException
 
ResourceType - Enum in com.sitewhere.spi.resource
Indicates type of resource.
Response() - Constructor for class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Response
 
REST - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Role for access to REST services
ROLE_PREFIX - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
Prefix for Spring Security roles
routeCommand(IDeviceCommandExecution, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.IOutboundCommandRouter
Route a command to one of the available destinations.
routeSystemCommand(ISystemCommand, IDeviceNestingContext, IDeviceAssignment) - Method in interface com.sitewhere.spi.device.communication.IOutboundCommandRouter
Route a system command to one of the available destinations.

S

Schedule - Class in com.sitewhere.rest.model.scheduling
Model object for a schedule.
Schedule() - Constructor for class com.sitewhere.rest.model.scheduling.Schedule
 
scheduleAdded(ISchedule) - Method in interface com.sitewhere.spi.scheduling.IScheduleManager
Called when a new schedule has been added.
ScheduleCreateRequest - Class in com.sitewhere.rest.model.scheduling.request
Holds fields needed to create a new schedule.
ScheduleCreateRequest() - Constructor for class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
ScheduleCreateRequest.Builder - Class in com.sitewhere.rest.model.scheduling.request
 
ScheduledJob - Class in com.sitewhere.rest.model.scheduling
Model object for a scheduled job.
ScheduledJob() - Constructor for class com.sitewhere.rest.model.scheduling.ScheduledJob
 
ScheduledJobCreateRequest - Class in com.sitewhere.rest.model.scheduling.request
Holds fields needed to create a new scheduled job.
ScheduledJobCreateRequest() - Constructor for class com.sitewhere.rest.model.scheduling.request.ScheduledJobCreateRequest
 
ScheduledJobState - Enum in com.sitewhere.spi.scheduling
Indicates state of a scheduled job.
ScheduledJobType - Enum in com.sitewhere.spi.scheduling
Types of jobs that may be scheduled.
scheduleJob(IScheduledJob) - Method in interface com.sitewhere.spi.scheduling.IScheduleManager
Adds a job to the scheduler.
ScheduleManagementRequestBuilder - Class in com.sitewhere.rest.model.scheduling.request.scripting
Builder that supports creating schedule management entities.
ScheduleManagementRequestBuilder(IScheduleManagement) - Constructor for class com.sitewhere.rest.model.scheduling.request.scripting.ScheduleManagementRequestBuilder
 
scheduleRemoved(ISchedule) - Method in interface com.sitewhere.spi.scheduling.IScheduleManager
Called when a schedule is removed.
SCRIPTS_FOLDER - Static variable in interface com.sitewhere.spi.configuration.IDefaultResourcePaths
Folder containing tenant script resources
search(String) - Method in interface com.sitewhere.spi.asset.IAssetModule
Search for all assets of a given type that meet the criteria.
search(String, String) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Search an asset module for assets matching the given criteria.
SearchCriteria - Class in com.sitewhere.rest.model.search
Common criteria used in searches that return a list of results.
SearchCriteria(int, int) - Constructor for class com.sitewhere.rest.model.search.SearchCriteria
 
SearchProvider - Class in com.sitewhere.rest.model.search.external
Implementation of ISearchProvider used for marshaling.
SearchProvider() - Constructor for class com.sitewhere.rest.model.search.external.SearchProvider
 
SearchResults<T> - Class in com.sitewhere.rest.model.search
Used to return search result metadata in response to AJAX calls.
SearchResults(List<T>) - Constructor for class com.sitewhere.rest.model.search.SearchResults
 
SearchResults(List<T>, long) - Constructor for class com.sitewhere.rest.model.search.SearchResults
 
sendCommand(String, String, Map<String, String>) - Method in interface com.sitewhere.spi.device.IDeviceActions
Send command to a device.
SendDeviceStreamDataCommand - Class in com.sitewhere.rest.model.device.command
System command that sends a chunk of device stream data to a device.
SendDeviceStreamDataCommand() - Constructor for class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
SendDeviceStreamDataRequest - Class in com.sitewhere.rest.model.device.event.request
Implementation of ISendDeviceStreamDataRequest.
SendDeviceStreamDataRequest() - Constructor for class com.sitewhere.rest.model.device.event.request.SendDeviceStreamDataRequest
 
sendToInboundProcessingChain(IDecodedDeviceRequest<?>) - Method in interface com.sitewhere.spi.device.communication.IInboundProcessingStrategy
Sends a decoded request to the inbound processing chain.
serialize(Date, JsonGenerator, SerializerProvider) - Method in class com.sitewhere.rest.model.datatype.JsonDateSerializer
 
serialize(Date) - Static method in class com.sitewhere.rest.model.datatype.JsonDateSerializer
Serialize a date in ISO 8601 format.
ServerStartupException - Exception in com.sitewhere.spi
Exception on server startup that will prevent server from functioning.
ServerStartupException(ILifecycleComponent, String) - Constructor for exception com.sitewhere.spi.ServerStartupException
 
setActiveDate(Date) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAlerts(List<DeviceAlertCreateRequest>) - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
setAsHtml(String) - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
setAsset(HardwareAsset) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setAssetCategoryId(String) - Method in class com.sitewhere.rest.model.asset.Asset
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.Device
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
setAssetId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
setAssetImageUrl(String) - Method in class com.sitewhere.rest.model.device.Device
 
setAssetImageUrl(String) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssetImageUrl(String) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setAssetManagement(IAssetManagement) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
setAssetManagement(IAssetManagement) - Method in interface com.sitewhere.spi.asset.IAssetModuleManager
Set asset management implementation.
setAssetModuleId(String) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssetModuleId(String) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setAssetModuleId(String) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setAssetModuleId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
setAssetModuleId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
setAssetModuleManager(IAssetModuleManager) - Method in class com.sitewhere.rest.model.asset.request.scripting.AssetManagementRequestBuilder
 
setAssetName(String) - Method in class com.sitewhere.rest.model.device.Device
 
setAssetName(String) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssetName(String) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setAssetType(AssetType) - Method in class com.sitewhere.rest.model.asset.AssetCategory
 
setAssetType(AssetType) - Method in class com.sitewhere.rest.model.asset.AssetModule
 
setAssetType(AssetType) - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
setAssignment(DeviceAssignment) - Method in class com.sitewhere.rest.model.device.Device
 
setAssignmentToken(String) - Method in class com.sitewhere.rest.model.device.Device
 
setAssignmentToken(String) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder.AssignmentScope
 
setAssignmentToken(String) - Method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
setAssignmentType(DeviceAssignmentType) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssignmentType(DeviceAssignmentType) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setAssignmentType(DeviceAssignmentType) - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
setAssociatedHardware(HardwareAsset) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssociatedLocation(LocationAsset) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAssociatedPerson(PersonAsset) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setAuthenticationToken(String) - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
setAuthenticationToken(String) - Method in class com.sitewhere.rest.model.tenant.Tenant
 
setAuthorities(List<String>) - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
setAuthorities(List<String>) - Method in class com.sitewhere.rest.model.user.User
 
setAuthority(String) - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
setAuthority(String) - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
setAuthorizedUserIds(List<String>) - Method in class com.sitewhere.rest.model.tenant.request.TenantCreateRequest
 
setAuthorizedUserIds(List<String>) - Method in class com.sitewhere.rest.model.tenant.Tenant
 
setBatchOperationToken(String) - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
setBorderColor(String) - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
setBorderColor(String) - Method in class com.sitewhere.rest.model.device.Zone
 
setBuildTimestamp(String) - Method in class com.sitewhere.rest.model.system.Version
 
setCacheProvider(IAssetManagementCacheProvider) - Method in interface com.sitewhere.spi.asset.ICachingAssetManagement
Set the cache provider to be used by the IAssetManagement implementation.
setCacheProvider(IDeviceManagementCacheProvider) - Method in interface com.sitewhere.spi.device.ICachingDeviceManagement
Set the cache provider to be used by the IDeviceManagement implementation.
setCaches(List<CacheInformation>) - Method in class com.sitewhere.rest.model.cache.CacheSummary
 
setCacheType(CacheType) - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
setCategory(StateChangeCategory) - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
setCategory(StateChangeCategory) - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
setCode(char) - Method in enum com.sitewhere.spi.device.batch.BatchOperationStatus
 
setCode(char) - Method in enum com.sitewhere.spi.device.batch.ElementProcessingStatus
 
setCode(long) - Method in enum com.sitewhere.spi.error.ErrorCode
 
setCode(ErrorCode) - Method in exception com.sitewhere.spi.error.ResourceExistsException
 
setCode(ErrorCode) - Method in exception com.sitewhere.spi.SiteWhereSystemException
Set the error code.
setCommand(IDeviceCommand) - Method in class com.sitewhere.rest.model.device.command.DeviceCommandExecution
 
setCommand(DeviceCommand) - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
setCommands(List<IDeviceCommand>) - Method in class com.sitewhere.rest.model.device.command.DeviceCommandNamespace
 
setCommandToken(String) - Method in class com.sitewhere.rest.model.device.event.DeviceCommandInvocation
 
setCommandToken(String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceCommandInvocationCreateRequest
 
setCommandToken(String) - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
setCommandToken(String) - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
setComments(String) - Method in class com.sitewhere.rest.model.device.Device
 
setComments(String) - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
setComponent(ILifecycleComponent) - Method in exception com.sitewhere.spi.ServerStartupException
 
setCompositeDeviceHardwareId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceMappingCreateRequest
 
setContainerPolicy(DeviceContainerPolicy) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setContainerPolicy(DeviceContainerPolicy) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
setContent(byte[]) - Method in class com.sitewhere.rest.model.resource.request.ResourceCreateRequest
 
setContent(byte[]) - Method in class com.sitewhere.rest.model.resource.Resource
 
setContentType(String) - Method in class com.sitewhere.rest.model.device.request.DeviceStreamCreateRequest
 
setContentType(String) - Method in class com.sitewhere.rest.model.device.streaming.DeviceStream
 
setContext(Map<String, Object>) - Method in class com.sitewhere.rest.model.scheduling.ScheduledJob
 
setCoordinates(List<Location>) - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
setCoordinates(List<Location>) - Method in class com.sitewhere.rest.model.device.Zone
 
setCreatedAlerts(List<DeviceAlert>) - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
setCreatedBy(String) - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
setCreatedDate(Date) - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
setCreatedLocations(List<DeviceLocation>) - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
setCreatedMeasurements(List<DeviceMeasurements>) - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatchResponse
 
setCreatedResources(List<IResource>) - Method in class com.sitewhere.rest.model.resource.MultiResourceCreateResponse
 
setCurrentOperation(int) - Method in class com.sitewhere.rest.model.monitoring.ProgressMessage
 
setData(byte[]) - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
setData(Map<String, String>) - Method in class com.sitewhere.rest.model.device.event.DeviceStateChange
 
setData(byte[]) - Method in class com.sitewhere.rest.model.device.event.DeviceStreamData
 
setData(Map<String, String>) - Method in class com.sitewhere.rest.model.device.event.request.DeviceStateChangeCreateRequest
 
setData(byte[]) - Method in class com.sitewhere.rest.model.device.event.request.DeviceStreamDataCreateRequest
 
setDate(Date) - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Response
 
setDeleted(boolean) - Method in class com.sitewhere.rest.model.common.MetadataProviderEntity
 
setDescription(String) - Method in class com.sitewhere.rest.model.asset.HardwareAsset
 
setDescription(String) - Method in class com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.command.DeviceCommand
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.event.view.DeviceCommandInvocationSummary.Response
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.group.DeviceGroup
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.request.DeviceGroupCreateRequest
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.request.SiteCreateRequest
 
setDescription(String) - Method in class com.sitewhere.rest.model.device.Site
 
setDescription(String) - Method in class com.sitewhere.rest.model.tenant.request.TenantGroupCreateRequest
 
setDescription(String) - Method in class com.sitewhere.rest.model.tenant.TenantGroup
 
setDescription(String) - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
setDescription(String) - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
setDescription(String) - Method in enum com.sitewhere.spi.device.batch.OperationType
 
setDescription(String) - Method in exception com.sitewhere.spi.ServerStartupException
 
setDescription(String) - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
setDevice(Device) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setDevice(IDevice) - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
setDevice(Device) - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
setDeviceAlerts(List<IDeviceAlert>) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceAssignment(IDeviceAssignment) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceAssignmentToken(String) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setDeviceAssignmentToken(String) - Method in class com.sitewhere.rest.model.device.support.InterpolatedAssignmentHistory
 
setDeviceCommandInvocations(List<IDeviceCommandInvocation>) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceCommandResponses(List<IDeviceCommandResponse>) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceElementMappings(List<DeviceElementMapping>) - Method in class com.sitewhere.rest.model.device.Device
 
setDeviceElementMappings(List<DeviceElementMapping>) - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
setDeviceElementSchema(DeviceElementSchema) - Method in class com.sitewhere.rest.model.device.DeviceSpecification
 
setDeviceElementSchema(DeviceElementSchema) - Method in class com.sitewhere.rest.model.device.request.DeviceSpecificationCreateRequest
 
setDeviceElementSchemaPath(String) - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
setDeviceEventDecoder(IDeviceEventDecoder<T>) - Method in interface com.sitewhere.spi.device.communication.IInboundEventSource
Set the device event decoder.
setDeviceGroup(DeviceGroup) - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
setDeviceHardwareId(String) - Method in class com.sitewhere.rest.model.device.DeviceAssignment
 
setDeviceHardwareId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceAssignmentCreateRequest
 
setDeviceLocations(List<IDeviceLocation>) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceManagement(IDeviceManagement) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
setDeviceManagement(IDeviceManagement) - Method in class com.sitewhere.rest.model.device.request.scripting.DeviceManagementRequestBuilder
 
setDeviceManagement(IDeviceManagement) - Method in interface com.sitewhere.spi.device.event.IDeviceEventManagement
Set the device management implementation.
setDeviceMeasurements(List<IDeviceMeasurements>) - Method in class com.sitewhere.rest.model.SiteWhereContext
 
setDeviceSlots(List<DeviceSlot>) - Method in class com.sitewhere.rest.model.device.element.DeviceUnit
 
setDeviceUnits(List<DeviceUnit>) - Method in class com.sitewhere.rest.model.device.element.DeviceUnit
 
setEdition(String) - Method in class com.sitewhere.rest.model.system.Version
 
setEditionIdentifier(String) - Method in class com.sitewhere.rest.model.system.Version
 
setElementCount(long) - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
setElementId(String) - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
setElementId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceGroupElementCreateRequest
 
setElevation(Double) - Method in class com.sitewhere.rest.model.asset.LocationAsset
 
setElevation(Double) - Method in class com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest
 
setElevation(Double) - Method in class com.sitewhere.rest.model.common.Location
 
setElevation(Double) - Method in class com.sitewhere.rest.model.device.event.DeviceLocation
 
setElevation(Double) - Method in class com.sitewhere.rest.model.device.event.request.DeviceLocationCreateRequest
 
setEmailAddress(String) - Method in class com.sitewhere.rest.model.asset.PersonAsset
 
setEmailAddress(String) - Method in class com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest
 
setEndDate(Date) - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
setEndDate(Date) - Method in class com.sitewhere.rest.model.scheduling.request.ScheduleCreateRequest
 
setEndDate(Date) - Method in class com.sitewhere.rest.model.scheduling.Schedule
 
setEngineState(ITenantRuntimeState) - Method in class com.sitewhere.rest.model.tenant.Tenant
 
setEntries(List<IChartEntry<T>>) - Method in class com.sitewhere.rest.model.device.charting.ChartSeries
 
setErrorMessage(String) - Method in class com.sitewhere.rest.model.device.command.RegistrationFailureCommand
 
setErrors(List<IResourceCreateError>) - Method in class com.sitewhere.rest.model.resource.MultiResourceCreateResponse
 
setEventDate(Date) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setEventDate(Date) - Method in class com.sitewhere.rest.model.device.event.request.DeviceEventCreateRequest
 
setEventId(String) - Method in class com.sitewhere.rest.model.device.event.DeviceEventOriginator
 
setEventManagement(IDeviceEventManagement) - Method in class com.sitewhere.rest.model.device.event.request.scripting.DeviceEventRequestBuilder
 
setEventSource(IInboundEventSource<T>) - Method in interface com.sitewhere.spi.device.communication.IInboundEventReceiver
Set the parent event source that will process events.
setEventType(DeviceEventType) - Method in class com.sitewhere.rest.model.device.event.DeviceEvent
 
setExcludeAssigned(boolean) - Method in class com.sitewhere.rest.model.search.device.DeviceSearchCriteria
 
setFillColor(String) - Method in class com.sitewhere.rest.model.device.request.ZoneCreateRequest
 
setFillColor(String) - Method in class com.sitewhere.rest.model.device.Zone
 
setFirstName(String) - Method in class com.sitewhere.rest.model.user.request.UserCreateRequest
 
setFirstName(String) - Method in class com.sitewhere.rest.model.user.User
 
setGroup(boolean) - Method in class com.sitewhere.rest.model.user.GrantedAuthority
 
setGroup(boolean) - Method in class com.sitewhere.rest.model.user.request.GrantedAuthorityCreateRequest
 
setGroup(boolean) - Method in enum com.sitewhere.spi.user.SiteWhereAuthority
 
setGroupsWithRole(String) - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
setGroupToken(String) - Method in class com.sitewhere.rest.model.device.group.DeviceGroupElement
 
setGroupToken(String) - Method in class com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.batch.BatchElement
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.command.SendDeviceStreamDataCommand
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.communication.DecodedDeviceRequest
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.communication.DeviceRequest
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.Device
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.event.DeviceEventBatch
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.event.request.DeviceRegistrationRequest
 
setHardwareId(String) - Method in class com.sitewhere.rest.model.device.request.DeviceCreateRequest
 
setHardwareIds(List<String>) - Method in class com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest
 
setHardwareIds(List<String>) - Method in class com.sitewhere.rest.model.device.request.BatchOperationCreateRequest
 
setHashedPassword(String) - Method in class com.sitewhere.rest.model.user.User
 
setHitCount(long) - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
setHitRatio(double) - Method in class com.sitewhere.rest.model.cache.CacheInformation
 
setHostname(String) - Method in interface com.sitewhere.spi.common.IInternetConnected
Set hostname to connect to.
setHttpResponseCode(int) - Method in exception com.sitewhere.spi.SiteWhereSystemException
Set HTTP response code.
setId(String) - Method in class com.sitewhere.rest.model.asset.Asset
 
setId(String) - Method in class com.sitewhere.rest.model.asset.AssetCategory
 
setId(String) - Method in class com.sitewhere.rest.model.asset.AssetModule
 
setId(String) - Method in class com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest
 
set