ca.uhn.hl7v2.app

Class ActiveConnection

java.lang.Object

ca.uhn.hl7v2.app.ActiveConnection

All Implemented Interfaces:

Connection

public class ActiveConnection
extends Object
implements Connection

A TCP/IP connection to a remote HL7 server.

Author:

Bryan Tripp

Constructor Summary

Constructors

Constructor and Description
ActiveConnection(Parser parser, LowerLayerProtocol llp, Socket bidirectional) Creates a new instance of Connection, with inbound and outbound communication on a single port.
ActiveConnection(Parser parser, LowerLayerProtocol llp, Socket bidirectional, ExecutorService executorService)
ActiveConnection(Parser parser, LowerLayerProtocol llp, Socket inbound, Socket outbound) Creates a new instance of Connection, with inbound communication on one port and outbound on another.
ActiveConnection(Parser parser, LowerLayerProtocol llp, Socket inbound, Socket outbound, ExecutorService executorService) Creates a new instance of Connection, with inbound communication on one port and outbound on another.

Method Summary

Modifier and Type	Method and Description
void	activate() Start the receiver thread(s)
void	close() Stops running Receiver threads and closes open sockets
protected HL7Writer	getAckWriter() Returns the HL7Writer through which responses to inbound messages should be sent.
ExecutorService	getExecutorService()
Initiator	getInitiator() Returns the Initiator associated with this connection
Parser	getParser()
InetAddress	getRemoteAddress() Returns the address of the remote host to which this Connection is connected.
Integer	getRemotePort() Returns the remote port on the remote host to which this Connection is connected.
ca.uhn.hl7v2.app.Responder	getResponder() Returns the Responder associated with this connection
protected HL7Writer	getSendWriter() Returns the HL7Writer through which unsolicited outbound messages should be sent.
boolean	isOpen() Returns true if this connection is open
protected boolean	isRecipientWaiting(String ackID, String message) Given the ack ID (MSA-2) of a message, notifies a waiting consumer thread about a received response.
boolean	isSecure()
String	toString()
protected Future<String>	waitForResponse(String messageID, long timeout) Reserves a future incoming message by ack ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveConnection

public ActiveConnection(Parser parser,
                        LowerLayerProtocol llp,
                        Socket bidirectional)
                 throws LLPException,
                        IOException

Creates a new instance of Connection, with inbound and outbound communication on a single port.

Throws:

LLPException

IOException

ActiveConnection

public ActiveConnection(Parser parser,
                        LowerLayerProtocol llp,
                        Socket bidirectional,
                        ExecutorService executorService)
                 throws LLPException,
                        IOException

Throws:

LLPException

IOException

ActiveConnection

public ActiveConnection(Parser parser,
                        LowerLayerProtocol llp,
                        Socket inbound,
                        Socket outbound)
                 throws LLPException,
                        IOException

Creates a new instance of Connection, with inbound communication on one port and outbound on another.

Throws:

LLPException

IOException

ActiveConnection

public ActiveConnection(Parser parser,
                        LowerLayerProtocol llp,
                        Socket inbound,
                        Socket outbound,
                        ExecutorService executorService)
                 throws LLPException,
                        IOException

Creates a new instance of Connection, with inbound communication on one port and outbound on another.

Throws:

LLPException

IOException

Method Detail

activate

public void activate()

Start the receiver thread(s)

Specified by:

activate in interface Connection

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface Connection

getRemoteAddress

public InetAddress getRemoteAddress()

Returns the address of the remote host to which this Connection is connected. If separate inbound and outbound sockets are used, the address of the outbound socket is returned (the addresses should normally be the same, but this isn't checked).

Specified by:

getRemoteAddress in interface Connection

See Also:

Connection.getRemotePort()

getRemotePort

public Integer getRemotePort()

Returns the remote port on the remote host to which this Connection is connected. If separate inbound and outbound sockets are used, the port of the outbound socket is returned.

Specified by:

getRemotePort in interface Connection

See Also:

Connection.getRemoteAddress()

getInitiator

public Initiator getInitiator()

Returns the Initiator associated with this connection

Specified by:

getInitiator in interface Connection

Returns:

getResponder

public ca.uhn.hl7v2.app.Responder getResponder()

Returns the Responder associated with this connection

isSecure

public boolean isSecure()

getSendWriter

protected HL7Writer getSendWriter()

Returns the HL7Writer through which unsolicited outbound messages should be sent.

getAckWriter

protected HL7Writer getAckWriter()

Returns the HL7Writer through which responses to inbound messages should be sent.

getParser

public Parser getParser()

toString

public String toString()

Overrides:

toString in class Object

waitForResponse

protected Future<String> waitForResponse(String messageID,
                                         long timeout)
                                  throws InterruptedException

Reserves a future incoming message by ack ID. When the incoming message with the given ack ID arrives, the message will be returned.

Throws:

InterruptedException

isRecipientWaiting

protected boolean isRecipientWaiting(String ackID,
                                     String message)

Given the ack ID (MSA-2) of a message, notifies a waiting consumer thread about a received response.

close

public void close()

Stops running Receiver threads and closes open sockets

Specified by:

close in interface Connection

isOpen

public boolean isOpen()

Description copied from interface: Connection

Returns true if this connection is open

Specified by:

isOpen in interface Connection

Returns:

true if this connection is open