com.whizzosoftware.hobson.api.plugin

Class AbstractHobsonPlugin

java.lang.Object

com.whizzosoftware.hobson.api.plugin.AbstractHobsonPlugin

All Implemented Interfaces:

EventLoopExecutor, HobsonPlugin

Direct Known Subclasses:

AbstractChannelObjectPlugin, AbstractHttpClientPlugin

public abstract class AbstractHobsonPlugin
extends java.lang.Object
implements HobsonPlugin, EventLoopExecutor

A base class that implements several HobsonPlugin methods. This provides a good starting point for third-party HobsonPlugin implementations.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
AbstractHobsonPlugin(java.lang.String pluginId, java.lang.String version, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
protected void	addJobStatusMessage(java.lang.String msg, java.lang.Object props)
protected void	deleteDeviceProxy(java.lang.String deviceId)
Future	executeInEventLoop(java.lang.Runnable runnable) Execute a task using an event loop.
protected void	executeTask(TaskContext context)
protected AccessManager	getAccessManager()
protected ActionClass	getActionClass(java.lang.String actionId)
protected java.util.Collection<ActionClass>	getActionClasses()
PropertyContainerClass	getConfigurationClass()
protected abstract TypedProperty[]	getConfigurationPropertyTypes() Returns an array of configuration properties the plugin supports.
PluginContext	getContext()
protected java.io.File	getDataDirectory() Returns a File for the plugin's directory sandbox.
protected java.io.File	getDataFile(java.lang.String filename) Returns a File located in the plugin's directory sandbox.
protected java.lang.String	getDescription()
HobsonLocalPluginDescriptor	getDescriptor()
protected java.util.Collection<DeviceAdvertisement>	getDeviceAdvertisementSnapshot(java.lang.String protocolId) Requests all currently known device advertisements.
java.lang.Object	getDeviceConfigurationProperty(java.lang.String deviceId, java.lang.String name)
java.lang.Long	getDeviceLastCheckin(java.lang.String deviceId)
protected java.util.Collection<HobsonDeviceProxy>	getDeviceProxies()
protected HobsonDeviceProxy	getDeviceProxy(java.lang.String deviceId)
protected DeviceVariableState	getDeviceVariableState(DeviceVariableContext dvctx) Returns the device variable state for a device not created by this plugin.
DeviceVariableState	getDeviceVariableState(java.lang.String deviceId, java.lang.String name) Returns the device variable state for a device published by this plugin.
protected DiscoManager	getDiscoManager()
EventLoopExecutor	getEventLoopExecutor()
protected HubManager	getHubManager()
protected HobsonHub	getLocalHub()
protected abstract java.lang.String	getName()
protected java.util.Collection<HobsonDeviceDescriptor>	getPublishedDeviceDescriptions()
long	getRefreshInterval()
PluginStatus	getStatus()
protected TaskManager	getTaskManager()
TaskProvider	getTaskProvider()
protected PluginType	getType()
protected boolean	hasDeviceProxy(java.lang.String deviceId)
protected boolean	hasDeviceVariable(java.lang.String deviceId, java.lang.String name)
protected boolean	hasDeviceVariableState(DeviceVariableContext dvctx)
boolean	hasDeviceVariableState(java.lang.String deviceId, java.lang.String name) Returns whether this device has published a variable.
boolean	hasTaskProvider()
void	onDeviceConfigurationUpdateEvent(DeviceConfigurationUpdateEvent event)
void	onDeviceDeletedEvent(DeviceDeletedEvent event)
void	onDeviceVariablesUpdate(java.util.Collection<DeviceVariableDescriptor> vars)
void	onHandleTaskEvents(TaskEvent event)
abstract void	onPluginConfigurationUpdate(PropertyContainer config)
void	onPluginConfigurationUpdateEvent(PluginConfigurationUpdateEvent event)
void	onRefresh()
void	onSetDeviceVariables(DeviceVariablesUpdateRequestEvent event)
void	postEvent(HobsonEvent event)
void	publishActionProvider(ActionProvider provider)
void	publishDeviceAdvertisement(DeviceAdvertisement advertisement, boolean internal) Publishes a new DeviceAdvertisement.
protected Future	publishDeviceProxy(HobsonDeviceProxy proxy)
protected Future	publishDeviceProxy(HobsonDeviceProxy proxy, java.util.Map<java.lang.String,java.lang.Object> config)
protected void	publishTaskConditionClass(TaskConditionClass conditionClass)
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)
protected void	setGlobalVariable(java.lang.String name, java.lang.Object value, long timestamp)
protected void	setGlobalVariables(java.util.Map<java.lang.String,java.lang.Object> values, long timestamp)
void	setHubManager(HubManager hubManager)
protected void	setPluginConfigurationProperty(PluginContext ctx, java.lang.String name, java.lang.Object value) Sets a plugin configuration property.
void	setPluginManager(PluginManager pluginManager)
protected void	setStatus(PluginStatus status)
void	setTaskManager(TaskManager taskManager)
void	setTaskProvider(TaskProvider taskProvider)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.whizzosoftware.hobson.api.plugin.HobsonPlugin

onShutdown, onStartup

Constructor Detail

AbstractHobsonPlugin

public AbstractHobsonPlugin(java.lang.String pluginId,
                            java.lang.String version,
                            java.lang.String description)

Method Detail

getContext

public PluginContext getContext()

Specified by:

getContext in interface HobsonPlugin

getConfigurationClass

public PropertyContainerClass getConfigurationClass()

Specified by:

getConfigurationClass in interface HobsonPlugin

setStatus

protected void setStatus(PluginStatus status)

getDescriptor

public HobsonLocalPluginDescriptor getDescriptor()

Specified by:

getDescriptor in interface HobsonPlugin

getStatus

public PluginStatus getStatus()

Specified by:

getStatus in interface HobsonPlugin

onHandleTaskEvents

public void onHandleTaskEvents(TaskEvent event)

onDeviceConfigurationUpdateEvent

public void onDeviceConfigurationUpdateEvent(DeviceConfigurationUpdateEvent event)

onDeviceDeletedEvent

public void onDeviceDeletedEvent(DeviceDeletedEvent event)

onPluginConfigurationUpdateEvent

public void onPluginConfigurationUpdateEvent(PluginConfigurationUpdateEvent event)

onPluginConfigurationUpdate

public abstract void onPluginConfigurationUpdate(PropertyContainer config)

getDeviceVariableState

protected DeviceVariableState getDeviceVariableState(DeviceVariableContext dvctx)

Returns the device variable state for a device not created by this plugin.

Parameters:

dvctx - the device variable context

Returns:

the device state

hasDeviceVariableState

protected boolean hasDeviceVariableState(DeviceVariableContext dvctx)

setTaskProvider

public void setTaskProvider(TaskProvider taskProvider)

getName

protected abstract java.lang.String getName()

getDescription

protected java.lang.String getDescription()

getType

protected PluginType getType()

hasDeviceProxy

protected boolean hasDeviceProxy(java.lang.String deviceId)

getDeviceProxy

protected HobsonDeviceProxy getDeviceProxy(java.lang.String deviceId)

getDeviceProxies

protected java.util.Collection<HobsonDeviceProxy> getDeviceProxies()

getActionClass

protected ActionClass getActionClass(java.lang.String actionId)

getActionClasses

protected java.util.Collection<ActionClass> getActionClasses()

getDeviceConfigurationProperty

public java.lang.Object getDeviceConfigurationProperty(java.lang.String deviceId,
                                                       java.lang.String name)

Specified by:

getDeviceConfigurationProperty in interface HobsonPlugin

getDeviceLastCheckin

public java.lang.Long getDeviceLastCheckin(java.lang.String deviceId)

Specified by:

getDeviceLastCheckin in interface HobsonPlugin

getDeviceVariableState

public DeviceVariableState getDeviceVariableState(java.lang.String deviceId,
                                                  java.lang.String name)

Description copied from interface: HobsonPlugin

Returns the device variable state for a device published by this plugin.

Specified by:

getDeviceVariableState in interface HobsonPlugin

Parameters:

deviceId - the device ID

name - the variable name

Returns:

a DeviceVariableState

hasDeviceVariableState

public boolean hasDeviceVariableState(java.lang.String deviceId,
                                      java.lang.String name)

Description copied from interface: HobsonPlugin

Returns whether this device has published a variable.

Specified by:

hasDeviceVariableState in interface HobsonPlugin

Parameters:

deviceId - the device ID

name - the variable name

Returns:

a boolean

hasTaskProvider

public boolean hasTaskProvider()

Specified by:

hasTaskProvider in interface HobsonPlugin

getRefreshInterval

public long getRefreshInterval()

Specified by:

getRefreshInterval in interface HobsonPlugin

getTaskProvider

public TaskProvider getTaskProvider()

Specified by:

getTaskProvider in interface HobsonPlugin

getEventLoopExecutor

public EventLoopExecutor getEventLoopExecutor()

Specified by:

getEventLoopExecutor in interface HobsonPlugin

postEvent

public void postEvent(HobsonEvent event)

Specified by:

postEvent in interface HobsonPlugin

onDeviceVariablesUpdate

public void onDeviceVariablesUpdate(java.util.Collection<DeviceVariableDescriptor> vars)

Specified by:

onDeviceVariablesUpdate in interface HobsonPlugin

onRefresh

public void onRefresh()

Specified by:

onRefresh in interface HobsonPlugin

onSetDeviceVariables

public void onSetDeviceVariables(DeviceVariablesUpdateRequestEvent event)

publishActionProvider

public void publishActionProvider(ActionProvider provider)

Specified by:

publishActionProvider in interface HobsonPlugin

publishTaskConditionClass

protected void publishTaskConditionClass(TaskConditionClass conditionClass)

scheduleAtFixedRateInEventLoop

public void scheduleAtFixedRateInEventLoop(java.lang.Runnable runnable,
                                           long initialDelay,
                                           long time,
                                           java.util.concurrent.TimeUnit unit)

Specified by:

scheduleAtFixedRateInEventLoop in interface HobsonPlugin

setDeviceConfigurationProperty

public void setDeviceConfigurationProperty(DeviceContext dctx,
                                           java.lang.String name,
                                           java.lang.Object value)

Specified by:

setDeviceConfigurationProperty in interface HobsonPlugin

setDeviceConfigurationProperties

public void setDeviceConfigurationProperties(DeviceContext dctx,
                                             java.util.Map<java.lang.String,java.lang.Object> values)

Specified by:

setDeviceConfigurationProperties in interface HobsonPlugin

setAccessManager

public void setAccessManager(AccessManager accessManager)

Specified by:

setAccessManager in interface HobsonPlugin

setDeviceManager

public void setDeviceManager(DeviceManager deviceManager)

Specified by:

setDeviceManager in interface HobsonPlugin

setDiscoManager

public void setDiscoManager(DiscoManager discoManager)

Specified by:

setDiscoManager in interface HobsonPlugin

setEventManager

public void setEventManager(EventManager eventManager)

Specified by:

setEventManager in interface HobsonPlugin

setHubManager

public void setHubManager(HubManager hubManager)

Specified by:

setHubManager in interface HobsonPlugin

setActionManager

public void setActionManager(ActionManager actionManager)

Specified by:

setActionManager in interface HobsonPlugin

setPluginManager

public void setPluginManager(PluginManager pluginManager)

Specified by:

setPluginManager in interface HobsonPlugin

setTaskManager

public void setTaskManager(TaskManager taskManager)

Specified by:

setTaskManager in interface HobsonPlugin

executeInEventLoop

public Future executeInEventLoop(java.lang.Runnable runnable)

Description copied from interface: EventLoopExecutor

Execute a task using an event loop. Note that this will tie up the event loop while the task is being executed so this should not be used for long running tasks.

Specified by:

executeInEventLoop in interface EventLoopExecutor

Parameters:

runnable - a task to execute

Returns:

a Future representing the result of the execution

getConfigurationPropertyTypes

protected abstract TypedProperty[] getConfigurationPropertyTypes()

Returns an array of configuration properties the plugin supports. These will automatically be registered with the plugin's configuration class.

Returns:

an array of TypedProperty objects (or null if there are none)

getDataDirectory

protected java.io.File getDataDirectory()

Returns a File for the plugin's directory sandbox.

Returns:

a File object

getDataFile

protected java.io.File getDataFile(java.lang.String filename)

Returns a File located in the plugin's directory sandbox.

Parameters:

filename - the filename

Returns:

a File instance

hasDeviceVariable

protected boolean hasDeviceVariable(java.lang.String deviceId,
                                    java.lang.String name)

setPluginConfigurationProperty

protected void setPluginConfigurationProperty(PluginContext ctx,
                                              java.lang.String name,
                                              java.lang.Object value)

Sets a plugin configuration property.

Parameters:

ctx - the context of the target plugin

name - the name of the property

value - the value of the property

publishDeviceProxy

protected Future publishDeviceProxy(HobsonDeviceProxy proxy)

publishDeviceProxy

protected Future publishDeviceProxy(HobsonDeviceProxy proxy,
                                    java.util.Map<java.lang.String,java.lang.Object> config)

deleteDeviceProxy

protected void deleteDeviceProxy(java.lang.String deviceId)

addJobStatusMessage

protected void addJobStatusMessage(java.lang.String msg,
                                   java.lang.Object props)

getDeviceAdvertisementSnapshot

protected java.util.Collection<DeviceAdvertisement> getDeviceAdvertisementSnapshot(java.lang.String protocolId)

Requests all currently known device advertisements.

Parameters:

protocolId - the protocol ID for the advertisements requested

Returns:

a Collection of DeviceAdvertisement instances

publishDeviceAdvertisement

public void publishDeviceAdvertisement(DeviceAdvertisement advertisement,
                                       boolean internal)

Publishes a new DeviceAdvertisement.

Parameters:

advertisement - the advertisement to publish

internal - indicates if this is an internal advertisement. A value of true will insure that the advertisement is included in any discovery requests that external clients make for a particular protocol.

executeTask

protected void executeTask(TaskContext context)

getPublishedDeviceDescriptions

protected java.util.Collection<HobsonDeviceDescriptor> getPublishedDeviceDescriptions()

getLocalHub

protected HobsonHub getLocalHub()

getAccessManager

protected AccessManager getAccessManager()

getDiscoManager

protected DiscoManager getDiscoManager()

getHubManager

protected HubManager getHubManager()

getTaskManager

protected TaskManager getTaskManager()

setGlobalVariable

protected void setGlobalVariable(java.lang.String name,
                                 java.lang.Object value,
                                 long timestamp)

setGlobalVariables

protected void setGlobalVariables(java.util.Map<java.lang.String,java.lang.Object> values,
                                  long timestamp)