JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

HL7 Server: Dispatch incoming HL7 messages to registered HL7 services. When configuring, select the TCP listening port, the security protocol for communication, timeouts, and the maximum number of connected HL7 senders.

List of MBean attributes:

Name Type Access Value Description
CharsetName java.lang.String RW Specifies Charset of incoming and outgoing HL7 messages by its name as listed in the IANA Charset Registry (e.g. ISO-8859-1).
Port int RW TCP listening port. This is the most important value in the service, and by default is set to 2575.
LocalAddress java.lang.String RW Local interface IP address to listen for TCP communication. 0.0.0.0 indicates all active interfaces.
ProtocolName java.lang.String RW Enable Transport Security Layer (TLS) mode:
  • mllp - plain Minimal Lower Level Protocol; no TLS
  • mllp-tls - accept TLS connections; offer AES or DES encryption
  • mllp-tls.aes - accept TLS connections; force AES or DES encryption
  • mllp-tls.3des - accept TLS connections; force DES encryption
  • mllp-tls.nodes - accept TLS connections without encryption
SoTimeout int RW Socket timeout in ms. 0 = no timeout. This value determines how long the server is waiting for receiving the next message on an open connection before it closes the idle connection. HL7 senders (typical part of the RIS) typically keeps the connection open between emitted messages, and some interprets a close of the idle connection by the server as serious system failure. So the timeout value may be configured quite large. Default: 600000 (=10min).
NoopMessageTypes java.lang.String RW Comma separated list of Message Types which are accepted even if no HL7 Service is registered to actual process the message. By setting this value, you avoid to reject messages, which are not processed by the application.
SuppressErrorResponse boolean RW True False Activates suppression of Application Reject or Application Error as acknowledgment code but always returns acknowledgment code AA (=Application Accept), even if the processing of the message fails.
SendNotification boolean RW True False Activates notification of registered listeners about received HL7 messages. Required for message forwarding by HL7 Send service and for prefetch of studies on receive of ORM^O01 messages by the Prefetch Service.
FileReceivedHL7 boolean RW True False Activates writing received HL7 messages into file (format: hl7-######.hl7, with ###### as the sequence number of the received message since last application start) in log directory. Useful to analyse HL7 encoding errors in incoming messages, which causes the conversion of the message to XML for further processing to fail.
FileReceivedHL7OnError boolean RW True False Activates writing received HL7 messages, which were rejected or which processing failed, into file (format: hl7-######.hl7, with ###### as the sequence number of the received message since last application start) in directory specified by ErrorLogDirectory
ErrorLogDirectory java.lang.String RW Directory to which HL7 messages which are rejected or which processing fails are filed. Only effective if FileReceivedHL7OnError = true. A relative path name is resolved relative to archive-install-directory/server/default/.
FileReceivedHL7AsXML boolean RW True False Activates writing received and XMLized HL7 messages into file (format: hl7-######.xml, with ###### as the sequence number of the received message since last application start) in log directory. Useful to test customized XSL stylesheets used by individual HL7 Services.
TcpNoDelay boolean RW True False Send packets as quickly as possible (Disable Nagle's algorithmn).
SendBufferSize int RW Buffer size used for socket output. 0 = use platform default.
ReceiveBufferSize int RW Buffer size used for socket input. 0 = use platform default.
MaxClients int RW Maximal number of simultaneously connected HL7 senders.
NumClients int R 0 Current number of connected HL7 senders.
MaxIdleThreads int RW Maximal number of idle threads.
NumIdleThread int R 1 Current number of idle threads.
NumberOfReceivedMessages int R 127 Number of received HL7 messages since last restart of the application. Used for naming of log files, if logging of incoming HL7 messages is activated by FileReceivedHL7 or FileReceivedHL7AsXML.
AckStylesheet java.lang.String RW Stylesheet for generated ACK messages. A relative path name is resolved relative to archive-install-directory/server/default/.
LogStylesheet java.lang.String RW Stylesheet for logging of received HL7 messages. A relative path name is resolved relative to archive-install-directory/server/default/.
PreprocessTemplateDir java.lang.String RW Directory where template file(s) are located to preprocess the received HL7 message.
A style sheet can be message type specific ("preprocess_<MSG Type>^<Event Type>.xsl" or "preprocess_<MSG Type>.xsl") or generic "preprocess.xsl" and placed in this directory or in a sub-directory to select a style sheet according to the sender.
This sub-directory can be <IPAddr>, <hostname> or '<Sending Application>^<Sending Facility>' (In this order).
(See also UseHostSubdirs attribute in HL7Server service to enable IP/hostname selection)
A relative path name is resolved relative to archive-install-directory/server/default/.
UseHostSubdirs boolean RW True False Enable selection of style sheets depending on IP address/hostname.
If disabled, only Sending Application and Sending Facility can be used to select style sheet depending on message sender but eliminates need of DNS lookup to get hostname.
TLSConfigName javax.management.ObjectName RW View MBean Used internally - do NOT modify.
TemplatesServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R HL7ServerService The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form

List of MBean operations:

void create()

Standard MBean lifecycle method

void start()

The start lifecycle operation

void stop()

The stop lifecycle operation

void destroy()

The destroy lifecycle operation

void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

void registerService()

Register HL7 Service

Param ParamType ParamValue ParamDescription
messageType java.lang.String Message Type accepted by this service
service org.dcm4chex.archive.hl7.HL7Service HL7 Service

void logMessage()

Log Message

Param ParamType ParamValue ParamDescription
message org.dom4j.Document Message