org.rifidi.edge.adapter.alien

Class Alien9800ReaderSession

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.AbstractPollIPSensorSession

org.rifidi.edge.adapter.alien.Alien9800ReaderSession

All Implemented Interfaces:

AlienCommandConstants

public class Alien9800ReaderSession
extends AbstractPollIPSensorSession
implements AlienCommandConstants

A session that connects to an Alien9800Reader

Author:

Jochen Mader - jochen@pramari.com, Kyle Neumeier - kyle@pramari.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NEWLINE Each command needs to be terminated with a newline.
static java.lang.String	WELCOME Welcome string.

Fields inherited from interface org.rifidi.edge.adapter.alien.AlienCommandConstants

ANTENNA_SEQUENCE_COMMAND, COMMAND_ANTENNA_SEQUENCE, COMMAND_DHCP, COMMAND_DNS, COMMAND_EXTERNAL_INPUT, COMMAND_EXTERNAL_OUTPUT, COMMAND_GATEWAY, COMMAND_HEARTBEAT_ADDRESS, COMMAND_HEARTBEAT_COUNT, COMMAND_HEARTBEAT_PORT, COMMAND_HEARTBEAT_TIME, COMMAND_INVERT_EXTERNAL_INPUT, COMMAND_INVERT_EXTERNAL_OUTPUT, COMMAND_IPADDRESS, COMMAND_MAC_ADDRESS, COMMAND_MAX_ANTENNA, COMMAND_NETMASK, COMMAND_NETWORK_TIMEOUT, COMMAND_PASSWORD, COMMAND_PERSIST_TIME, COMMAND_READER_TYPE, COMMAND_READER_VERSION, COMMAND_READERNAME, COMMAND_READERNUMBER, COMMAND_RF_ATTENUATION, COMMAND_TAG_LIST, COMMAND_TAG_LIST_CUSTOM_FORMAT, COMMAND_TAG_LIST_FORMAT, COMMAND_TAG_TYPE, COMMAND_TIME, COMMAND_TIME_SERVER, COMMAND_TIME_ZONE, COMMAND_UPTIME, COMMAND_USERNAME, COOMMAND_COMMAND_PORT, PROMPT_SUPPRESS

Constructor Summary

Constructors

Constructor and Description
Alien9800ReaderSession(AbstractSensor<?> sensor, java.lang.String id, java.lang.String host, int port, int notifyPort, int ioStreamPort, int reconnectionInterval, int maxConAttempts, java.lang.String username, java.lang.String password, NotifierService notifierService, java.lang.String readerID, java.util.Set<AbstractCommandConfiguration<?>> commands) 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.
void	flashOutput(java.util.BitSet ports, java.util.BitSet finalPorts, int timeOn, int timeOff, int repeat) This method flashes the given output ports high for a given amount of time.
int	getExternalInput() helper method that sends a 'get externalInput' command to the reader.
MessageParsingStrategyFactory	getMessageParsingStrategyFactory() Get a factory for MessageParsingStrategy objects
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(ByteMessage message) Send a message over the line.
void	setOutputPort(java.util.BitSet ports) This method sets the External Output high for the given ports
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	testInputPort(int port) This method tests if a given input port is high
java.lang.String	toString()

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

getMessageProcessingStrategyFactory, isMessageAvailable, receiveMessage, receiveMessage

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

Field Detail

NEWLINE

public static final java.lang.String NEWLINE

Each command needs to be terminated with a newline.

See Also:

Constant Field Values

WELCOME

public static final java.lang.String WELCOME

Welcome string.

See Also:

Constant Field Values

Constructor Detail

Alien9800ReaderSession

public Alien9800ReaderSession(AbstractSensor<?> sensor,
                              java.lang.String id,
                              java.lang.String host,
                              int port,
                              int notifyPort,
                              int ioStreamPort,
                              int reconnectionInterval,
                              int maxConAttempts,
                              java.lang.String username,
                              java.lang.String password,
                              NotifierService notifierService,
                              java.lang.String readerID,
                              java.util.Set<AbstractCommandConfiguration<?>> commands)

Constructor

Parameters:

sensor -

id - The FACTORY_ID of the session

host - The IP to connect to

port - The port to connect to

notifyPort - The port to use as a autonomous notify port

reconnectionInterval - The wait time between reconnect attempts

maxConAttempts - The maximum number of times to try to connect

username - The Alien username

password - The Alien password

destination - The JMS destination for tags

template - The JSM template for tags

notifierService - The service for sending client notifications

readerID - The FACTORY_ID of the reader that created this session

commands - A thread safe set containing all available commands

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

disconnect

public void disconnect()

Description copied from class: SensorSession

Close the connection and stop processing of commands.

Overrides:

disconnect in class AbstractIPSensorSession

sendMessage

public void sendMessage(ByteMessage message)
                 throws java.io.IOException

Description copied from class: AbstractIPSensorSession

Send a message over the line. This method is protected so that subclasses can choose whether or not to expose it to clients.

Throws:

java.io.IOException

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

setOutputPort

public void setOutputPort(java.util.BitSet ports)

This method sets the External Output high for the given ports

Parameters:

ports - The ports to set high

testInputPort

public boolean testInputPort(int port)
                      throws CannotExecuteException

This method tests if a given input port is high

Parameters:

port -

Returns:

Throws:

CannotExecuteException

getExternalInput

public int getExternalInput()
                     throws CannotExecuteException

helper method that sends a 'get externalInput' command to the reader. It blocks until the response returns

Returns:

the External Input

Throws:

CannotExecuteException

flashOutput

public void flashOutput(java.util.BitSet ports,
                        java.util.BitSet finalPorts,
                        int timeOn,
                        int timeOff,
                        int repeat)
                 throws CannotExecuteException

This method flashes the given output ports high for a given amount of time. This method executes in a separate thread, so it returns immediately.

Parameters:

ports - The ports to set to high

finalPorts - The configuration of the ports after the flashes are done

timeOn - The time in seconds to set the ports high

timeOff - The time in seconds to set the port low

repeat - The number of times to reapeat the flashes.

Throws:

CannotExecuteException

toString

public java.lang.String toString()

Overrides:

toString in class AbstractIPSensorSession