components/camel-swift/src/main/docs/swiftMx-dataformat.adoc

= SWIFT MX DataFormat
:doctitle: SWIFT MX
:shortname: swiftMx
:artifactid: camel-swift
:description: Encode and decode SWIFT MX messages.
:since: 3.20
:supportlevel: Stable
:tabs-sync-option:
//Manually maintained attributes
:camel-spring-boot-name: swift

*Since Camel {since}*

The SWIFT MX data format is used to encode and decode SWIFT MX messages. The data format leverages the library https://github.com/prowide/prowide-iso20022[Prowide ISO 20022] to encode and decode SWIFT MX messages.

== Options

// dataformat options: START
include::partial$dataformat-options.adoc[]
// dataformat options: END

In Spring DSL, you configure the data format using this tag:

[source,xml]
----
<camelContext>
    <dataFormats>
        <swiftMx id="swiftInJson" writeInJson="true"/>
    </dataFormats>
    ...
</camelContext>
----

Then you can use it later by its reference:

[source,xml]
----
<route>
     <from uri="direct:startEncode" />
     <marshal ref="swiftInJson" />
     <to uri="mock:result" />
</route>
----

Most of the time, you won't need to declare the data format if you use
the default options. In that case, you can declare the data format
inline as shown below:

[source,xml]
----
<route>
    <from uri="direct:startEncode" />
    <marshal>
        <swiftMx />
    </marshal>
    <to uri="mock:result" />
</route>
----

== Marshal

In this example, we marshal the messages read from a JMS queue in SWIFT format before storing the result into a file.

[source,java]
----
from("jms://myqueue")
    .marshal().swiftMx()
    .to("file://data.bin");
----

In Spring DSL:

[source,xml]
----
 <from uri="jms://myqueue">
 <marshal>
     <swiftMx/>
 </marshal>
 <to uri="file://data.bin"/>
----

== Unmarshal

The unmarshaller converts the input data into the concrete class of type `com.prowidesoftware.swift.model.mx.AbstractMX` that best matches with the content of the message.

In this example, we unmarshal the content of a file to get SWIFT MX
objects before processing them with the `newOrder` processor.

[source,java]
----
from("file://data.bin")
    .unmarshal().swiftMx()
    .process("newOrder");
----

In Spring DSL:

[source,xml]
----
 <from uri="file://data.bin">
 <unmarshal>
     <swiftMx/>
 </unmarshal>
 <to uri="bean:newOrder"/> 
----

== Dependencies

To use SWIFT MX in your Camel routes, you need to add a dependency on
*camel-swift* which implements this data format.

If you use Maven, you can add the following to your pom.xml:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-swift</artifactId>
  <version>x.x.x</version>  <!-- use the same version as your Camel core version -->
</dependency>
----


include::spring-boot:partial$starter.adoc[]