com.ergotech.secs

Class SessionManager

java.lang.Object

com.ergotech.secs.SessionManager

All Implemented Interfaces:

SimulationListener

Direct Known Subclasses:

HSMSSessionManager, SecsISessionManager

public abstract class SessionManager
extends java.lang.Object
implements SimulationListener

The session manager object is the superclass of the specific session managers. It provides a consistent interface to the session manager and isolates the SECS implementation from the transport layer, for example SECS1 or HSMS.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Vector	eventListeners The event listeners for this session.
static boolean	globalSimulation This variable will be true if we are simulating.
LoggerInterface	logger The logger used for this session manager.
static int	MULTI_THREADED
static int	primaryThreads
static int	responseThreads
boolean	sendErrorMessages Whether we send the S9Fx messages for unknown streams and functions.
static int	SINGLE_THREADED

Constructor Summary

Constructors

Constructor and Description
SessionManager() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addMessageHandler(java.lang.Object newMessageHandler) Adds a new message handle object.
void	addToConnection(ConnectionManager newConnectionManager) Add the session from the provided connection.
void	breakConnection() This will close a connection.
abstract byte[][]	convertToBytes(SecsMsg msg) Convert a SecsMsg to a byte stream suitable for passing through whatever port we are using.
abstract SecsMsg	createMessage(byte[] unconverted) This method will convert the provided byte stream into a secs message.
static SessionManager	createSessionManager(ConnectionManager cm, int deviceId, int sessionId) Returns the session for the given connection manager.
static SessionManager	createSessionManager(ConnectionManager cm, int deviceId, int sessionId, LoggerInterface theLogger) Returns the session for the given connection manager.
static SessionManager	createSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, java.lang.Class portManagerClass) Returns the session for the given port host and string.
static SessionManager	createSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, java.lang.Class portManagerClass, LoggerInterface theLogger) Returns the session for the given port host and string.
void	endSession() End the session.
ConnectionManager	getConnectionManager() Set the connection manager.
static SessionManager	getDefault() Returns the port manager that will be the default active port on a new thread.
int	getDeviceId() Returns the device id.
int	getExpectsReply(byte[] unconv) Returns true if the message expects a reply, otherwise false.
abstract int	getHeaderSize() Get the header size for this port.
boolean	getIsHost() Returns true if this session manager is capable of sending host (primary) messages.
LoggerInterface	getLogger() Returns the current logger object.
java.util.Vector<java.lang.Object>	getMessageHandlers() Returns the current message handlers.
static SessionManager	getNewSessionManager() Return a new session manager object.
PortManager	getPortManager() This will return the port manager for this session
double	getReplyTimeout() Returns the T3 timeout.
static SessionManager	getSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, boolean shouldCreate, java.lang.Class portManagerClass) Returns the session for the given port host and string.
static SessionManager	getSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, boolean shouldCreate, java.lang.Class portManagerClass, LoggerInterface theLogger) Returns the session for the given port host and string.
static int	getThreadingModel() Retur the current threading model.
java.util.Hashtable<java.lang.Object,SecsMsg>	getWaitingMessages() Returns a Hashtable of messages waiting for an acknowledgment or a response.
boolean	isDefault() Returns true if this port manager is the default active port manager.
boolean	isSimulating()
boolean	isSimulationFlag()
boolean	isValid()
boolean	isValidHostCommandMessage(SecsMsg msgIn) host command - must have at least this structure.
void	removeMessageHandler(java.lang.Object oldMessageHandler) Removes a new message handle object.
boolean	reprocessMessage(SecsMsg msg) This allows for a messages to be processed as though it had been received.
abstract void	sendMessage(SecsMsg msg) Sends the SECS Message over the HSMS link.
void	setDefault() Set this session manager to be the default session manager.
void	setDefault(SessionManager sm) Set this session manager to be the default session manager.
void	setDeviceId(int newValue) Sets the device id for this port manager.
void	setIsHost(boolean newValue) Sets whether this session manager is capable of sending host (primary) messages.
void	setLogger(LoggerInterface newLogger) Register a logger.
void	setMessageHandlers(java.util.Vector<java.lang.Object> newMessageHandlers) Replaces all the current message handle objects with those contained in the vector.
void	setReplyTimeout(double newT3) Sets the T3 timeout.
void	setSimulationFlag(boolean simulationFlag) Sets the state of the simulation flag.
static void	setThreadingModel(int model) Set the threading model.
void	setValid(boolean isValid)
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Changes the state of the simulation mode.
java.lang.String	toString() Returns a description of this session manager.

Methods inherited from class java.lang.Object

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

Field Detail

eventListeners

public java.util.Vector eventListeners

The event listeners for this session.

globalSimulation

public static boolean globalSimulation

This variable will be true if we are simulating. This defaults to simulating.

logger

public LoggerInterface logger

The logger used for this session manager.

MULTI_THREADED

public static final int MULTI_THREADED

See Also:

Constant Field Values

primaryThreads

public static int primaryThreads

responseThreads

public static int responseThreads

sendErrorMessages

public boolean sendErrorMessages

Whether we send the S9Fx messages for unknown streams and functions.

SINGLE_THREADED

public static final int SINGLE_THREADED

See Also:

Constant Field Values

Constructor Detail

SessionManager

public SessionManager()

The default constructor.

Method Detail

addMessageHandler

public void addMessageHandler(java.lang.Object newMessageHandler)

Adds a new message handle object. The message handler objects will receive selected or all messages based on the methods implemented by the object passed. Whenever a message is received at the port it will call processSelf on the SecsMsg returned from createMessage using this object as the argument.

Parameters:

an - object that will receive the messages.

See Also:

createMessage(byte[]), SecsMsg.processSelf(java.lang.Object)

addToConnection

public void addToConnection(ConnectionManager newConnectionManager)
                     throws java.util.TooManyListenersException

Add the session from the provided connection. A session should be added to exactly one connection.

Throws:

java.util.TooManyListenersException - if there is already a connection manager set

breakConnection

public void breakConnection()
                     throws SecsException

This will close a connection.

Throws:

SecsException

convertToBytes

public abstract byte[][] convertToBytes(SecsMsg msg)
                                 throws SecsException

Convert a SecsMsg to a byte stream suitable for passing through whatever port we are using. That is, the converted message should contain header information, etc. in preparation for sending. The exact implementation is dependent upon the port.

Returns:

a two dimensional array containing the converted form of the SecsMsg. The array contains the message broken into different segments if necessary.

Throws:

SecsException

createMessage

public abstract SecsMsg createMessage(byte[] unconverted)
                               throws SecsException

This method will convert the provided byte stream into a secs message. It will create the message, fill in the header information and the data. The data is not converted by the port manager (or by the SecsMsg at this point).

Returns:

A SecsMsg object containing the information contained in the bytestream.

Throws:

SecsException

See Also:

SecsMsg.getData()

createSessionManager

public static SessionManager createSessionManager(ConnectionManager cm,
                                                  int deviceId,
                                                  int sessionId)
                                           throws SecsException

Returns the session for the given connection manager.

Parameters:

cm - the connection manager

session - ID for HSMS, ignored for SECS1

deviceId - the device id

Throws:

SecsException

createSessionManager

public static SessionManager createSessionManager(ConnectionManager cm,
                                                  int deviceId,
                                                  int sessionId,
                                                  LoggerInterface theLogger)
                                           throws SecsException

Returns the session for the given connection manager.

Parameters:

cm - the connection manager

session - ID for HSMS, ignored for SECS1

deviceId - the device id

theLogger - the logger object

Throws:

SecsException

createSessionManager

public static SessionManager createSessionManager(int port,
                                                  java.lang.String connectionId,
                                                  int deviceId,
                                                  int sessionId,
                                                  java.lang.Class portManagerClass)
                                           throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

Throws:

SecsException

createSessionManager

public static SessionManager createSessionManager(int port,
                                                  java.lang.String connectionId,
                                                  int deviceId,
                                                  int sessionId,
                                                  java.lang.Class portManagerClass,
                                                  LoggerInterface theLogger)
                                           throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

theLogger - the Logger object

Throws:

SecsException

endSession

public void endSession()

End the session. This will stop the timeout timer, clear all waiting messages and remove this session manager as a listener from the simulation manager and mark the session as invalid (isValid = false)

getConnectionManager

public ConnectionManager getConnectionManager()

Set the connection manager.

getDefault

public static SessionManager getDefault()

Returns the port manager that will be the default active port on a new thread.

Returns:

the default SessionManager.

getDeviceId

public int getDeviceId()

Returns the device id. This could be the device id for HSMS or the Device ID for SECS1.

Returns:

the device id

getExpectsReply

public int getExpectsReply(byte[] unconv)

Returns true if the message expects a reply, otherwise false. This determination is made be examining the W-bit which is the high bit of the third byte of the message.

getHeaderSize

public abstract int getHeaderSize()

Get the header size for this port. This is used by a SecsMsg as on offset into the message bytes. The offset at getHeaderSize() should be the first element of the data.

getIsHost

public boolean getIsHost()

Returns true if this session manager is capable of sending host (primary) messages. This always returns true for HSMS.

getLogger

public LoggerInterface getLogger()

Returns the current logger object.

getMessageHandlers

public java.util.Vector<java.lang.Object> getMessageHandlers()

Returns the current message handlers.

Returns:

the messageHandlers

getNewSessionManager

public static SessionManager getNewSessionManager()

Return a new session manager object. The default method returns null.

getPortManager

public PortManager getPortManager()

This will return the port manager for this session

getReplyTimeout

public double getReplyTimeout()

Returns the T3 timeout.

getSessionManager

public static SessionManager getSessionManager(int port,
                                               java.lang.String connectionId,
                                               int deviceId,
                                               int sessionId,
                                               boolean shouldCreate,
                                               java.lang.Class portManagerClass)
                                        throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

Throws:

SecsException

getSessionManager

public static SessionManager getSessionManager(int port,
                                               java.lang.String connectionId,
                                               int deviceId,
                                               int sessionId,
                                               boolean shouldCreate,
                                               java.lang.Class portManagerClass,
                                               LoggerInterface theLogger)
                                        throws SecsException

Returns the session for the given port host and string.

Parameters:

port - the port identifier. The socket port for HSMS and arbitrary designation for SECS1.

connectionId - the host name for HSMS, ignored for SECS1

deviceId - the device id

theLogger - the logger object

Throws:

SecsException

getThreadingModel

public static int getThreadingModel()

Retur the current threading model.

Returns:

getWaitingMessages

public java.util.Hashtable<java.lang.Object,SecsMsg> getWaitingMessages()

Returns a Hashtable of messages waiting for an acknowledgment or a response. When a message comes in, each of these will be asked if it would like to respond to the message.

isDefault

public boolean isDefault()

Returns true if this port manager is the default active port manager.

Returns:

true if this port manager is the default active port manager.

isSimulating

public boolean isSimulating()

Returns:

Returns the simulation.

isSimulationFlag

public boolean isSimulationFlag()

Returns:

Returns the simulation.

isValid

public boolean isValid()

Returns:

the isValid

isValidHostCommandMessage

public boolean isValidHostCommandMessage(SecsMsg msgIn)

host command - must have at least this structure. S2F41 W > > > > .

Parameters:

messageData -

Returns:

true if the message is a valid host command message. That must be an S2F41 or S2F49 and the structure must match a host command message.

removeMessageHandler

public void removeMessageHandler(java.lang.Object oldMessageHandler)

Removes a new message handle object.

Parameters:

oldMessageHandler - the message handler to remove

See Also:

addMessageHandler(java.lang.Object), setMessageHandlers(java.util.Vector<java.lang.Object>)

reprocessMessage

public boolean reprocessMessage(SecsMsg msg)
                         throws SecsException

This allows for a messages to be processed as though it had been received. It is provide to allow message substitution, or just to simulated the reception of a hand-created message. Note that if the session manager of the message is null, it will be set to be this session manager. However no other modifications are made, in particular, the system bytes, device Id and so on of the message are not checked.

Throws:

SecsException

sendMessage

public abstract void sendMessage(SecsMsg msg)
                          throws SecsException

Sends the SECS Message over the HSMS link.

Throws:

SecsException

setDefault

public void setDefault()

Set this session manager to be the default session manager. The default session manager will be used for any message that doesn't have a session manager.

setDefault

public void setDefault(SessionManager sm)

Set this session manager to be the default session manager. The default session manager will be used for any message that doesn't have a session manager.

setDeviceId

public void setDeviceId(int newValue)

Sets the device id for this port manager. This could be the device id for HSMS or the Device ID for SECS1.

setIsHost

public void setIsHost(boolean newValue)

Sets whether this session manager is capable of sending host (primary) messages.

Parameters:

newValue - true if this is the host. This value is ignored for HSMS.

setLogger

public void setLogger(LoggerInterface newLogger)

Register a logger.

Parameters:

newLogger - the new logger object

setMessageHandlers

public void setMessageHandlers(java.util.Vector<java.lang.Object> newMessageHandlers)

Replaces all the current message handle objects with those contained in the vector. The message handler objects receive selected or all messages based on the methods implemented by the object passed. Whenever a message is received at the port it will call processSelf on the SecsMsg returned from createMessage using this object as the argument.

Parameters:

an - object that will receive the messages.

See Also:

createMessage(byte[]), SecsMsg.processSelf(java.lang.Object)

setReplyTimeout

public void setReplyTimeout(double newT3)

Sets the T3 timeout.

setSimulationFlag

public void setSimulationFlag(boolean simulationFlag)

Sets the state of the simulation flag.

Specified by:

setSimulationFlag in interface SimulationListener

Parameters:

simulationFlag - will be written as "false" when code is generated.

setThreadingModel

public static void setThreadingModel(int model)
                              throws java.lang.IndexOutOfBoundsException

Set the threading model.

Parameters:

model - 0 for single threaded. Currently anything else is multi-threaded.

Throws:

java.lang.IndexOutOfBoundsException

setValid

public void setValid(boolean isValid)

Parameters:

isValid - the isValid to set

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception

Changes the state of the simulation mode. If this flag is true, then any existing connections will be closed and no new connections will be opened. The flag should be false for normal operation.

Specified by:

simulationStateChanged in interface SimulationListener

Throws:

java.lang.Exception - TODO

toString

public java.lang.String toString()

Returns a description of this session manager. This is the deviceId.

Overrides:

toString in class java.lang.Object

Returns:

the description of this session manager