public interface HobsonPlugin
Modifier and Type | Method and Description |
---|---|
PropertyContainerClass |
getConfigurationClass() |
PluginContext |
getContext() |
HobsonLocalPluginDescriptor |
getDescriptor() |
java.lang.Object |
getDeviceConfigurationProperty(java.lang.String deviceId,
java.lang.String name) |
java.lang.Long |
getDeviceLastCheckin(java.lang.String deviceId) |
DeviceVariableState |
getDeviceVariableState(java.lang.String deviceId,
java.lang.String name)
Returns the device variable state for a device published by this plugin.
|
EventLoopExecutor |
getEventLoopExecutor() |
long |
getRefreshInterval() |
PluginStatus |
getStatus() |
TaskProvider |
getTaskProvider() |
boolean |
hasDeviceVariableState(java.lang.String deviceId,
java.lang.String name)
Returns whether this device has published a variable.
|
boolean |
hasTaskProvider() |
void |
onDeviceVariablesUpdate(java.util.Collection<DeviceVariableDescriptor> vars) |
void |
onRefresh() |
void |
onShutdown()
Callback method for plugins to perform tasks when they are being stopped.
|
void |
onStartup(PropertyContainer config)
Callback method for plugins to perform initialization once they've been started.
|
void |
postEvent(HobsonEvent event) |
void |
publishActionProvider(ActionProvider actionProvider) |
void |
scheduleAtFixedRateInEventLoop(java.lang.Runnable runnable,
long initialDelay,
long time,
java.util.concurrent.TimeUnit unit) |
void |
setAccessManager(AccessManager accessManager) |
void |
setActionManager(ActionManager actionManager) |
void |
setDeviceConfigurationProperties(DeviceContext dctx,
java.util.Map<java.lang.String,java.lang.Object> values) |
void |
setDeviceConfigurationProperty(DeviceContext dctx,
java.lang.String name,
java.lang.Object value) |
void |
setDeviceManager(DeviceManager deviceManager) |
void |
setDiscoManager(DiscoManager discoManager) |
void |
setEventManager(EventManager eventManager) |
void |
setHubManager(HubManager hubManager) |
void |
setPluginManager(PluginManager pluginManager) |
void |
setTaskManager(TaskManager taskManager) |
HobsonLocalPluginDescriptor getDescriptor()
PropertyContainerClass getConfigurationClass()
PluginContext getContext()
java.lang.Object getDeviceConfigurationProperty(java.lang.String deviceId, java.lang.String name)
java.lang.Long getDeviceLastCheckin(java.lang.String deviceId)
DeviceVariableState getDeviceVariableState(java.lang.String deviceId, java.lang.String name)
deviceId
- the device IDname
- the variable nameEventLoopExecutor getEventLoopExecutor()
long getRefreshInterval()
PluginStatus getStatus()
TaskProvider getTaskProvider()
boolean hasDeviceVariableState(java.lang.String deviceId, java.lang.String name)
deviceId
- the device IDname
- the variable nameboolean hasTaskProvider()
void onDeviceVariablesUpdate(java.util.Collection<DeviceVariableDescriptor> vars)
void onRefresh()
void onShutdown()
void onStartup(PropertyContainer config)
config
- the current plugin configurationvoid postEvent(HobsonEvent event)
void publishActionProvider(ActionProvider actionProvider)
void scheduleAtFixedRateInEventLoop(java.lang.Runnable runnable, long initialDelay, long time, java.util.concurrent.TimeUnit unit)
void setAccessManager(AccessManager accessManager)
void setActionManager(ActionManager actionManager)
void setDeviceConfigurationProperty(DeviceContext dctx, java.lang.String name, java.lang.Object value)
void setDeviceConfigurationProperties(DeviceContext dctx, java.util.Map<java.lang.String,java.lang.Object> values)
void setDeviceManager(DeviceManager deviceManager)
void setDiscoManager(DiscoManager discoManager)
void setEventManager(EventManager eventManager)
void setHubManager(HubManager hubManager)
void setPluginManager(PluginManager pluginManager)
void setTaskManager(TaskManager taskManager)
Copyright © 2015 Whizzo Software LLC. All rights reserved.