org.rifidi.edge.adapter.awid.awid2010

Class AwidSession

java.lang.Object

org.rifidi.edge.sensors.SensorSession

org.rifidi.edge.sensors.sessions.AbstractSensorSession

org.rifidi.edge.sensors.sessions.AbstractIPSensorSession

org.rifidi.edge.sensors.sessions.AbstractPubSubIPSensorSession

org.rifidi.edge.adapter.awid.awid2010.AwidSession

public class AwidSession
extends AbstractPubSubIPSensorSession

The session that provides communication with the Awid reader. It extends the AbstratPubSubIPSensorSession so that the reading and writing to and from TCP sockets is handled. Incoming messages from the reader are sent to registered listeners, in this case the AwidEndpoint.

Author:

Kyle Neumeier - kyle@pramari.com

Constructor Summary

Constructors

Constructor and Description
AwidSession(AbstractSensor<?> sensor, java.lang.String ID, java.lang.String host, int port, int reconnectionInterval, int maxConAttempts, java.util.Set<AbstractCommandConfiguration<?>> commandConfigurations, NotifierService notifierSerivce, boolean is3014) Constructor

Method Summary

Modifier and Type	Method and Description
void	connect() Open the connection to the Sensor.
void	disconnect() Close the connection and stop processing of commands.
AwidEndpoint	getEndpoint()
AwidGPIOSession	getGPIOSession()
MessageParsingStrategyFactory	getMessageParsingStrategyFactory() Get a factory for MessageParsingStrategy objects
boolean	is3014() Is the reader a 3014?
void	killComand(java.lang.Integer id) This method deletes a command from the session, including the DTO.
boolean	onConnect() Called after the initial socket connection got established.
void	sendMessage(AbstractAwidCommand command) Clients of the session should use this method to send commands to the awid reader
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.AbstractPubSubIPSensorSession

subscribe, unsubscribe

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

getHost, getPort

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

getCommandInstance, getStatus, submit, submit, submitAndBlock, suspendCommand

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AwidSession

public AwidSession(AbstractSensor<?> sensor,
                   java.lang.String ID,
                   java.lang.String host,
                   int port,
                   int reconnectionInterval,
                   int maxConAttempts,
                   java.util.Set<AbstractCommandConfiguration<?>> commandConfigurations,
                   NotifierService notifierSerivce,
                   boolean is3014)

Constructor

Parameters:

sensor - The sensor that produced this session

ID - The ID of this session

host - The IP address of the awid

port - The port of the awid

reconnectionInterval - The time inbetween successive reconnection attempts

maxConAttempts - The maxiumum number of attempts to make to recoonect

template - Helper object for sending out JMS messages

commandConfigurations - The Commands available.

notifierSerivce - Helper object to send out notifications about the state

Method Detail

getMessageParsingStrategyFactory

public MessageParsingStrategyFactory getMessageParsingStrategyFactory()

Description copied from class: AbstractIPSensorSession

Get a factory for MessageParsingStrategy objects

Returns:

connect

public void connect()
             throws java.io.IOException

Description copied from class: SensorSession

Open the connection to the Sensor.

Overrides:

connect in class SensorSession

Throws:

java.io.IOException - if the connection fails

onConnect

public boolean onConnect()
                  throws java.io.IOException

Description copied from class: AbstractIPSensorSession

Called after the initial socket connection got established. Implementations can use this method to send login credentials or receive a welcome message.

Returns:

true if the connect was successful

Throws:

java.io.IOException - if a connection problem occurs

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

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

getGPIOSession

public AwidGPIOSession getGPIOSession()

getEndpoint

public AwidEndpoint getEndpoint()

sendMessage

public void sendMessage(AbstractAwidCommand command)
                 throws java.io.IOException

Clients of the session should use this method to send commands to the awid reader

Parameters:

command - The command to send

Throws:

java.io.IOException

disconnect

public void disconnect()

Description copied from class: SensorSession

Close the connection and stop processing of commands.

Overrides:

disconnect in class AbstractIPSensorSession

is3014

public boolean is3014()

Is the reader a 3014?

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class AbstractIPSensorSession