com.ergotech.secs

Interface WrapperInterface

All Superinterfaces:

java.util.EventListener, SecsEventListener, java.io.Serializable

All Known Implementing Classes:

HSMSActiveWrapper, HSMSPassiveWrapper, HSMSWrapper, SecsIWrapper, TerminalServerWrapper

public interface WrapperInterface
extends java.io.Serializable, SecsEventListener

This is the interface for the wrappers. It is implemented for HSMS and for SECSI.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	addMessageHandler(java.lang.Object theMessageHandler) Add a message handler object.
void	addMessageHandler(java.io.Serializable theMessageHandler) Add a message handler object.
boolean	connect() Connected the session.
void	disconnect() Disconnected the session.
int	getDeviceId() Returns the current device id.
LoggerInterface	getLogger() Returns the current logger.
java.util.List<java.lang.Object>	getMessageHandlers() Return the list of message handlers.
int	getPort() Returns the current TCP/IP port.
PortManager	getPortManager() Returns the port manager for the wrapper.
SessionManager	getSessionManager() This will return the session manager if one exists.
SessionManager	getSessionManager(int deviceId) return the session manager for the provided device id.
double	getT3() Returns the reply timeout.
boolean	initializeConnection() Connected the session.
void	removeMessageHandler(java.lang.Object theMessageHandler) Remove a message handler object.
void	setActive(boolean flag) Determines whether newly created sessions should be set to the active session.
void	setDefault(boolean flag) Determines whether newly created sessions should be set to the default session.
void	setDeviceId(int newValue) this sets the current device id.
void	setLogger(LoggerInterface theLogger) Sets the logger for the current connection.
void	setPortManager(PortManager pm) Sets the port manager for the wrapper.
void	setT3(double t3) Sets the reply timeout.

Methods inherited from interface com.ergotech.secs.SecsEventListener

secsEvent

Field Detail

cvsRev

static final java.lang.String cvsRev

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

addMessageHandler

void addMessageHandler(java.lang.Object theMessageHandler)

Add a message handler object. This will be added to all future session managers that are created. It will not be added to existing session managers.

Parameters:

theMessageHandler - the message handler to add

See Also:

SecsMsg.processSelf(java.lang.Object)

addMessageHandler

void addMessageHandler(java.io.Serializable theMessageHandler)

Add a message handler object. This will be added to all future session managers that are created. It will not be added to existing session managers.

Parameters:

theMessageHandler - the message handler to add

See Also:

SecsMsg.processSelf(java.lang.Object)

connect

boolean connect()

Connected the session. Use initializeConnection instead it provides an exception indicating the reason for failure.

disconnect

void disconnect()

Disconnected the session.

getDeviceId

int getDeviceId()

Returns the current device id.

Returns:

the device id.

getLogger

LoggerInterface getLogger()

Returns the current logger.

Returns:

the current logger.

getMessageHandlers

java.util.List<java.lang.Object> getMessageHandlers()

Return the list of message handlers.

getPort

int getPort()

Returns the current TCP/IP port.

Returns:

the TCP/IP port.

getPortManager

PortManager getPortManager()

Returns the port manager for the wrapper. May be null if there is no connection.

Returns:

the port manager.

getSessionManager

SessionManager getSessionManager()

This will return the session manager if one exists. null if not.

getSessionManager

SessionManager getSessionManager(int deviceId)

return the session manager for the provided device id.

getT3

double getT3()

Returns the reply timeout.

initializeConnection

boolean initializeConnection()
                      throws SecsException

Connected the session.

Throws:

SecsException

removeMessageHandler

void removeMessageHandler(java.lang.Object theMessageHandler)

Remove a message handler object.

Parameters:

theMessageHandler - the message handler to add

See Also:

SecsMsg.processSelf(java.lang.Object)

setActive

void setActive(boolean flag)

Determines whether newly created sessions should be set to the active session.

Parameters:

flag - true if created session should be made the active session.

See Also:

SessionManager#setActive

setDefault

void setDefault(boolean flag)

Determines whether newly created sessions should be set to the default session.

Parameters:

flag - true if created session should be made the default session.

See Also:

SessionManager.setDefault()

setDeviceId

void setDeviceId(int newValue)

this sets the current device id. It will also make sure that the session mananger exists/created at that moment.

See Also:

getDeviceId.

setLogger

void setLogger(LoggerInterface theLogger)

Sets the logger for the current connection. This logger will be added to all future sessions created, it will not be set to existing sessions.

Parameters:

theLogger - the logger to add.

setPortManager

void setPortManager(PortManager pm)

Sets the port manager for the wrapper. May be null if there is no connection.

Parameters:

the - port manager.

setT3

void setT3(double t3)

Sets the reply timeout.