iso8583ii Copyright (C) AZS Services 2004-2005 This class implements a Bitmap an extended ISOField object for use with other ISO classes The application can use this object for ISO meesage creation @author AZS Services ISO8583II Copyright (C) AZS Services 2004-2007 This class creates a ISOField object for use with other ISO 8583 classes in this package The application can use this object for ISO message creation @author AZS Services Ltd. @see Message @see ISO8583II Copyright (C) AZS Services 2004-2005 This class defines ISO-8583 bit field constants the constant names are based on ISO-8583 v1 (1993) so they can be confusing in some cases for v0 (1997) context but the field name prefix Fxxx where xxx is the related ISO-8583 bit number gives a real information what field it is. @author AZS Services @see ISO8583II

The constants for ISO bitfield definitions -4..128

Actual buffer conaining information of this field The field iso nitno The field iso version (0 or 1)

Max length of field

Field type

Creates an empty ISOField object with no data

Creates an ISOField object with specified bitno and data buffer (version 0)

@param bit indicates the ISO8583 field number @param buf the data for this field c - the config

Creates an ISOField object with specified bitno and data buffer and ISO8583 version

bit indicates the ISO8583 field number @param buf the data for this field @param v ISO8583 version 0 or 1 @param c - the config

Creates an ISOField object with specified bitno and data buffer (version 0)

bit indicates the ISO8583 field number buf the data for this field offs the offset to start len the data length c - the config

Creates an ISOField object with specified bitno and data buffer

bit indicates the ISO8583 field number buf the data for this field offs the offset to start len the data length v ISO8583 version 0 or 1 c - the config

Creates an ISOField object with specified bitno and String value (version 0)

c - the config bit indicates the ISO8583 field number value

Creates an ISOField object with specified bitno and String value and ISO8583 version

bit indicates the ISO8583 field number value the data for this field v ISO8583 version 0 or 1 c - the config

Creates a new ISOField object independent copy/clone from current object

fiel - the field to clone

Sets the String value of ISOField object

value - the value

Sets the byte value of ISOFieled object

b - the binary value

Gets the ISO8583 version info of this ISOField object

the version

Gets the ISO8583 field type of this ISOField object

the field type constant

Gets the ISO8583 field bit number

bit number the max legth allowed for this ISOField current length of this isofield the 4bit encoded/packed data in case of numeric fields the binary length and 4bit encoded/packed data in case of numeric and lxvar fields plain format data of this field plain format data of this field true if to return field value in EBCDIC String value of this field binary value of this field long integer value of this field if type of numeric or 0 if field ins not numeric String value of this field (same as getStringValue() )

contructs a empty bitmap with spetsified field number

bit the field number that is assigned to bitmap itself config object 0 - for primary bitmap, 1 - for secondary bitmap

contructs a bitmap from byte buffer with spetsified field number

bit the field number that is assigned to bitmap itself 0 - for primary bitmap, 1 - for secondary bitmap buf the buffer holding bitmap data c -config

contructs a bitmap from byte buffer with specified field number and with specified iso version

bit the field number that is assigned to bitmap itself 0 - for primary bitmap, 1 - for secondary bitmap buf the buffer holding bitmap data - the iso version (0 or 1) to be assigned with this Bitmap/Field c -config

contructs a bitmap from byte buffer with specified field number and with specified iso version

* bit the field number that is assigned to bitmap itself * 0 - for primary bitmap, 1 - for secondary bitmap * buf the buffer holding bitmap data * c -config * offs - where the bitmap data starts in buf * len - teh length of data in buffer to use (8)

initializes bitmap from byte buf from offset to offset+len

buffer where bitmap data is offs - start offset in buf len - length of data to read (8)

initializes the bitmap from and 8 byte data buffer

the bitmap data 8 bytes length

method to set a specified bit in bitmap to 1 (true) or 0 (false)

state - true bit=1, false bit=0 param bitno - the bit number to modify (1..64) or for convenience 65..128 may also be used for secondary bitmap. if the specified bit in the bitmap is 1 (true) or 0 (false) bitno - the field number to query 1..64 or for convenience 65..128 for secondary bitmap can be used. an array of integers representing bit numbers that are (1) true in that bitmap a long 64 bit integer value from bitmap data

intitializes the bitmap from 64 bit long integer

Copyright (C) AZS Services 2004-2005 This class can be used for CCC cheksum calculation for certain ISO-8583 messages @author AZS Services @return a character range of byte in+32 @return a byte from character in-32 @return a one byte cheksum from a byte array starting from specified offset and length Copyright (C) AZS Services 2004-2005 CCCException object is used to handle some invalid CCC cases

constructor

the header field type definitions

the field type definitions

the field length definitions the format of bitmap binary or hex dec, default binary (hexbitmap=false);

return true if track2 data in packed form is padded with F at the end instead 0 at the beginning

set true if track2 data in packed form is padded with F at the end instead 0 at the beginning

set true if track2 data in packed form is to be padded with 0 at the end instead 0 at the beginning

returns true if track2 data in packed form is padded with F at the end instead 0 at the beginning

returns true if track3 type data in packed form is padded with F at the end instead 0 at the beginning

set true if track3 type data in packed form is padded with F at the end instead 0 at the beginning

Set absolute path and location of license file

get current license file

Gets the ISO8583 field type of ISOField object with specified bitno

bit - the bit number to query the type of field

Gets the ISO8583 field type of ISOField object with specified bitno and ISO8583 version

bit - the bit number to query ver - the iso version 0 or 1 the type of field

sets the customized field type for specified ISO8583 (bit number) and for cpecified version (0, 1)

bit the field nmber ad sefined in ISOBits ver the ISO8583 version (0 or 1) type the custom field type as defined in Type interface

sets the customized field max length for specified ISO8583 (bit number) and for cpecified version (0, 1)

bit the field nmber ver the ISO8583 version (0 or 1) len the custom field length in bytes (0..999) bit the field nmber to query (0-128) v the ISO8583 version (0 or 1) the max length for ISOField specified by bit number and ISO version (0, 1) or -1 if such field does not exsist bit the field number to query (0-128) the max length for ISOField specified by bit number (version 0)

to set a bitmap format to hex or binary

hex true if the required format for parser/formatter is hex (16 bytes) or false (default setting) if bitmap is in binrary format (8 bytes) current bitmap format, true if hex false if binary

to set a packed length format to binary

bin true if the required format length format is binary or false (default setting) if length format is 4 bit BCD current binpacked length setting

to set char encoding to ebcdinc

set true if the ebcdic is required for base char set or false (default setting) if ascii current ebcdic setting, true if ebcdic false if ascii

Print out config

print out current config settings to textwriter

- the printsream where to print config Copyright (C) AZS Services 2004-2005 This class can be used for packing integer values to 4 bit decimal numbers and 4bit decimal numbers back to integer values @author AZS Services converts an integer value to 4bit decimals where each decimal is presented by half of the byte values 0000..1001 if the len the length in bytes desired if the lenth of integer n is odd then a extra half of bye with 0000 is prepended @param n - the number value to pack @param len - the lengh of the returned value in bytes @return a 4 bit packed decimals converts an 4 bit packed decimals to an integer value @param b4bit the 4 bit packed decimals 0000...1001 @param len the length of 4bit data to be used as 4 bit data @return decoded value Copyright (C) AZS Services 2004-2008

This class can be used for converting acii2ebcdic and ebcdic2ascii characters

@author AZS Services ebcdic byte [0] ascii equivalent byte [1] ascii equivalent for ebcdic char ebcdic encoded char byte ascii equivalent buffer of bytes for ebcdic char bytes ebcdic encoded char bytes ascii equivalent buffer of bytes for ebcdic char bytes ebcdic encoded char bytes offset to start length to do ebcdic equivalent byte for ascii char ascii encoded char byte ebcdic equivalent bytes for ascii char bytes ascii encoded char bytes ebcdic equivalent bytes for ascii char bytes ascii encoded char bytes offset to start length to do Copyright (C) AZS Services 2004-2005 This interface defines field types used in ISO8583 messages @author AZS Services

the field type is unkown/undefined is not parsed

the field is type of NUMBER (the field is parsed as fixed length numberic content)

the field is type of TEXT (the field is parsed as fixed length text content)

the field is type of LLLVARNUMBER (the field is parsed as 2 byte of length and remaining of bytes as numeric content)

the field is type of LLVARTEXT (the field is parsed as 2 byte of length and remaining of bytes as text content)

the field is type of LLLVARNUMBER (the field is parsed as 3 byte of length and remaining of bytes as numbric content)

the field is type of LLLVARTEXT (the field is parsed as 3 byte of length and remaining of bytes as text content)

the field is type of BINARY (the field is parsed as fixed length binray content)

the field is type of LLVARBINARY (the field is parsed as 2 byte of length and remaining of bytes as binary content)

the field is type of LLLVARBINARY (the field is parsed as 3 byte of length and remaining of bytes as binary content)

the field is type of track2 LLVAR where 1st 2 bytes define the of contents LLVAR Note: in compressed format it is like LVAR where 1st byted is compressed length. (used to parse field as track 2 contents)

the field is type of track3 like LLVAR (used to parse field as track 3 contents)

the field is type of track1 (NOT USED, track 1 is parsed as regular LLVAR)

the field is type of LLLLVARTEXT (used in some custom ISO formats)

the field is type of LLLLLVARTEXT (used in some custom ISO formats)

the field is type of LLLLLLVARTEXT (used in some custom ISO formats)

the field is type of LVARNUMBER (the field is parsed as 1 byte of length and remaining of bytes as numeric content)

the field is type of LVARTEXT (the field is parsed as 1 byte of length and remaining of bytes as text content)

return label string

label string definitions

* Copyright (C) AZS Services 2004-2009 * @author Andri Kruus, AZS Services * Estonia Tallinn, http://www.a2zss.com * Created on 13.10.2004 * * $Header: /home/andri/CVS/iso8583sdk/src/com/a2zss/ISO8583/ISO8583II.java,v 1.2 2004/10/16 19:44:38 andri Exp $ * $Date: 2004/10/16 19:44:38 $ * @version $Revision: 1.2 $ This class can be used as parser and formatter

Constanint indicating ISO8583 message numeric fields should not encoded 4 bit

Constant indicating ISO8583 message numeric fields should encoded 4 bit

Constant indicating ISO8583 message numeric fields should not encoded 4 bit and addtionally whole message will be encoded into printable characters

Constaant indicates ISO8583 message numeric fields should not encoded 4 bit and the total message length should prepended to message data ( like "0123")

constant indicating max len of any ISO 8583 message ( 9999 )

constant indicating ISO8583 version 1987 (0xxx messages) value 0

constant indicating ISO8583 version 2003 (2xxx messages) value 2

constant indicting autorisation message mti 0100 or 1100

constant indicting autorisation message repeat mti 0101 or 1101

constant indicting autorisation message response mti 0110 or 1110

constant indicting autorisation message reversal mti 0400 or 1420

constant indicting autorisation message reversal repeat mti 0401 or 1421

constant indicting autorisation message reversal response mti 0410 or 1430

constant indicting autorisation message (SMS) mti 0200 or 1200

constant indicting autorisation message repeat (SMS) mti 0201 or 1201

constant indicting autorisation message response (SMS) mti 0210 or 1210

constant indicting clearing request message (SMS) mti 0500 or 1500

constant indicting clearing request response message (SMS) mti 0510 or 1510

constant indicting network request message mti 0804 or 1804

constant indicting network request response message mti 0814 or 1814

ourchase types

constant indicating ISO8583 version 1993 (1xxx messages) value 1

constants that represent MTI values in relatin to mesage type and version

human readable message mti mappings

a selection processing code field values in relation to PROCSTR constants

ourchase types labels { goods, cash, goods unattended}

version

(C)

Name

class internal PrintStream for debugging purposes by default null class internal variable for debugging purposes valid values 0..9

Create instance of SDK object with default config

Create instance of SDK object

config to set for SDK instance

Set config for SDK instance

config to set

Get config object of this SDK instance

current config

Set writer for debug output

Get writer of debug output

Get debug level.

current debug level set

Set debug level.

The debug level 0 (min) 5 (max)

checks the ISO message encoding type from bye[] array

ENC_CODED, ENC_PACKED, ENC_LLLLPLAIN, ENC_PLAIN or -1 if can not determine

gets the encoded data block from syntax 2

encoded block

converts single byte value to sigle number char value param 0 returns 32

converts single byte value car value to sigle number char value param 32 returns 0

gets the encoded data block from syntax 2 encoded stream

decodes the actual encoded bytes incl cflag and ccc

return encoded (into printable chars) data block from plain data

Format message contents is packed format.

return a buffer with ISO message in packed format The message to format

Format message contents is encoded format.

return a buffer with ISO message encoded and fomratted: S LN T DATA CCC E The message to format

Format message contents plain format. Note: supports fields FH_IDENT, FH_DCP, FF_FOT if they are configured

return a buffer with ISO message in plain format The message to format

Format message contents plain format with packed length.

return a buffer with ISO message plain format with message length LL (two bytes packed) The message to format

Format message contents plain format with length (4 bytes).

return a buffer with ISO message plain format with message length The message to format

parses the packed ISO8583 format from buffer.

return the message object The buffer of data to parse

parses the packed ISO8583 format from stream.

return the message object The input stream of data to parse

parses the LLplain format from inputstream (where LL is two byte (packed/binary length). Note: supports fields FH_IDENT, FH_DCP, FF_FOTif they are configured

return the message object The input stream of data to parse

parses the LLLLplain format from inputstream . Note: supports fields FH_IDENT, FH_DCP, FF_FOTif they are configured

return the message object The input stream of data to parse

parses the plain format from inputstream . Note: supports fields FH_IDENT, FH_DCP, FF_FOTif they are configured

return the message object The input buffer of data to parse

parses the plain format from inputstream . Note: supports fields FH_IDENT, FH_DCP, FF_FOTif they are configured

return the message object The input stream of data to parse

validates if the fields Message contains reflect the type and format required * or if there are fields not compatible with required length and type * then throws an ISOException *

* return the message object * The message to validate

Parses a plain type field usually no need to use this directly

the 4bit encoded/packed data in case of numeric fields the binary length and 4bit encoded/packed data in case of numeric and lxvar fields Copyright (C) AZS Services 2004-2005 ISOException object is used to handle some ISO8583 protocol error cases

constructor

Parser and formatter for TLV subfields wich are in format LLL - length (includes the tag length and value length) TT - tag, V - the tag value @author Andri

Class consructor

data to use throws Exception

Method parse, parses data into separate tags

data Method getTagValue @param tag @return Method setTagValue @param tag @param value Method formatTags @return - the formatted data of tags @author Andri Parser and formatter for TLV subfields wich are in format LL - length (includes the tag length and value length) TT - tag, V - the tag value Class consructor Class consructor @param data @throws Exception Method parse @param data Method getTagValue @param tag @return Method setTagValue @param tag @param value Method formatTags @return - the formatted data of tags

Copyright (C) AZS Services 2004-2005 This class can be used to contruct ISO8583 messages or to analyze and acess data in parsed ISO8583 messages.

@author AZS Services creates an empty Message object

creates a Message object from that contains ISOFields

hs a ISOField object in Message matching the bit bit - the ISO8583 bit number / field name constant a ISOField object in Message matching key key - the ISO8583 bit number / field name constant a ISOField object converted to String in Message matching the bit bit - the ISO8583 bit number / field name constant a ISOField object in Message matching the bit bit - the ISO8583 bit number / field name constant allownull - if true the null velues are allowed to be returned if false then if there is no such field or contents for this field will be returned as an empty String "".

to add a ISOField object to Message

an ISOFiled or Bitmap object @author Andri Class consructor Class consructor @param data Method parse @param data Method getTagValue @param tag @return Method setTagValue @param tag @param value Method formatTags @return - the formatted data of tags Copyright (C) AZS Services 2004-2005 the useful object for parsing binary data this implementation was planned to use buffering and it is in a middle of development

create an empty binary string with specified initial size (64)

* create an empty binary string with specified initial size

create an empty binary string with specified initial size and starting point

create a binary string with data from the original binary string bs

create a binary string with data from the original String s

create a binary string with data from the single byte b

create a binary string with data from the byte array b

create a binary string with data from the byte array b including data from starting and ending points

reset the binarystring to empty

set the binarystring to new value of single byte b

set the binarystring to new value of byte array b

byte at specified position index of matching byte in binarystring index of matching byte in binarystring, from specified start prosition index of matching binarystring in binarystring, from specified start prosition substring of binarystring substring of binarystring

append a char to binarystring using cast (append(byte)c)

append a byte to binarystring

appends a String to this binaryString

appends a binaryString to this binaryString

appends a buffer to this binaryString

prepends a byte to this binaryString

prepends a binaryString to this binaryString

prepends a byte buffer to this binaryString

return the binrystring buffer the length of binaryString creates the string presentation of this binarystring

This conversion function is neccessary because Java 1.1+ uses machine dependent char-to-byte and byte-to-char conversions. This is normally a useful feature, allowing machine independence. In order to maintain backwards with pre-Java conventions, we implement out own machine-independent deterministic converter.

string to be converted to bytes array of bytes containing lower 8 bits of each char

b array of bytes to be converted to a String String containing the bytes. Each char in the string will be in the range \u0000 to \u00FF Copyright (C) AZS Services 2004-2005

library methots for various issues

parses an int from buffer beginning parses an int from buffer starting from offs parse the short value parse the short value parse the byte value parse the byte value converts int to bytes converts short to bytes converts byte to bytes converts byte to bytes tests if string is integer /** * Copyright (C) AZS Services 2004-2005 * @author Andri -1 if the String contains only number characters '0'..'9' othervise returns the first position where String violates this condition value -1 if the String contains only chars with values 32..127 othervise returns the first position where String violates this condition return financial transaction type for transaction originator * 1 in case of authorizations * 0 in case of non financial transaction like network message * -1 in case of reversal/refund transactions * the transaction type string values like "0100", "1100", .. string represent the mesaning of ISO8583 message action code field 39 values returned are like:
00 --> "OK, approved"
01 --> "Declined (01)"
02 --> "Call to Issuer, declined" codes the ISO8583 v1987 field 39 value ("00", "01", "02", ..) * string represent the mesaning of ISO8583 message action code field 39 values returned are like: 00/000 --> "OK, approved"
01/001 --> "Declined (01)"
02/002 --> "Call to Issuer, declined" codes the ISO8583 v1987 or v1993 field 39 value ("00", "01", "02", .. or "000", "001", "002") @param ver the ISO8583 message version use v1987 (=0) or v1993 (=1) true if ISO8583 message action code field 39 indicated approved/or ok values returned are like: returns true for v1987 code 00 and v1993 codes 000 and 400 codes the ISO8583 v1987 or v1993 field 39 value ver the ISO8583 message version use v1987 (=0) or v1993 (=1) string represent the mesaning of ISO8583 message action code field 39 values returned are like: 00/000 --> "OK, approved" 01/001 --> "Declined (01)" 02/002 --> "Call to Issuer, declined" codes the ISO8583 v1987 or v1993 field 39 value ("00", "01", "02", .. or "000", "001", "002") ver the ISO8583 message version use v1987 (=0) or v1993 (=1)