gov.va.med.vistalink.adapter.spi

Class VistaSocketConnection

Object

SocketManager

VistaSocketConnection

All Implemented Interfaces:

Serializable

public class VistaSocketConnection
extends SocketManager

This class represents a raw socket connection to a M-Server

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLOSE_SOCKET_REQUEST The xml request used to send a close request to M

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VistaSocketConnection(InetAddress address, int port, String mcIdentifier)

Method Summary

Modifier and Type	Method and Description
void	close() Sends a close request to M.
void	close(boolean notifyM) Closes the socket.
void	closeDontNotify() Closes the socket.
protected void	finalize() Precautionary code to clean-up socket connections in J2SE environment.
InetAddress	getAddress()
int	getPort()
void	setTransferTimeOut(int timeout) Sets the time out for socket send/read operations.
String	toString()
String	transfer(String request) Sends the request to M and returns the response.

Methods inherited from class SocketManager

getBufferSize, getMatchingIdentifier, getSoc, receiveData, sendData, setBufferSize, setMatchingIdentifier, setSoc

Methods inherited from class Object

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

Field Detail

CLOSE_SOCKET_REQUEST

protected static final String CLOSE_SOCKET_REQUEST

The xml request used to send a close request to M

See Also:

Constant Field Values

Constructor Detail

VistaSocketConnection

protected VistaSocketConnection(InetAddress address,
                                int port,
                                String mcIdentifier)
                         throws VistaSocketException

Parameters:

address -

port -

Throws:

VistaSocketException

Method Detail

transfer

public String transfer(String request)
                throws VistaSocketTimeOutException,
                       VistaSocketException

Sends the request to M and returns the response. Also audits time it takes to make both transfers.

Parameters:

request -

Returns:

String

Throws:

VistaSocketTimeOutException

VistaSocketException

close

public void close()
           throws VistaSocketException

Sends a close request to M. Closes the socket. Sets the socket to null.

Throws:

VistaSocketException

closeDontNotify

public void closeDontNotify()
                     throws VistaSocketException

Closes the socket. Sets the socket to null. Does NOT send a close request to M.

Throws:

VistaSocketException

close

public void close(boolean notifyM)
           throws VistaSocketException

Closes the socket. Sets the socket to null. Does NOT send a close request to M if notifyM parameter is set to false.

Parameters:

notifyM - - indicates where the M server should be notified if that the socket is closing

Throws:

VistaSocketException

getAddress

public InetAddress getAddress()

Returns:

InetAddress

getPort

public int getPort()

Returns:

int

setTransferTimeOut

public void setTransferTimeOut(int timeout)
                        throws VistaSocketException

Sets the time out for socket send/read operations.

Parameters:

timeout -

Throws:

VistaSocketException

finalize

protected void finalize()
                 throws Throwable

Precautionary code to clean-up socket connections in J2SE environment.

In application server spi.ManagedConnection:destroy() will be called to clean-up connections, hence this method will not be performing socket clean-up.

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

toString

public final String toString()

Overrides:

toString in class SocketManager

Returns:

String representation of this object.