com.ergotech.secs

Class PortManager

java.lang.Object

com.ergotech.secs.PortManager

Direct Known Subclasses:

HSMSSocketManager, SecsISocketManager, SerialPortManager, TerminalServerPortManager

public abstract class PortManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	allIDsValid Whether to allow all device ids.
static java.lang.String	cvsRev

Method Summary

Modifier and Type	Method and Description
void	addDeviceId(int deviceId, java.lang.Object messageHandlerObject) Add a message handler for a specified session id.
static void	addPortManager(PortManager portManager) Adds a new port manager.
abstract int	available() Returns the number of bytes available.
abstract void	close() Close the port.
ConnectionManager	getConnectionManager() Returns the current connection.
static ConnectionManager	getConnectionManagerForId(int testPort, java.lang.String id) Returns a connection manager for the provided ID.
java.lang.String	getId() This id is a string which, together with the port number uniquely identifies this port manager.
LoggerInterface	getLogger() Returns the current logger object.
java.util.Vector<java.lang.Object>	getMessageHandlersForId(int sessionId) Get a message handler for a particular ID.
int	getPort() Returns the port.
static PortManager	getPortManagerForId(int testPort, java.lang.String id) Returns a connection manager for the provided ID.
static java.util.Vector<PortManager>	getPortManagers() Returns the current vector of port managers.
byte	read() Read the port.
abstract int	read(byte[] b, int off, int len) Read the port.
void	removeDeviceId(int deviceId, java.lang.Object messageHandlerObject) Add a message handler for a specified session id.
static void	removePortManager(PortManager portManager) Remove a port manager.
void	removeSessionId(int sessionId) Remove a message handler for a specified session id.
void	setConnectionManager(ConnectionManager cm) Sets the connection manager for this connection.
void	setLogger(LoggerInterface newLogger) Register a logger.
void	setPort(int newPort) sets the port.
void	write(byte b) Writes the byte to the port.
abstract void	write(byte[] b) Writes the array to the port.

Methods inherited from class java.lang.Object

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

Field Detail

allIDsValid

public static boolean allIDsValid

Whether to allow all device ids.

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Method Detail

addDeviceId

public void addDeviceId(int deviceId,
                        java.lang.Object messageHandlerObject)

Add a message handler for a specified session id.

addPortManager

public static void addPortManager(PortManager portManager)

Adds a new port manager.

available

public abstract int available()
                       throws java.io.IOException

Returns the number of bytes available.

Returns:

is.available()

Throws:

java.io.IOException

close

public abstract void close()
                    throws java.io.IOException

Close the port. This closes the port.

Throws:

java.io.IOException

getConnectionManager

public ConnectionManager getConnectionManager()

Returns the current connection.

getConnectionManagerForId

public static ConnectionManager getConnectionManagerForId(int testPort,
                                                          java.lang.String id)

Returns a connection manager for the provided ID.

Parameters:

testPort - the port to compare against

id - the unique id of this port manager. This will be a hostname of HSMS.

Returns:

the connection manager or null if no connection manager matches the criteria

getId

public java.lang.String getId()

This id is a string which, together with the port number uniquely identifies this port manager. This default implementation will return the String "NO ID" for port managers that do not require the id for uniqueness. An example of this is the SecsI SerialPortManager.

Returns:

the id of this port manager.

getLogger

public LoggerInterface getLogger()

Returns the current logger object.

getMessageHandlersForId

public java.util.Vector<java.lang.Object> getMessageHandlersForId(int sessionId)

Get a message handler for a particular ID. Returns null if the handler does not exist.

getPort

public int getPort()

Returns the port.

getPortManagerForId

public static PortManager getPortManagerForId(int testPort,
                                              java.lang.String id)

Returns a connection manager for the provided ID.

Parameters:

testPort - the port to compare against

id - the unique id of this port manager. This will be a hostname of HSMS.

Returns:

the connection manager or null if no connection manager matches the criteria

getPortManagers

public static java.util.Vector<PortManager> getPortManagers()

Returns the current vector of port managers.

read

public byte read()
          throws java.io.IOException

Read the port.

Throws:

java.io.IOException

See Also:

read

read

public abstract int read(byte[] b,
                         int off,
                         int len)
                  throws java.io.IOException

Read the port.

Throws:

java.io.IOException

See Also:

read

removeDeviceId

public void removeDeviceId(int deviceId,
                           java.lang.Object messageHandlerObject)

Add a message handler for a specified session id.

removePortManager

public static void removePortManager(PortManager portManager)

Remove a port manager.

removeSessionId

public void removeSessionId(int sessionId)

Remove a message handler for a specified session id.

setConnectionManager

public void setConnectionManager(ConnectionManager cm)

Sets the connection manager for this connection.

setLogger

public void setLogger(LoggerInterface newLogger)

Register a logger.

Parameters:

newLogger - the new logger object

setPort

public void setPort(int newPort)
             throws java.io.IOException

sets the port.

Throws:

java.io.IOException

write

public void write(byte b)
           throws java.io.IOException

Writes the byte to the port.

Throws:

java.io.IOException

write

public abstract void write(byte[] b)
                    throws java.io.IOException

Writes the array to the port.

Throws:

java.io.IOException