- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getDeviceCommandResponses() - Method in class com.sitewhere.rest.model.SiteWhereContext
-
- getDeviceCommandResponses() - Method in interface com.sitewhere.spi.ISiteWhereContext
-
- getDeviceElementByPath(IDeviceSpecification, String) - Static method in class com.sitewhere.spi.device.util.DeviceSpecificationUtils
-
- 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
-
- 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
-
- getDeviceElementSchemaPath() - Method in class com.sitewhere.rest.model.device.DeviceElementMapping
-
- getDeviceElementSchemaPath() - Method in interface com.sitewhere.spi.device.IDeviceElementMapping
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getLifecycleComponents() - Method in interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent
-
- 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
-
- getOriginatingEventId() - Method in interface com.sitewhere.spi.device.event.request.IDeviceCommandResponseCreateRequest
-
- 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
-
- 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
- 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
-
- 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
-
- 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
-
- IBatchOperationManager - Interface in com.sitewhere.spi.device.batch
-
Interface for interacting with a batch operation manager.
- IBatchOperationUpdateRequest - Interface in com.sitewhere.spi.device.request
-
- 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
-
- 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
-
- ICommandParameter - Interface in com.sitewhere.spi.device.command
-
- 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
-
- 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
-
- 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
-
- IDeviceElementMapping - Interface in com.sitewhere.spi.device
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- IOutboundProcessingStrategy - Interface in com.sitewhere.spi.device.communication
-
- IPersonAsset - Interface in com.sitewhere.spi.asset
-
Interface for an asset that is a person.
- IPersonAssetCreateRequest - Interface in com.sitewhere.spi.asset.request
-
- 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
-
- 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
-
- 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.
- valueOf(String) - Static method in enum com.sitewhere.rest.model.device.communication.DeviceRequest.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.asset.AssetType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.cache.CacheType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.command.CommandResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.batch.BatchOperationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.batch.ElementProcessingStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.batch.OperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.DeviceMappingResult
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.DeviceStreamStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.ParameterType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.RegistrationFailureReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.RegistrationSuccessReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.command.SystemCommandType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.DeviceAssignmentStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.DeviceAssignmentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.DeviceContainerPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.DeviceStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.AlertLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.AlertSource
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.CommandInitiator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.CommandStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.CommandTarget
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.DeviceEventType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.state.PresenceState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.state.RegistrationState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.state.StateChangeCategory
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.event.state.StateChangeType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.device.group.GroupElementType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.error.ErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.error.ErrorLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.geospatial.ZoneContainment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.resource.ResourceCreateFailReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.resource.ResourceCreateMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.resource.ResourceType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.scheduling.ScheduledJobState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.scheduling.ScheduledJobType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.scheduling.TriggerType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.server.lifecycle.LifecycleComponentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.server.lifecycle.LifecycleStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.user.AccountStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sitewhere.spi.user.SiteWhereAuthority
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.sitewhere.rest.model.device.communication.DeviceRequest.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.asset.AssetType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.cache.CacheType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.command.CommandResult
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.batch.BatchOperationStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.batch.ElementProcessingStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.batch.OperationType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.DeviceMappingResult
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.DeviceStreamStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.ParameterType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.RegistrationFailureReason
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.RegistrationSuccessReason
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.command.SystemCommandType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.DeviceAssignmentStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.DeviceAssignmentType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.DeviceContainerPolicy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.DeviceStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.AlertLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.AlertSource
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.CommandInitiator
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.CommandStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.CommandTarget
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.DeviceEventType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.state.PresenceState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.state.RegistrationState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.state.StateChangeCategory
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.event.state.StateChangeType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.device.group.GroupElementType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.error.ErrorCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.error.ErrorLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.geospatial.ZoneContainment
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.resource.ResourceCreateFailReason
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.resource.ResourceCreateMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.resource.ResourceType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.scheduling.ScheduledJobState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.scheduling.ScheduledJobType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.scheduling.TriggerType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.server.lifecycle.LifecycleComponentType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.server.lifecycle.LifecycleStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.user.AccountStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.sitewhere.spi.user.SiteWhereAuthority
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- Version - Class in com.sitewhere.rest.model.system
-
Model object used to read version information from REST call.
- Version() - Constructor for class com.sitewhere.rest.model.system.Version
-
- VIEW_SERVER_INFO - Static variable in interface com.sitewhere.spi.user.SiteWhereRoles
-
Role for viewing server information