com.whizzosoftware.hobson.api.plugin

Class AbstractPluginManager

java.lang.Object

com.whizzosoftware.hobson.api.plugin.AbstractPluginManager

All Implemented Interfaces:

PluginManager

public abstract class AbstractPluginManager
extends java.lang.Object
implements PluginManager

An abstract implementation of PluginManager.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
AbstractPluginManager()

Method Summary

Modifier and Type	Method and Description
protected abstract ConfigurationManager	getConfigurationManager()
java.io.File	getDataDirectory(PluginContext ctx) Returns a File for a plugin's data directory.
java.io.File	getDataFile(PluginContext ctx, java.lang.String filename) Returns a File for a named file located in a plugin's data directory.
protected abstract EventManager	getEventManager()
GlobalVariable	getGlobalVariable(GlobalVariableContext gvctx) Returns a global variable.
java.util.Collection<GlobalVariable>	getGlobalVariables(PluginContext pctx) Returns all global variables published by a plugin.
HobsonLocalPluginDescriptor	getLocalPlugin(PluginContext ctx) Retrieves a specific plugin.
PropertyContainer	getLocalPluginConfiguration(PluginContext ctx) Returns the plugin level configuration.
DeviceVariableState	getLocalPluginDeviceVariable(DeviceVariableContext ctx) Returns information about a plugin device variable.
protected abstract HobsonPlugin	getLocalPluginInternal(PluginContext ctx)
boolean	hasLocalPluginDeviceVariable(DeviceVariableContext ctx) Indicates whether a plugin has published a device variable.
void	setLocalPluginConfiguration(PluginContext ctx, java.util.Map<java.lang.String,java.lang.Object> config) Sets the plugin level configuration.
void	setLocalPluginConfigurationProperty(PluginContext ctx, java.lang.String name, java.lang.Object value) Sets an individual plugin level configuration property.
Future	startPluginDevice(HobsonDeviceProxy device, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> config, java.lang.Runnable runnable) Starts a plugin device.

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.PluginManager

addRemoteRepository, getLocalPluginDeviceLastCheckin, getLocalPluginIcon, getLocalPlugins, getRemotePlugin, getRemotePlugins, getRemotePluginVersions, getRemoteRepositories, installRemotePlugin, reloadLocalPlugin, removeRemoteRepository

Constructor Detail

AbstractPluginManager

public AbstractPluginManager()

Method Detail

getLocalPluginInternal

protected abstract HobsonPlugin getLocalPluginInternal(PluginContext ctx)

getConfigurationManager

protected abstract ConfigurationManager getConfigurationManager()

getEventManager

protected abstract EventManager getEventManager()

getLocalPlugin

public HobsonLocalPluginDescriptor getLocalPlugin(PluginContext ctx)

Description copied from interface: PluginManager

Retrieves a specific plugin.

Specified by:

getLocalPlugin in interface PluginManager

Parameters:

ctx - the context of the target plugin

Returns:

a HobsonPlugin instance (or null if not found)

getLocalPluginConfiguration

public PropertyContainer getLocalPluginConfiguration(PluginContext ctx)

Description copied from interface: PluginManager

Returns the plugin level configuration.

Specified by:

getLocalPluginConfiguration in interface PluginManager

Parameters:

ctx - the context of the target plugin

Returns:

a Dictionary (or null if there is no configuration)

setLocalPluginConfiguration

public void setLocalPluginConfiguration(PluginContext ctx,
                                        java.util.Map<java.lang.String,java.lang.Object> config)

Description copied from interface: PluginManager

Sets the plugin level configuration.

Specified by:

setLocalPluginConfiguration in interface PluginManager

Parameters:

ctx - the context of the target plugin

config - the plugin configuration

setLocalPluginConfigurationProperty

public void setLocalPluginConfigurationProperty(PluginContext ctx,
                                                java.lang.String name,
                                                java.lang.Object value)

Description copied from interface: PluginManager

Sets an individual plugin level configuration property.

Specified by:

setLocalPluginConfigurationProperty in interface PluginManager

Parameters:

ctx - the context of the target hub

name - the configuration property name

value - the configuration property value

startPluginDevice

public Future startPluginDevice(HobsonDeviceProxy device,
                                java.lang.String name,
                                java.util.Map<java.lang.String,java.lang.Object> config,
                                java.lang.Runnable runnable)

Description copied from interface: PluginManager

Starts a plugin device.

Specified by:

startPluginDevice in interface PluginManager

Parameters:

device - the device proxy

name - the device's name

config - the device's configuration

runnable - a Runnable to execute after the device has started.

Returns:

a Future that indicates when the device has finished starting

getDataDirectory

public java.io.File getDataDirectory(PluginContext ctx)

Description copied from interface: PluginManager

Returns a File for a plugin's data directory.

Specified by:

getDataDirectory in interface PluginManager

Parameters:

ctx - the context of the plugin

Returns:

a File instance

getDataFile

public java.io.File getDataFile(PluginContext ctx,
                                java.lang.String filename)

Description copied from interface: PluginManager

Returns a File for a named file located in a plugin's data directory.

Specified by:

getDataFile in interface PluginManager

Parameters:

ctx - the context of the plugin requesting the file

filename - the name of the data file

Returns:

a File instance (or null if not found)

getGlobalVariable

public GlobalVariable getGlobalVariable(GlobalVariableContext gvctx)

Description copied from interface: PluginManager

Returns a global variable.

Specified by:

getGlobalVariable in interface PluginManager

Parameters:

gvctx - the variable context

Returns:

a GlobalVariable instance

getGlobalVariables

public java.util.Collection<GlobalVariable> getGlobalVariables(PluginContext pctx)

Description copied from interface: PluginManager

Returns all global variables published by a plugin.

Specified by:

getGlobalVariables in interface PluginManager

Parameters:

pctx - the plugin context

Returns:

a Collection of GlobalVariable instances

getLocalPluginDeviceVariable

public DeviceVariableState getLocalPluginDeviceVariable(DeviceVariableContext ctx)

Description copied from interface: PluginManager

Returns information about a plugin device variable.

Specified by:

getLocalPluginDeviceVariable in interface PluginManager

Parameters:

ctx - the variable context

Returns:

a DeviceVariableState instance

hasLocalPluginDeviceVariable

public boolean hasLocalPluginDeviceVariable(DeviceVariableContext ctx)

Description copied from interface: PluginManager

Indicates whether a plugin has published a device variable.

Specified by:

hasLocalPluginDeviceVariable in interface PluginManager

Parameters:

ctx - the device variable context

Returns:

a boolean