Java Client & Server for ISO8583 & Netty
Clone or download

README.md

JReactive-8583

Free ISO8583 Java Connector

Travis Libraries.io for GitHub Codacy Badge

Motivation

  1. jPOS library is not free for commercial use.
  2. j8583 is free but does not offer network client

Solution: "J-Reactive-8583" ISO8583 Client and Server built on top of excellent Netty asynchronous messaging framework with the help of j8583 for encoding/decoding. It is distributed under Apache License 2.0.

Supported Features

  • Client and Server endpoints.
  • Support ISO8583 messages using j8583 library.
  • Customizable ISO MessageFactory.
  • Automatic responding to Echo messages.
  • Automatic client reconnection.
  • Secure message logger: mask PAN and track data or any any other field (customizable). Optionally prints field descriptions.
  • Configurable netty Bootstrap and ChannelPipeline

ISO8583 TCP/IP Transport

For data transmission TCP/IP uses sessions. Each session is a bi-directional data stream. The protocol uses a single TCP/IP session to transfer data between hosts in both directions.

The continuous TCP/IP data stream is split into frames. Each ISO8583 message is sent in a separate frame.

A Frame consists of a N-byte length header and a message body. Usually, N==2. The header contains the length of the following message. The high byte of value is transmitted first, and the low byte of value is transmitted second.

N bytes M bytes
Message Length = M ISO–8583 Message

Getting Started

First, you need to download latest release or clone this repository and build artifact with maven manually.

Then add dependency to your project:

<dependencies>
    <dependency>
        <groupId>com.github.kpavlov.jreactive8583</groupId>
        <artifactId>netty-iso8583</artifactId>
        <version>0.2.2</version>
    </dependency>
</dependencies>

Now you may use ISO8583 client or server in your code.

Creating and Using ISO-8583 Client

The minimal client workflow includes:

MessageFactory<IsoMessage> messageFactory = ConfigParser.createDefault();// [1]
Iso8583Client<IsoMessage> client = new Iso8583Client<>(messageFactory);// [2]

client.addMessageListener(new IsoMessageListener<IsoMessage>() { // [3]
    ...
});
client.getConfiguration().replyOnError(true);// [4]
client.init();// [5]
    
client.connect(host, port);// [6]
if (client.isConnected()) { // [7]

    IsoMessage message = messageFactory.newMessage(...);
    ...
    client.sendAsync(message);// [8]
    // or
    client.send(message);// [9]
    // or
    client.send(message, 1, TimeUnit.SECONDS);// [10]
}
    
...
client.shutdown();// [11]
  1. First you need to create a MessageFactory
  2. Then you create a Iso8583Client providing MessageFactory and, optionally, SocketAddress
  3. Add one or more custom IsoMessageListeners to handle IsoMessages.
  4. Configure the client. You may omit this step if you're fine with default configuration.
  5. Initialize client. Now it is ready to connect.
  6. Establish a connection. By default, if connection will is lost, it reconnects automatically. You may disable this behaviour or change reconnectInterval.
  7. Verify that connection is established
  8. Send IsoMessage asynchronously
  9. Send IsoMessage synchronously
  10. Send IsoMessage synchronously with timeout support
  11. Disconnect when you're done.

Creating and Using ISO-8583 Server

Typical server workflow includes:

MessageFactory<IsoMessage> messageFactory = ConfigParser.createDefault();// [1]
Iso8583Server<IsoMessage> server = new Iso8583Server<>(port, messageFactory);// [2]

server.addMessageListener(new IsoMessageListener<IsoMessage>() { // [3]
    ...
});
server.getConfiguration().replyOnError(true);// [4]
server.init();// [5]
    
server.start();// [6]
if (server.isStarted()) { // [7]
    ...
}
    
...
server.shutdown();// [8]
  1. First you need to create a MessageFactory
  2. Then you create a Iso8583Server providing MessageFactory and port to bind to
  3. Add one or more custom IsoMessageListeners to handle IsoMessages.
  4. Configure the server. You may omit this step if you're fine with default configuration.
  5. Initialize server. Now it is ready to start.
  6. Start server. Now it is ready to accept client connections.
  7. Verify that the server is started
  8. Shutdown server when you're done.

Logging

Default IsoMessageLoggingHandler may produce output like:

312 [nioEventLoopGroup-5-1] DEBUG IsoMessageLoggingHandler - [id: 0xa72cc005, /127.0.0.1:50853 => /127.0.0.1:9876] MTI: 0x0200
  2: [Primary account number (PAN):NUMERIC(19)] = '000400*********0002'
  3: [Processing code:NUMERIC(6)] = '650000'
  7: [Transmission date & time:DATE10(10)] = '0720233443'
  11: [System trace audit number:NUMERIC(6)] = '483248'
  32: [Acquiring institution identification code:LLVAR(3)] = '456'
  35: [Track 2 data:LLVAR(17)] = '***'
  43: [Card acceptor name/location (1-23 address 24-36 city 37-38 state 39-40 country):ALPHA(40)] = 'SOLABTEST TEST-3 DF MX                  '
  49: [Currency code, transaction:ALPHA(3)] = '484'
  60: [Reserved national:LLLVAR(3)] = 'foo'
  61: [Reserved private:LLLVAR(5)] = '1234P'
  100: [Receiving institution identification code:LLVAR(3)] = '999'
  102: [Account identification 1:LLVAR(4)] = 'ABCD'

Using client or server configuration

You may:

  • enable message logging. As of 0.2.2 logging is disabled by default (#50).
  • enable and disable printing of sensitive information, like PAN
  • customize which fields should be masked in logs
  • enable and disable printing field descriptions
  • customize tcp frame length field length

See ConnectorConfiguration, ServerConfiguration and ClientConfiguration.


For frequently asked questions check the FAQ page.

ISO 8583 Links