Added camel-mllp docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fc5a4772 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fc5a4772 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fc5a4772 Branch: refs/heads/master Commit: fc5a477292f38dc7fb6e3b426c1140f90e512559 Parents: c0d59a8 Author: Andrea Cosentino <anco...@gmail.com> Authored: Mon May 9 10:19:56 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Mon May 9 10:19:56 2016 +0200 ---------------------------------------------------------------------- components/camel-mllp/src/main/docs/mllp.adoc | 172 +++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 173 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/fc5a4772/components/camel-mllp/src/main/docs/mllp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/docs/mllp.adoc b/components/camel-mllp/src/main/docs/mllp.adoc new file mode 100644 index 0000000..ef1c855 --- /dev/null +++ b/components/camel-mllp/src/main/docs/mllp.adoc @@ -0,0 +1,172 @@ +[[Mllp-MllpComponent]] +MLLP Component +~~~~~~~~~~~~~~ + +*available as of Camel 2.17* + +The MLLP component is specifically designed to handle the nuances of the +MLLP protocol and provide the functionality required by Healthcare +providers to communicate with other systems using the MLLP protocol. + The MLLP component  provides a simple configuration URI, automated HL7 +acknowledgment generation and automatic acknowledgement interrogation. + +The MLLP protocol does not typically use a large number of concurrent +TCP connections - a single active TCP connection is the normal case. + Therefore, the MLLP component uses a simple thread-per-connection model +based an standard Java Sockets. This keeps the implementation simple +and eliminates the dependencies other than Camel itself. + +The component supports the following: + +* A Camel consumer using a TCP Server +* A Camel producer using a TCP Client + +The MLLP component uses byte[] payloads, and relies on Camel Type +Conversion to convert byte[] to other types.  + +Maven users will need to add the following dependency to their pom.xml +for this component: + +[source,xml] +--------------------------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-mllp</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +--------------------------------------------------------- + +[[MLLP-MLLPOptions]] +MLLP Options +~~~~~~~~~~~~ + + +// component options: START +The mllp component has no options. +// component options: END + + + +// endpoint options: START +The mllp component supports 19 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| hostname | common | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address +| port | common | | int | *Required* Port number for the TCP connection +| acceptTimeout | common | 60000 | int | Timeout value while waiting for a TCP connection TCP Server Only +| autoAck | common | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only +| backlog | common | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. +| bindRetryInterval | common | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts +| bindTimeout | common | 30000 | int | TCP Server Only - The number of milliseconds to retry binding to a server port +| charsetName | common | | String | Set the CamelCharsetName property on the exchange +| connectTimeout | common | 30000 | int | Timeout value for establishing for a TCP connection TCP Client only +| keepAlive | common | true | boolean | Enable/disable the SO_KEEPALIVE socket option. +| receiveBufferSize | common | | Integer | Sets the SO_RCVBUF option to the specified value +| receiveTimeout | common | 10000 | int | The SO_TIMEOUT value used when waiting for the start of an MLLP frame +| reuseAddress | common | false | boolean | Enable/disable the SO_REUSEADDR socket option. +| sendBufferSize | common | | Integer | Sets the SO_SNDBUF option to the specified value +| tcpNoDelay | common | true | boolean | Enable/disable the TCP_NODELAY socket option. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +// endpoint options: END + + + +[[MLLP-MLLPConsumer]] +MLLP Consumer +~~~~~~~~~~~~~ + +The MLLP Consumer supports receiving MLLP-framed messages and sending +HL7 Acknowledgements.  The MLLP Consumer can automatically generate the +HL7 Acknowledgement (HL7 Application Acknowledgements only - AA, AE and +AR), or the acknowledgement can be specified using +the CamelMllpAcknowledgement exchange property.  Additionally, the type +of acknowledgement that will be generated can be controlled by setting +the CamelMllpAcknowledgementType exchange property. + +[[MLLP-MessageHeaders]] +*Message Headers* +^^^^^^^^^^^^^^^^^ + +The MLLP Consumer adds these headers on the Camel message: + +[width="100%",cols="<34%,<33%,<33%",] +|=========================================== +|*Key* |*MSH field* |*Example* +|CamelMllpLocalAddress | | +|CamelMllpRemoteAddress | | +|CamelMllpSendingApplication |MSH-3 |APPA +|CamelMllpSendingFacility |MSH-4 |FACA +|CamelMllpReceivingApplication |MSH-5 |CAMEL +|CamelMllpReceivingFacility |MSH-6 |FACB +|CamelMllpTimestamp |MSH-7 |20150106235900 +|CamelMllpSecurity |MSH-8 | +|CamelMllpMessageType |MSH-9 |ADT^A04 +|CamelMllpEventType |MSH-9-1 |AD4 +|CamelMllpTriggerEvent |MSH-9-2 |A04 +|CamelMllpMessageControlId |MSH-10 |12345 +|CamelMllpProcessingId |MSH-11 |P +|CamelMllpVersionId |MSH-12 |2.3.1 +|CamelMllpCharset |MSH-18 | +|=========================================== + +All headers are String types. If a header value is missing, its value +is null. + +[[MLLP-ExchangeProperties]] +*Exchange Properties* +^^^^^^^^^^^^^^^^^^^^^ + +The type of acknowledgment the MLLP Consumer generates can be controlled +by these properties on the Camel exchange: + +[width="100%",cols="<34%,<33%,<33%",] +|==================================== +|*Key* | |*Example* +|CamelMllpAcknowledgement | | +|CamelMllpAcknowledgementType | | AR +|==================================== + +All headers are String types. If a header value is missing, its value +is null. + +[[MLLP-ConsumerConfiguration]] +Consumer Configuration +^^^^^^^^^^^^^^^^^^^^^^ + +[[MLLP-MLLPProducer]] +MLLP Producer +~~~~~~~~~~~~~ + +The MLLP Producer supports sending MLLP-framed messages and receiving +HL7 Acknowledgements.  The MLLP Producer interrogates the HL7 +Acknowledgments and raises exceptions if a negative acknowledgement is +received.  The received acknowledgement is interrogated and an exception +is raised in the event of a negative acknowledgement. + +[[MLLP-MessageHeaders.1]] +*Message Headers* +^^^^^^^^^^^^^^^^^ + +The MLLP Producer adds these headers on the Camel message: + +[width="100%",cols="<34%,<33%,<33%",] +|=================================== +|*Key* |*MSH field* |*Example* +|CamelMllpLocalAddress | | +|CamelMllpRemoteAddress | | +|CamelMllpAcknowledgement | | +|CamelMllpAcknowledgementType | |AA +|=================================== + +All headers are String types. If a header value is missing, its value +is null. + + + http://git-wip-us.apache.org/repos/asf/camel/blob/fc5a4772/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index fa424e3..e0164db 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -194,6 +194,7 @@ * [Metrics](metrics.adoc) * [Mina](mina.adoc) * [Mina2](mina2.adoc) + * [MLLP](mllp.adoc) * [Mock](mock.adoc) * [NATS](nats.adoc) * [Properties](properties.adoc)
