public interface DeviceContext<C extends ServerContext> extends ServerContext<C>
| Modifier and Type | Method and Description |
|---|---|
void |
asyncVariableUpdate(java.lang.String variable,
DataTable value)
Should be called by the device driver once new setting's value was asynchronously received from the hardware.
|
EventDefinition |
discoverDeviceEvent(java.lang.String name,
int timeout,
java.lang.Object helper)
Forces the device driver to discover a new event and adds it to context if found.
|
FunctionDefinition |
discoverDeviceFunction(java.lang.String name,
int timeout,
java.lang.Object helper)
Forces the device driver to discover a new function and adds it to context if found.
|
VariableDefinition |
discoverDeviceVariable(java.lang.String name,
int timeout,
java.lang.Object helper)
Forces the device driver to discover a new variable and adds it to context if found.
|
SynchronizationResult |
executeSynchronization(SynchronizationParameters parameters)
Executes a synchronous synchronization using provided parameters.
|
java.lang.String |
getAddress()
This method returns string representation of device address or null if device has no address.
|
java.util.List<DeviceAssetDefinition> |
getAssets()
This method returns the list of device assets.
|
CallerController |
getCallerController()
Returns caller controller with effective permissions of the user owning this device account.
|
DeviceDriver |
getDriver()
Returns device driver used by this device account.
|
DeviceSettingStatus |
getSettingStatus(java.lang.String variable)
Returns synchronization status of a device setting variable.
|
java.util.concurrent.locks.ReentrantLock |
getSynchronizationLock()
Returns synchronization lock.
|
SettingSynchronizationOptions |
getSynchronizationOptions(java.lang.String variable)
Returns synchronization options of a device setting variable.
|
boolean |
isOnline()
Returns device online status.
|
void |
processHistoricalValue(java.lang.String variable,
java.util.Date timestamp,
DataTable value)
Should be called by the device driver once a new historical value of a device setting was received from hardware.
|
void |
removeCustomSynchronizationHandler(java.lang.String variable)
Removes custom synchronization handler of a device setting variable.
|
void |
requestAssetsUpdate()
Should be called by the driver to force re-reading of device assets during next synchronization.
|
void |
requestReconnection()
Should be called by device driver to request reconnection to the hardware in the beginning of the next synchronization cycle.
|
void |
requestSynchronization()
Should be called by the device driver to request full synchronization.
|
void |
requestSynchronization(boolean useExtendedStatus)
Same as
requestSynchronization(), but allows to temporarily enable extended connection status. |
void |
requestSynchronization(SynchronizationParameters parameters)
Same as
requestSynchronization(), but allows to specify custom synchronization options. |
void |
setAccessSettingReinitializer(java.lang.String variable,
AccessSettingReinizializer reinitializer)
Sets an access setting reinitializer in the device context.
|
void |
setCustomSynchronizationHandler(java.lang.String variable,
SynchronizationHandler handler,
boolean forceCustomSyncMode)
Sets custom synchronization handler for a device setting variable.
|
void |
setDefaultCacheMode(int mode)
Sets default device setting cache mode.
|
void |
setDefaultColorExpression(java.lang.String expression)
Sets default color expression for the device account.
|
void |
setDefaultEventStoragePeriod(long defaultEventStoragePeriod)
Sets default event storage period for the device account.
|
void |
setDefaultLatitudeExpression(java.lang.String expression)
Sets default latitude expression for the device account.
|
void |
setDefaultLongitudeExpression(java.lang.String expression)
Sets default longitude expression for the device account.
|
void |
setDefaultStatusExpression(java.lang.String expression)
Sets default status expression for the device account.
|
void |
setDefaultSynchronizationOptions(java.lang.String variable,
boolean local,
SettingSynchronizationOptions options)
Sets default synchronization options for a device setting variable.
|
void |
setDefaultSynchronizationOptions(java.lang.String variable,
SettingSynchronizationOptions options)
Sets default synchronization options for a device setting variable.
|
void |
setDefaultSynchronizationPeriod(long period)
Sets default synchronization period for the device account.
|
void |
setDeviceType(java.lang.String deviceType)
Sets the "secondary" type of device context.
|
void |
setOnline(boolean online)
Sets new synchronization status for the device.
|
void |
setUsePredefinedQualityCodes(boolean value)
Allows the server to use predefined quality codes for device settings.
|
addedToGroup, addVisibleChild, alertActivated, alertDeactivated, checkPermissions, createDefaultStatisticsChannels, eventAcknowledged, eventEnriched, getDefaultValue, getDependentContexts, getDependentVariables, getGroups, getMembers, getMembers, getShortDescription, hasVisibleChild, initAction, removedFromGroup, removeVariableValue, removeVisibleChild, setIndex, shouldBeHiddenaccept, addActionDefinition, addAlias, addChild, addEventDefinition, addEventListener, addEventListener, addFunctionDefinition, addVariableDefinition, callFunction, callFunction, callFunction, callFunction, callFunction, callFunction, callFunction, destroy, destroyChild, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, get, get, getActionDefinition, getActionDefinition, getActionDefinitions, getActionDefinitions, getActionDefinitions, getChild, getChild, getChildren, getChildren, getChildrenViewPermissions, getContextManager, getDefaultActionDefinition, getDescription, getEventData, getEventDefinition, getEventDefinition, getEventDefinitions, getEventDefinitions, getEventDefinitions, getEventDefinitions, getEventDefinitions, getEventHistory, getFunctionData, getFunctionDefinition, getFunctionDefinition, getFunctionDefinitions, getFunctionDefinitions, getFunctionDefinitions, getFunctionDefinitions, getFunctionDefinitions, getGroup, getIconId, getIndex, getLocalPrimaryRoot, getLocalRoot, getMappedChildren, getMappedChildren, getName, getParent, getPath, getPeerPath, getPeerRoot, getPermissions, getRemotePath, getRemoteRoot, getRoot, getStatus, getType, getVariable, getVariable, getVariable, getVariableClone, getVariableData, getVariableDefinition, getVariableDefinition, getVariableDefinitions, getVariableDefinitions, getVariableDefinitions, getVariableDefinitions, getVariableDefinitions, getVariableObject, getVisibleChildren, getVisibleChildren, hasMappedChild, hasParent, hasVisibleChild, isContainer, isDistributed, isInitializedChildren, isInitializedEvents, isInitializedFunctions, isInitializedInfo, isInitializedStatus, isInitializedVariables, isInstallationAllowed, isMapped, isProxy, isSetupComplete, isStarted, move, removeActionDefinition, removeChild, removeChild, removeEventDefinition, removeEventListener, removeFunctionDefinition, removeVariableDefinition, setParent, setup, setVariable, setVariable, setVariable, setVariable, setVariable, setVariableField, setVariableField, setVariableField, setVariableField, start, stop, teardown, toDetailedString, updateEventDefinitions, updateFunctionDefinitions, updatePrepare, updateVariableDefinitionsisDebuggingEvaluations, processEvaluation, processEvaluationErrorstatic final int CONNECTION_STATUS_OFFLINE
static final int CONNECTION_STATUS_ONLINE
static final int CONNECTION_STATUS_SUSPENDED
static final int CONNECTION_STATUS_UNKNOWN
static final int CONNECTION_STATUS_MAINTENANCE
static final int SYNC_STATUS_OK
static final int SYNC_STATUS_WAITING
static final int SYNC_STATUS_ERROR
static final int SYNC_STATUS_UNDEFINED
static final int SYNC_STATUS_CONNECTING
static final int SYNC_STATUS_READING_METADATA
static final int SYNC_STATUS_SYNCHRONIZING_SETTINGS
static final int CURRENT_SYNC_STATUS_CONNECTING
static final int CURRENT_SYNC_STATUS_READING_METADATA
static final int CURRENT_SYNC_STATUS_SYNCHRONIZING_PROPERTIES
static final int SYNC_MODE_NORMAL
static final int SYNC_MODE_DISABLED
static final int SYNC_MODE_DIRECT_ACCESS
static final int SYNC_MODE_MASTER_VALUE
static final int SYNC_MODE_IGNORE_MODIFICATION_TIME
static final int SYNC_MODE_READ_ONLY
static final int SYNC_MODE_DIRECT_WRITE
static final int SYNC_MODE_CUSTOM
static final int DIRECTION_NONE
static final int DIRECTION_AUTO
static final int DIRECTION_DEVICE_TO_SERVER
static final int DIRECTION_SERVER_TO_DEVICE
static final int HISTORY_RATE_UNCHANGED
static final int HISTORY_RATE_NORMAL
static final int HISTORY_RATE_ERROR
static final int HISTORY_RATE_UNCHANGED_OFFLINE
static final int HISTORY_RATE_UNCHANGED_ERROR
static final int HISTORY_RATE_OFFLINE_ERROR
static final int HISTORY_RATE_UNCHANGED_OFFLINE_ERROR
static final int CHANGE_EVENT_TIMESTAMP_DRIVER
static final int CHANGE_EVENT_TIMESTAMP_SERVER
CallerController getCallerController()
DeviceDriver getDriver()
java.lang.String getAddress()
java.util.List<DeviceAssetDefinition> getAssets()
SettingSynchronizationOptions getSynchronizationOptions(java.lang.String variable)
variable - Name of variableDeviceSettingStatus getSettingStatus(java.lang.String variable)
variable - Name of variableboolean isOnline()
void setDefaultSynchronizationPeriod(long period)
period - New default synchronization periodvoid setDefaultStatusExpression(java.lang.String expression)
expression - New default status expressionvoid setDefaultColorExpression(java.lang.String expression)
expression - New default color expressionvoid setDefaultLatitudeExpression(java.lang.String expression)
expression - New default latitude expressionvoid setDefaultLongitudeExpression(java.lang.String expression)
expression - New default longitude expressionvoid setDefaultCacheMode(int mode)
mode - Cache mode (GenericPropertiesConstants.CACHE_DATABASE = Database,
GenericPropertiesConstants.CACHE_MEMORY = Memory)void setDefaultEventStoragePeriod(long defaultEventStoragePeriod)
defaultEventStoragePeriod - New default event storage periodvoid setDefaultSynchronizationOptions(java.lang.String variable,
SettingSynchronizationOptions options)
variable - Name of variableoptions - Default synchronization optionsvoid setDefaultSynchronizationOptions(java.lang.String variable,
boolean local,
SettingSynchronizationOptions options)
variable - Name of variablelocal - Whether to modify system-wide or local default synchronization options listoptions - Default synchronization optionsvoid setCustomSynchronizationHandler(java.lang.String variable,
SynchronizationHandler handler,
boolean forceCustomSyncMode)
variable - Name of variablehandler - Synchronization handlerforceCustomSyncMode - Switch setting to a custom synchronization mode if truevoid removeCustomSynchronizationHandler(java.lang.String variable)
variable - Name of variablevoid setDeviceType(java.lang.String deviceType)
throws ContextException
DeviceDriver.setupDeviceContext(DeviceContext).deviceType - Device type stringContextException - If device type change fails since device controller of a new device type cannot be applied to current device contextvoid setAccessSettingReinitializer(java.lang.String variable,
AccessSettingReinizializer reinitializer)
variable - Name of access setting variable those changes should be trackedreinitializer - The reinitializervoid requestReconnection()
void requestSynchronization()
void requestSynchronization(boolean useExtendedStatus)
requestSynchronization(), but allows to temporarily enable extended connection status.void requestSynchronization(SynchronizationParameters parameters)
requestSynchronization(), but allows to specify custom synchronization options.void requestAssetsUpdate()
void asyncVariableUpdate(java.lang.String variable,
DataTable value)
throws DisconnectionException,
ContextException,
DeviceException
void processHistoricalValue(java.lang.String variable,
java.util.Date timestamp,
DataTable value)
throws ContextException
ContextExceptionjava.util.concurrent.locks.ReentrantLock getSynchronizationLock()
SynchronizationResult executeSynchronization(SynchronizationParameters parameters)
void setOnline(boolean online)
DeviceDriver.isUsesConnections() method returns false. The method is normally called from
DeviceDriver.finishSynchronization().online - New connection status of the deviceVariableDefinition discoverDeviceVariable(java.lang.String name, int timeout, java.lang.Object helper) throws ContextException
ContextExceptionFunctionDefinition discoverDeviceFunction(java.lang.String name, int timeout, java.lang.Object helper) throws ContextException
ContextExceptionEventDefinition discoverDeviceEvent(java.lang.String name, int timeout, java.lang.Object helper) throws ContextException
ContextExceptionvoid setUsePredefinedQualityCodes(boolean value)