org.rifidi.edge.sensors.sessions

Class AbstractServerSocketSensorSession

java.lang.Object

org.rifidi.edge.sensors.SensorSession

org.rifidi.edge.sensors.sessions.AbstractSensorSession

org.rifidi.edge.sensors.sessions.AbstractServerSocketSensorSession

Direct Known Subclasses:

AlienAutonomousSensorSession, AlienGPIOSession, CslSocketSensorSession, GenericSensorSession

public abstract class AbstractServerSocketSensorSession
extends AbstractSensorSession

When the session is started, it opens up a serversocket and uses the executor pattern to handle each new request. It is not possible to submit commands to this session, since it is passive.

Author:

Kyle Neumeier - kyle@pramari.com

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disconnect() Close the connection and stop processing of commands.
void	killComand(java.lang.Integer id) This method deletes a command from the session, including the DTO.
void	restoreCommands(SessionDTO dto) This method should be called by subclasses to restore the commands that need to be submitted to a session from a SessionDTO.
void	submit(Command command) Submit a command for a one-time 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.
java.lang.String	toString()

Methods inherited from class org.rifidi.edge.sensors.sessions.AbstractSensorSession

getCommandInstance, getStatus, submit, submitAndBlock, suspendCommand

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServerSocketSensorSession

public AbstractServerSocketSensorSession(AbstractSensor<?> sensor,
                                         java.lang.String ID,
                                         int serverSocketPort,
                                         int maxNumSensors,
                                         java.util.Set<AbstractCommandConfiguration<?>> commandConfigurations)

Constructor

Parameters:

sensor - The sensor this session works for

ID - The ID of the session

destination - The JMS destination

template - The JMS template used for internal message bus

serverSocketPort - The port of the socket

maxNumSensors - The maximum number of concurrent clients supported

commandConfigurations -

Method Detail

disconnect

public void disconnect()

Description copied from class: SensorSession

Close the connection and stop processing of commands.

Specified by:

disconnect in class 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

Overrides:

killComand in class AbstractSensorSession

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.

Overrides:

submit in class AbstractSensorSession

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.

Overrides:

submit in class AbstractSensorSession

Parameters:

command - The command to execute

restoreCommands

public void restoreCommands(SessionDTO dto)

Description copied from class: SensorSession

This method should be called by subclasses to restore the commands that need to be submitted to a session from a SessionDTO. It should normally be called from the createSensorSession(SessionDTO) method

Overrides:

restoreCommands in class SensorSession

Parameters:

dto - The DTO of the session which contains the DTOs of the commands

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object