com.ergotech.secs

Class HSMSSessionManager

java.lang.Object

com.ergotech.secs.SessionManager

com.ergotech.secs.HSMSSessionManager

All Implemented Interfaces:

SimulationListener

public class HSMSSessionManager
extends SessionManager

This object provides the transport layer for HSMS. The nature of the object is largely hidden from the upper levels of the SECS protocol. This object provides all the functionality to send and receive SECS messages over an HSMS link, including the methods to store and retrieve information from the message.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMUNICATION_ALREADY_ACTIVE Select Status - Communications Already Active.
static byte	COMMUNICATION_BUSY Deselect Status - Communication Busy.
static byte	COMMUNICATION_ENDED Deselect Status - Communication Ended.
static byte	COMMUNICATION_ESTABLISHED Select Status - Communications Established.
static byte	COMMUNICATION_NOT_ESTABLISHED Deselect Status - Communication Not Established.
static byte	CONNECTION_EXHAUST Select Status - connections exhausted.
static byte	CONNECTION_NOT_READY Select Status - Connection not ready.
static byte	DATA_MESSAGE Data Message
static byte	DESELECT_REQ Deselect Request
static byte	DESELECT_RES Deselect Response
static byte	ENTITY_IN_USE Select Status - Entity in Use.
static byte	ENTITY_NOT_SELECTED Reason Code for Reject Message - Entity not supported.
static byte	ENTITY_SELECTED Select Status - Entity selected by current connection.
static byte	LINKTEST_REQ LinkTest Request
static byte	LINKTEST_RES LinkTest Response
static byte	NO_SUCH_ENTITY Select Status - No Such entity.
static byte	PTYPE_NOT_SUPPORTED Reason Code for Reject Message - PType not supported.
static byte	REJECT_REQ Reject Request
static byte	SELECT_REQ Select Request
static byte	SELECT_RES Select Response
boolean	selected The end user should never need to set this.
static byte	SEPARATE_REQ Separate Request
static byte	STYPE_NOT_SUPPORTED Reason Code for Reject Message - SType not supported.
static byte	TRANSACTION_NOT_OPEN Reason Code for Reject Message - Transaction not Supported.

Fields inherited from class com.ergotech.secs.SessionManager

eventListeners, globalSimulation, logger, MULTI_THREADED, primaryThreads, responseThreads, sendErrorMessages, SINGLE_THREADED

Method Summary

Modifier and Type	Method and Description
void	breakConnection() This will break one hsms session, killing whos attached to it.
byte[][]	convertToBytes(SecsMsg msg) Converts a SecsMsg into the raw byte stream.
SecsMsg	createMessage(byte[] unconverted) Creates a SecsMsg from the raw byte stream.
void	deSelectSession() Deselect the session.
void	endSession() End the session.
static byte	getDefaultSelectResponse() Sets the global select response
int	getHeaderSize() Returns the headersize for HSMS messages.
static SessionManager	getNewSessionManager() Return a new session manager object.
byte	getSelectResponse() returns the select response.
int	getSessionId() Returns the session ID.
static int	getSessionId(byte[] unconv) Returns the session ID from the byte stream provide.
static SessionManager	getSessionManager(int port, java.lang.String connectionId, int deviceId, int sessionId, boolean shouldCreate) 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, LoggerInterface theLogger) Returns the session for the given port host and string.
boolean	isSelected() Returns true if the session is selected, otherwise false.
void	selectSession() Select the session.
boolean	sendHSMSHeaderMessage(byte byte3, byte sType, int systemBytes, int sessionId) This message creates a message that is only the HSMS header and sends it.
boolean	sendHSMSHeaderMessage(byte byte3, byte sType, int sID, SecsMsg sm) This message creates a message that is only the HSMS header and sends it.
void	sendMessage(SecsMsg msg) Sends the SECS Message over the HSMS link.
void	separateSession() Separate the session.
static void	setDefaultSelectResponse(byte defaultSelectResponse) Sets the global select response.
void	setSelectResponse(byte selectResponse) Sets the default response to a select.
void	setSessionId(int newValue) Sets the session ID for this session manager.

Methods inherited from class com.ergotech.secs.SessionManager

addMessageHandler, addToConnection, createSessionManager, createSessionManager, createSessionManager, createSessionManager, getConnectionManager, getDefault, getDeviceId, getExpectsReply, getIsHost, getLogger, getMessageHandlers, getPortManager, getReplyTimeout, getSessionManager, getSessionManager, getThreadingModel, getWaitingMessages, isDefault, isSimulating, isSimulationFlag, isValid, isValidHostCommandMessage, removeMessageHandler, reprocessMessage, setDefault, setDefault, setDeviceId, setIsHost, setLogger, setMessageHandlers, setReplyTimeout, setSimulationFlag, setThreadingModel, setValid, simulationStateChanged, toString

Methods inherited from class java.lang.Object

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

Field Detail

COMMUNICATION_ALREADY_ACTIVE

public static final byte COMMUNICATION_ALREADY_ACTIVE

Select Status - Communications Already Active.

See Also:

Constant Field Values

COMMUNICATION_BUSY

public static final byte COMMUNICATION_BUSY

Deselect Status - Communication Busy.

See Also:

Constant Field Values

COMMUNICATION_ENDED

public static final byte COMMUNICATION_ENDED

Deselect Status - Communication Ended.

See Also:

Constant Field Values

COMMUNICATION_ESTABLISHED

public static final byte COMMUNICATION_ESTABLISHED

Select Status - Communications Established.

See Also:

Constant Field Values

COMMUNICATION_NOT_ESTABLISHED

public static final byte COMMUNICATION_NOT_ESTABLISHED

Deselect Status - Communication Not Established.

See Also:

Constant Field Values

CONNECTION_EXHAUST

public static final byte CONNECTION_EXHAUST

Select Status - connections exhausted.

See Also:

Constant Field Values

CONNECTION_NOT_READY

public static final byte CONNECTION_NOT_READY

Select Status - Connection not ready.

See Also:

Constant Field Values

DATA_MESSAGE

public static final byte DATA_MESSAGE

Data Message

See Also:

Constant Field Values

DESELECT_REQ

public static final byte DESELECT_REQ

Deselect Request

See Also:

Constant Field Values

DESELECT_RES

public static final byte DESELECT_RES

Deselect Response

See Also:

Constant Field Values

ENTITY_IN_USE

public static final byte ENTITY_IN_USE

Select Status - Entity in Use.

See Also:

Constant Field Values

ENTITY_NOT_SELECTED

public static final byte ENTITY_NOT_SELECTED

Reason Code for Reject Message - Entity not supported.

See Also:

Constant Field Values

ENTITY_SELECTED

public static final byte ENTITY_SELECTED

Select Status - Entity selected by current connection.

See Also:

Constant Field Values

LINKTEST_REQ

public static final byte LINKTEST_REQ

LinkTest Request

See Also:

Constant Field Values

LINKTEST_RES

public static final byte LINKTEST_RES

LinkTest Response

See Also:

Constant Field Values

NO_SUCH_ENTITY

public static final byte NO_SUCH_ENTITY

Select Status - No Such entity.

See Also:

Constant Field Values

PTYPE_NOT_SUPPORTED

public static final byte PTYPE_NOT_SUPPORTED

Reason Code for Reject Message - PType not supported.

See Also:

Constant Field Values

REJECT_REQ

public static final byte REJECT_REQ

Reject Request

See Also:

Constant Field Values

SELECT_REQ

public static final byte SELECT_REQ

Select Request

See Also:

Constant Field Values

SELECT_RES

public static final byte SELECT_RES

Select Response

See Also:

Constant Field Values

selected

public boolean selected

The end user should never need to set this. Setting it is violation of the HSMS specification. It is pubic only to allow people to hack around clients that are not HSMS compliant.

SEPARATE_REQ

public static final byte SEPARATE_REQ

Separate Request

See Also:

Constant Field Values

STYPE_NOT_SUPPORTED

public static final byte STYPE_NOT_SUPPORTED

Reason Code for Reject Message - SType not supported.

See Also:

Constant Field Values

TRANSACTION_NOT_OPEN

public static final byte TRANSACTION_NOT_OPEN

Reason Code for Reject Message - Transaction not Supported.

See Also:

Constant Field Values

Method Detail

breakConnection

public void breakConnection()
                     throws SecsException

This will break one hsms session, killing whos attached to it.

Overrides:

breakConnection in class SessionManager

Throws:

SecsException

convertToBytes

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

Converts a SecsMsg into the raw byte stream. The return is a two dimensional array since the message may need to be broken into multiple blocks to be acceptable for some protocols.

Specified by:

convertToBytes in class SessionManager

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 SecsMsg createMessage(byte[] unconverted)
                      throws SecsException

Creates a SecsMsg from the raw byte stream.

Specified by:

createMessage in class SessionManager

Returns:

A SecsMsg object containing the information contained in the bytestream.

Throws:

SecsException

See Also:

SecsMsg.getData()

deSelectSession

public void deSelectSession()
                     throws SecsException

Deselect the session.

Throws:

SecsException

endSession

public void endSession()

End the session. If the session is General Session then a deselect will be sent. If session is the last selected Single Session then a separate request will be sent.

Overrides:

endSession in class SessionManager

getDefaultSelectResponse

public static byte getDefaultSelectResponse()

Sets the global select response

Returns:

Returns the defaultSelectResponse.

getHeaderSize

public int getHeaderSize()

Returns the headersize for HSMS messages.

Specified by:

getHeaderSize in class SessionManager

Returns:

10

getNewSessionManager

public static SessionManager getNewSessionManager()

Return a new session manager object. This method returns a new HSMSSessionManager.

getSelectResponse

public byte getSelectResponse()

returns the select response.

Returns:

the select response

See Also:

setSelectResponse(byte)

getSessionId

public int getSessionId()

Returns the session ID.

Returns:

the session ID

getSessionId

public static int getSessionId(byte[] unconv)

Returns the session ID from the byte stream provide.

Returns:

the session ID

getSessionManager

public static SessionManager getSessionManager(int port,
                                               java.lang.String connectionId,
                                               int deviceId,
                                               int sessionId,
                                               boolean shouldCreate)
                                        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,
                                               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

isSelected

public boolean isSelected()

Returns true if the session is selected, otherwise false.

Returns:

the selected status

selectSession

public void selectSession()
                   throws SecsException

Select the session. This is normally handled automatically, use with care.

Throws:

SecsException

sendHSMSHeaderMessage

public boolean sendHSMSHeaderMessage(byte byte3,
                                     byte sType,
                                     int systemBytes,
                                     int sessionId)
                              throws SecsException

This message creates a message that is only the HSMS header and sends it.

Throws:

SecsException

sendHSMSHeaderMessage

public boolean sendHSMSHeaderMessage(byte byte3,
                                     byte sType,
                                     int sID,
                                     SecsMsg sm)
                              throws SecsException

This message creates a message that is only the HSMS header and sends it.

Throws:

SecsException

sendMessage

public void sendMessage(SecsMsg msg)
                 throws SecsException

Description copied from class: SessionManager

Sends the SECS Message over the HSMS link.

Specified by:

sendMessage in class SessionManager

Throws:

SecsException

separateSession

public void separateSession()
                     throws SecsException

Separate the session.

Throws:

SecsException

setDefaultSelectResponse

public static void setDefaultSelectResponse(byte defaultSelectResponse)

Sets the global select response. WARNING, setting this to a non-zero value will cause ALL selects to fail with whichever code is provided.

Parameters:

defaultSelectResponse - The defaultSelectResponse to set.

setSelectResponse

public void setSelectResponse(byte selectResponse)

Sets the default response to a select. The default select response can be set to non-zero to indicate the status of the session manager. If non-zero this response will be given in response to a select message. This allows the creation of a session manager that will not accept a select, that is, a session manager that will reject an attempt to go to the selected state. This includes the second session manager for an HSMS-SS connection, and when too many connections have been accepted, as well as a session manager on an invalid session and other cases.

setSessionId

public void setSessionId(int newValue)

Sets the session ID for this session manager.