org.rifidi.edge.sensors.sessions

Class AbstractSensorSession

java.lang.Object

org.rifidi.edge.sensors.SensorSession

org.rifidi.edge.sensors.sessions.AbstractSensorSession

Direct Known Subclasses:

AbstractIPSensorSession, AbstractServerSocketSensorSession, LLRPReaderSession, Thingmagic6SensorSession, ThinkifyUSBSensorSession

public abstract class AbstractSensorSession
extends SensorSession

An Abstract class for concrete ReaderSessions to extend. This AbstractSensorSession class provides a base implementation of the command handling of a reader session (i.e. submitting, deleting, executing commands). It does not provide any implementation of connection methods in a session. This implementation has two lists to keep up with submitted commands: the queuedCommands are commands that have been submitted to the session when the session was not in the processing (i.e. connected) state. These commands will be executed as soon as a connection has been established. The running commands are the commands that have already been submitted to the executor. When the session goes down for whatever reason, sublcasses can call the resetCommands() method, which takes all the commands in the runningCommands and moves them to the queuedCommands. When the session comes back up, they may call the submitQueuedCommands() method, which takes all the commands saved in the queuedCommands list and submits them back to the executor. This way commands can be restored if there are interrupts in the session. It is important for sublclasses to use the processing and executor objects correctly. Whenever a connection has been established with the session, subclasses should create a new ScheduledThreadPoolExecutor, assign it to the executor, and set the processing variable to true. When the connection is stopped or becomes disconnected, the processing variable should be set to false.

Author:

Kyle Neumeier - kyle@pramari.com

Constructor Summary

Constructors

Constructor and Description
AbstractSensorSession(AbstractSensor<?> sensor, java.lang.String ID, java.util.Set<AbstractCommandConfiguration<?>> commandConfigurations) Constructor

Method Summary

Modifier and Type	Method and Description
Command	getCommandInstance(java.lang.String commandID) Used to aquire a command instance.
SessionStatus	getStatus() Get the status of the sensorSession.
void	killComand(java.lang.Integer id) This method deletes a command from the session, including the DTO.
void	submit(Command command) Submit a command for a one-time execution.
void	submit(Command command, long interval, java.util.concurrent.TimeUnit unit) Schedule a command for a repeated execution.
java.lang.Integer	submit(java.lang.String commandID, long interval, java.util.concurrent.TimeUnit unit) Submit a command to a reader session for execution.
boolean	submitAndBlock(Command command, long timeout, java.util.concurrent.TimeUnit unit) Submit a command for a one-time execution.
void	suspendCommand(java.lang.String commandID) Called if a command configuration temporarily disappears.

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

connect, disconnect, getCommands, getDTO, getID, getSensor, getTimeout, handleTimeout, killAllCommands, restoreCommands

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSensorSession

public AbstractSensorSession(AbstractSensor<?> sensor,
                             java.lang.String ID,
                             java.util.Set<AbstractCommandConfiguration<?>> commandConfigurations)

Constructor

Parameters:

sensor -

ID - ID of this SensorSession

destination - The JMS Queue to add Tag Data to

template - The Template used to send Tag data to the internal queue

commandConfigurations - Provided by spring

Method Detail

getStatus

public SessionStatus getStatus()

Description copied from class: SensorSession

Get the status of the sensorSession.

Specified by:

getStatus in class SensorSession

Returns:

The status of the SensorSession

killComand

public void killComand(java.lang.Integer id)

Description copied from class: SensorSession

This method deletes a command from the session, including the DTO. If the command is recurring, it will unschedule it. This command will not execute the next time the session starts up

Specified by:

killComand in class SensorSession

Parameters:

id - The ID of the command to kill

submit

public java.lang.Integer submit(java.lang.String commandID,
                                long interval,
                                java.util.concurrent.TimeUnit unit)

Description copied from class: SensorSession

Submit a command to a reader session for execution. If interval > 0, the command will be scheduled for repeated execution.

Specified by:

submit in class SensorSession

Parameters:

commandID - The command to execute

interval - The interval between executions

unit - The Unit of time to measure the interval

Returns:

The ID of the job

submit

public void submit(Command command)

Description copied from class: SensorSession

Submit a command for a one-time execution. This method is intended to be used for internal commands (i.e. commands that do not have a configuration and thus are not registered in OSGi). Commands submitted using this method cannot be persisted, and will not restart automatically if the session stops.

Specified by:

submit in class SensorSession

Parameters:

command - The command to execute

submitAndBlock

public boolean submitAndBlock(Command command,
                              long timeout,
                              java.util.concurrent.TimeUnit unit)

Description copied from class: SensorSession

Submit a command for a one-time execution. This method is intended to be used for internal commands (i.e. commands that do not have a configuration and thus are not registered in OSGi). Commands submitted using this method cannot be persisted, and will not restart automatically if the session stops. This method will block until the command has finished its execution or will throw a TimeoutException if the given amount of time has expired before the command finished.

Specified by:

submitAndBlock in class SensorSession

Parameters:

command - The command to execute

timeout - The amount of time to wait. If -1, wait forever before throwing a TimoutException

Returns:

true if the command returned. False if the command was not submitted or did not finish executing

submit

public void submit(Command command,
                   long interval,
                   java.util.concurrent.TimeUnit unit)

Description copied from class: SensorSession

Schedule a command for a repeated execution. This method is intended to be used for internal commands (i.e. commands that do not have a configuration and thus are not registered in OSGi). Commands submitted using this method cannot be persisted, and will not restart automatically if the session stops.

Specified by:

submit in class SensorSession

Parameters:

command - The command to execute

suspendCommand

public void suspendCommand(java.lang.String commandID)

Called if a command configuration temporarily disappears.

Parameters:

commandID -

getCommandInstance

public Command getCommandInstance(java.lang.String commandID)

Used to aquire a command instance.

Parameters:

commandID -

Returns: