com.whizzosoftware.hobson.api.plugin.channel

Class AbstractChannelObjectPlugin

java.lang.Object

com.whizzosoftware.hobson.api.plugin.AbstractHobsonPlugin

com.whizzosoftware.hobson.api.plugin.channel.AbstractChannelObjectPlugin

All Implemented Interfaces:

EventLoopExecutor, HobsonPlugin

public abstract class AbstractChannelObjectPlugin
extends AbstractHobsonPlugin

An abstract base class for plugins that read/write data to/from a Netty channel as Java objects. The channel is an abstraction for both network and serial port connections.

Author:

Dan Noguerol

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PROP_SERIAL_HOSTNAME
protected static java.lang.String	PROP_SERIAL_PORT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract void	configureChannel(ChannelConfig config) Allows subclasses to configure the channel before it is used.
protected void	configurePipeline(ChannelPipeline pipeline) Configures the Netty channel pipeline.
protected abstract ChannelInboundHandlerAdapter	getDecoder() Returns the decoder that converts a sequence of bytes received from the channel into one or more Java objects.
protected int	getDefaultPort() Indicates the default network port.
protected abstract ChannelOutboundHandlerAdapter	getEncoder() Returns an encoder that converts a Java object into a sequence of bytes from transmission over the channel.
protected ChannelIdleDetectionConfig	getIdleDetectionConfig() Returns a configuration object used for idle detection.
protected boolean	isConnected() Indicates whether the channel is connected.
protected boolean	isConnectionless()
protected boolean	isNetworkAddress() Indicates whether the channel is a network connection.
protected boolean	isSerialAddress() Indicates whether the channel is a serial port.
protected abstract void	onChannelConnected() Called when the channel successfully connects.
protected abstract void	onChannelData(java.lang.Object o) Called when the channel receives data.
protected abstract void	onChannelDisconnected() Called when the channel disconnected.
void	onPluginConfigurationUpdate(PropertyContainer config)
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.
protected void	send(java.lang.Object o) Sends an object over the channel.
void	setRemoteAddress(java.net.SocketAddress socketAddress) Sets the remote address to use as the data channel.

Methods inherited from class com.whizzosoftware.hobson.api.plugin.AbstractHobsonPlugin

addJobStatusMessage, deleteDeviceProxy, executeInEventLoop, executeTask, getAccessManager, getActionClass, getActionClasses, getConfigurationClass, getConfigurationPropertyTypes, getContext, getDataDirectory, getDataFile, getDescription, getDescriptor, getDeviceAdvertisementSnapshot, getDeviceConfigurationProperty, getDeviceLastCheckin, getDeviceProxies, getDeviceProxy, getDeviceVariableState, getDeviceVariableState, getDiscoManager, getEventLoopExecutor, getHubManager, getLocalHub, getName, getPublishedDeviceDescriptions, getRefreshInterval, getStatus, getTaskManager, getTaskProvider, getType, hasDeviceProxy, hasDeviceVariable, hasDeviceVariableState, hasDeviceVariableState, hasTaskProvider, onDeviceConfigurationUpdateEvent, onDeviceDeletedEvent, onDeviceVariablesUpdate, onHandleTaskEvents, onPluginConfigurationUpdateEvent, onSetDeviceVariables, postEvent, publishActionProvider, publishDeviceAdvertisement, publishDeviceProxy, publishDeviceProxy, publishTaskConditionClass, scheduleAtFixedRateInEventLoop, setAccessManager, setActionManager, setDeviceConfigurationProperties, setDeviceConfigurationProperty, setDeviceManager, setDiscoManager, setEventManager, setGlobalVariable, setGlobalVariables, setHubManager, setPluginConfigurationProperty, setPluginManager, setStatus, setTaskManager, setTaskProvider

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SERIAL_PORT

protected static final java.lang.String PROP_SERIAL_PORT

See Also:

Constant Field Values

PROP_SERIAL_HOSTNAME

protected static final java.lang.String PROP_SERIAL_HOSTNAME

See Also:

Constant Field Values

Constructor Detail

AbstractChannelObjectPlugin

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

Method Detail

onStartup

public void onStartup(PropertyContainer config)

Description copied from interface: HobsonPlugin

Callback method for plugins to perform initialization once they've been started.

Parameters:

config - the current plugin configuration

onPluginConfigurationUpdate

public void onPluginConfigurationUpdate(PropertyContainer config)

Specified by:

onPluginConfigurationUpdate in class AbstractHobsonPlugin

onRefresh

public void onRefresh()

Specified by:

onRefresh in interface HobsonPlugin

Overrides:

onRefresh in class AbstractHobsonPlugin

onShutdown

public void onShutdown()

Description copied from interface: HobsonPlugin

Callback method for plugins to perform tasks when they are being stopped.

setRemoteAddress

public void setRemoteAddress(java.net.SocketAddress socketAddress)

Sets the remote address to use as the data channel.

Parameters:

socketAddress - the address

isNetworkAddress

protected boolean isNetworkAddress()

Indicates whether the channel is a network connection.

Returns:

a boolean

isConnectionless

protected boolean isConnectionless()

isSerialAddress

protected boolean isSerialAddress()

Indicates whether the channel is a serial port.

Returns:

a boolean

isConnected

protected boolean isConnected()

Indicates whether the channel is connected.

Returns:

a boolean

getDefaultPort

protected int getDefaultPort()

Indicates the default network port.

Returns:

an int

send

protected void send(java.lang.Object o)

Sends an object over the channel. It will be the job of the handler returned from getEncoder() to convert the object into bytes for transmission over the channel.

Parameters:

o - the object to send

getIdleDetectionConfig

protected ChannelIdleDetectionConfig getIdleDetectionConfig()

Returns a configuration object used for idle detection.

Returns:

an IdleDetectionConfig instance (or null if no idle detection should be performed).

getDecoder

protected abstract ChannelInboundHandlerAdapter getDecoder()

Returns the decoder that converts a sequence of bytes received from the channel into one or more Java objects.

Returns:

a ChannelInboundHandlerAdapter

getEncoder

protected abstract ChannelOutboundHandlerAdapter getEncoder()

Returns an encoder that converts a Java object into a sequence of bytes from transmission over the channel.

Returns:

a ChannelOutboundHandlerAdapter

configureChannel

protected abstract void configureChannel(ChannelConfig config)

Allows subclasses to configure the channel before it is used.

Parameters:

config - the channel configuration

onChannelConnected

protected abstract void onChannelConnected()

Called when the channel successfully connects.

onChannelData

protected abstract void onChannelData(java.lang.Object o)

Called when the channel receives data.

Parameters:

o - the data received

onChannelDisconnected

protected abstract void onChannelDisconnected()

Called when the channel disconnected.

configurePipeline

protected void configurePipeline(ChannelPipeline pipeline)

Configures the Netty channel pipeline. This can be overridden by subclasses if needed.

Parameters:

pipeline - the current channel pipeline