org.rifidi.edge.adapter.generic

Class GenericSensor

java.lang.Object

org.rifidi.edge.configuration.RifidiService

org.rifidi.edge.sensors.AbstractSensor<GenericSensorSession>

org.rifidi.edge.adapter.generic.GenericSensor

All Implemented Interfaces:

CompositeSensor, Sensor, SensorUpdate

public class GenericSensor
extends AbstractSensor<GenericSensorSession>

A generic plugin that can handle data coming in from any reader or source, if it is sent to the serversocket in the correct format. The format is as follows: ID:(tag ID)|Antenna:(antenna)|Timestamp:(millis since epoch) Any amount of other values can be specified in pairs delimited by colons, with pipes delimiting pairs.

Author:

Matthew Dean - matt@pramari.com

Field Summary

Fields

Modifier and Type	Field and Description
static javax.management.MBeanInfo	mbeaninfo MBeanInfo for this class.

Constructor Summary

Constructors

Constructor and Description
GenericSensor()

Method Summary

Modifier and Type	Method and Description
void	applyPropertyChanges() Send properties that have been modified to the physical reader
java.lang.String	createSensorSession() Create a new sensor session.
java.lang.String	createSensorSession(SessionDTO sessionDTO) This method is called when a sensor session is being created from a DTO, such as restoring the session from persistance.
void	destroySensorSession(java.lang.String id) Destroy a sesnor session.
java.lang.Boolean	getDisableAutoStart()
java.lang.String	getDisplayName() This method returns a display name for clients to use.
javax.management.MBeanInfo	getMBeanInfo() Get the MBean info.
java.lang.Integer	getPort()
java.lang.Boolean	getRestDebug() Should the rest service be started
java.lang.Integer	getRestPort() The port to use for incoming rest connections
java.lang.Integer	getRestSSLPort() The port to use for incoming rest ssl connections
java.util.Map<java.lang.String,SensorSession>	getSensorSessions() Get all currently created reader sessions.
void	setDisableAutoStart(java.lang.Boolean disableAutoStart)
void	setDisplayName(java.lang.String displayName)
void	setPort(java.lang.Integer port) Sets the port for the reader.
void	setRestDebug(java.lang.Boolean enabled)
void	setRestPort(java.lang.Integer port)
void	setRestSSLPort(java.lang.Integer port)
void	unbindCommandConfiguration(AbstractCommandConfiguration<?> commandConfiguration, java.util.Map<?,?> properties) Notifier the sensor that a command configuration has disappeared.

Methods inherited from class org.rifidi.edge.sensors.AbstractSensor

addReceiver, getChildren, getDTO, getName, isImmutable, isInUse, receive, register, register, removeReceiver, send, sendEvent, setName, setNotifiyService, subscribe, toString, unsubscribe

Methods inherited from class org.rifidi.edge.configuration.RifidiService

getAttribute, getAttributes, getAttributes, getID, setAttribute, setAttributes, setID

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mbeaninfo

public static final javax.management.MBeanInfo mbeaninfo

MBeanInfo for this class.

Constructor Detail

GenericSensor

public GenericSensor()

Method Detail

applyPropertyChanges

public void applyPropertyChanges()

Description copied from class: AbstractSensor

Send properties that have been modified to the physical reader

Specified by:

applyPropertyChanges in class AbstractSensor<GenericSensorSession>

createSensorSession

public java.lang.String createSensorSession()
                                     throws CannotCreateSessionException

Description copied from class: AbstractSensor

Create a new sensor session.

Specified by:

createSensorSession in class AbstractSensor<GenericSensorSession>

Returns:

id of the created session

Throws:

CannotCreateSessionException - - if the session cannot be created

createSensorSession

public java.lang.String createSensorSession(SessionDTO sessionDTO)
                                     throws CannotCreateSessionException

Description copied from class: AbstractSensor

This method is called when a sensor session is being created from a DTO, such as restoring the session from persistance.

Specified by:

createSensorSession in class AbstractSensor<GenericSensorSession>

Returns:

the ID of the session

Throws:

CannotCreateSessionException - if the session cannot be created

destroySensorSession

public void destroySensorSession(java.lang.String id)
                          throws CannotDestroySensorException

Description copied from class: AbstractSensor

Destroy a sesnor session.

Specified by:

destroySensorSession in class AbstractSensor<GenericSensorSession>

Throws:

CannotDestroySensorException

getSensorSessions

public java.util.Map<java.lang.String,SensorSession> getSensorSessions()

Description copied from class: AbstractSensor

Get all currently created reader sessions. The Key is the ID of the session, and the value is the actual session

Specified by:

getSensorSessions in class AbstractSensor<GenericSensorSession>

Returns:

unbindCommandConfiguration

public void unbindCommandConfiguration(AbstractCommandConfiguration<?> commandConfiguration,
                                       java.util.Map<?,?> properties)

Description copied from class: AbstractSensor

Notifier the sensor that a command configuration has disappeared.

Specified by:

unbindCommandConfiguration in class AbstractSensor<GenericSensorSession>

getMBeanInfo

public javax.management.MBeanInfo getMBeanInfo()

Description copied from class: RifidiService

Get the MBean info.

Specified by:

getMBeanInfo in class RifidiService

Returns:

getDisplayName

public java.lang.String getDisplayName()

Description copied from class: AbstractSensor

This method returns a display name for clients to use. This way readers can have user-friendly names (such as "Dock Door") in a client.

Returns:

The display name of the Sensor

setDisplayName

public void setDisplayName(java.lang.String displayName)

getPort

public java.lang.Integer getPort()

Returns:

the The name of the Serial Port.

setPort

public void setPort(java.lang.Integer port)

Sets the port for the reader.

Parameters:

port -

getRestPort

public java.lang.Integer getRestPort()

The port to use for incoming rest connections

Returns:

setRestPort

public void setRestPort(java.lang.Integer port)

getRestSSLPort

public java.lang.Integer getRestSSLPort()

The port to use for incoming rest ssl connections

Returns:

setRestSSLPort

public void setRestSSLPort(java.lang.Integer port)

getRestDebug

public java.lang.Boolean getRestDebug()

Should the rest service be started

Returns:

setRestDebug

public void setRestDebug(java.lang.Boolean enabled)

getDisableAutoStart

public java.lang.Boolean getDisableAutoStart()

setDisableAutoStart

public void setDisableAutoStart(java.lang.Boolean disableAutoStart)