/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2026 jPOS Software SRL
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.iso;

import org.jpos.iso.header.BaseHeader;
import org.jpos.iso.packager.XMLPackager;
import org.jpos.util.Loggeable;

import java.io.*;
import java.lang.ref.WeakReference;
import java.util.*;

/**
 * implements <b>Composite</b>
 * within a <b>Composite pattern</b>
 *
 * @author apr@cs.com.uy
 * @version $Id$
 * @see ISOComponent
 * @see ISOField
 */
@SuppressWarnings("unchecked")
public class ISOMsg extends ISOComponent
    implements Cloneable, Loggeable, Externalizable
{
    /** Map of field number to field value. */
    protected Map<Integer,Object> fields;
    /** Highest field number currently set in this message. */
    protected int maxField;
    /** The packager used to pack/unpack this message. */
    protected ISOPackager packager;
    /** Dirty flags for tracking state changes. */
    protected boolean dirty, maxFieldDirty;
    /** Message direction: INCOMING or OUTGOING. */
    protected int direction;
    /** Optional ISO header for this message. */
    protected ISOHeader header;
    /** Optional trailer bytes appended to the packed message. */
    protected byte[] trailer;
    /** Field number of this message when nested inside another ISOMsg. */
    protected int fieldNumber = -1;
    /** Constant indicating an incoming message direction. */
    public static final int INCOMING = 1;
    /** Constant indicating an outgoing message direction. */
    public static final int OUTGOING = 2;
    private static final long serialVersionUID = 4306251831901413975L;
    private WeakReference sourceRef;

    /**
     * Creates an ISOMsg
     */
    public ISOMsg () {
        fields = new TreeMap<>();
        maxField = -1;
        dirty = true;
        maxFieldDirty=true;
        direction = 0;
        header = null;
        trailer = null;
    }
    /**
     * Creates a nested ISOMsg
     * @param fieldNumber (in the outer ISOMsg) of this nested message
     */
    public ISOMsg (int fieldNumber) {
        this();
        setFieldNumber (fieldNumber);
    }
    /**
     * changes this Component field number<br>
     * Use with care, this method does not change
     * any reference held by a Composite.
     * @param fieldNumber new field number
     */
    @Override
    public void setFieldNumber (int fieldNumber) {
        this.fieldNumber = fieldNumber;
    }
    /**
     * Creates an ISOMsg with given mti
     * @param mti Msg's MTI
     */
    @SuppressWarnings("PMD.EmptyCatchBlock")
    public ISOMsg (String mti) {
        this();
        try {
            setMTI (mti);
        } catch (ISOException ignored) {
            // Should never happen as this is not an inner message
        }
    }
    /**
     * Sets the direction information related to this message
     * @param direction can be either ISOMsg.INCOMING or ISOMsg.OUTGOING
     */
    public void setDirection(int direction) {
        this.direction = direction;
    }
    /**
     * Sets an optional message header image
     * @param b header image
     */
    public void setHeader(byte[] b) {
        header = new BaseHeader (b);
    }

    /**
     * Sets the ISO header for this message.
     * @param header the ISOHeader to set on this message
     */
    public void setHeader (ISOHeader header) {
        this.header = header;
    }
    /**
     * get optional message header image
     * @return message header image (may be null)
     */
    public byte[] getHeader() {
        return header != null ? header.pack() : null;
    }

    /**
     * Sets optional trailer data.
     * <p>
     * Note: The trailer data requires a customised channel that explicitly handles the trailer data from the ISOMsg.
     *
     * @param trailer The trailer data.
     * @see BaseChannel#getMessageTrailer(ISOMsg)
     * @see BaseChannel#sendMessageTrailer(ISOMsg, byte[])
     */
    public void setTrailer(byte[] trailer) {
        this.trailer = trailer;
    }

    /**
     * Get optional trailer image.
     *
     * @return message trailer image (may be null)
     */
    public byte[] getTrailer() {
        return this.trailer;
    }

    /**
     * Return this messages ISOHeader
     * @return header associated with this ISOMsg, can be null
     */
    public ISOHeader getISOHeader() {
        return header;
    }
    /**
     * Returns the message direction.
     * @return the direction ({@code ISOMsg.INCOMING} or {@code ISOMsg.OUTGOING})
     * @see ISOChannel
     */
    public int getDirection() {
        return direction;
    }
    /**
     * Returns true if this message was received from a channel.
     * @return true if this is an incoming message
     * @see ISOChannel
     */
    public boolean isIncoming() {
        return direction == INCOMING;
    }
    /**
     * Returns true if this message is to be sent via a channel.
     * @return true if this is an outgoing message
     * @see ISOChannel
     */
    public boolean isOutgoing() {
        return direction == OUTGOING;
    }
    /**
     * Returns the highest field number present in this message.
     * @return the max field number
     */
    @Override
    public int getMaxField() {
        if (maxFieldDirty)
            recalcMaxField();
        return maxField;
    }
    private void recalcMaxField() {
        maxField = 0;
        for (Object obj : fields.keySet()) {
            if (obj instanceof Integer)
                maxField = Math.max(maxField, ((Integer) obj).intValue());
        }
        maxFieldDirty = false;
    }
    /**
     * Sets the packager used to pack/unpack this message.
     * @param p - a peer packager
     */
    public void setPackager (ISOPackager p) {
        packager = p;
        if (packager == null) {
            for (Object o : fields.values()) {
                if (o instanceof ISOMsg)
                    ((ISOMsg) o).setPackager(null);
            }
        }
    }
    /**
     * Returns the packager associated with this message.
     * @return the peer packager
     */
    public ISOPackager getPackager () {
        return packager;
    }
    /**
     * Set a field within this message
     * @param c - a component
     */
    public void set (ISOComponent c) throws ISOException {
        if (c != null) {
            Integer i = (Integer) c.getKey();
            fields.put (i, c);
            if (i > maxField)
                maxField = i;
            dirty = true;
        }
    }

    /**
     * Creates an ISOField associated with fldno within this ISOMsg.
     *
     * @param fldno field number
     * @param value field value
     */
    public void set(int fldno, String value) {
        if (value == null) {
            unset(fldno);
            return;
        }

        try {
            if (!(packager instanceof ISOBasePackager)) {
                // No packager is available, we can't tell what the field
                // might be, so treat as a String!
                set(new ISOField(fldno, value));
            }
            else {
                // This ISOMsg has a packager, so use it
                Object obj = ((ISOBasePackager) packager).getFieldPackager(fldno);
                if (obj instanceof ISOBinaryFieldPackager) {
                    set(new ISOBinaryField(fldno, ISOUtil.hex2byte(value)));
                } else {
                    set(new ISOField(fldno, value));
                }
            }
        } catch (ISOException ex) {}; //NOPMD: never happens for the given arguments of set methods
    }

    /**
     * Sets a top-level character field and returns this message for fluent chaining.
     *
     * @param fldno field number
     * @param value field value
     * @return this message
     */
    public ISOMsg with(int fldno, String value) {
        set(fldno, value);
        return this;
    }

    /**
     * Creates an ISOField associated with fldno within this ISOMsg.
     *
     * @param fpath dot-separated field path (i.e. 63.2)
     * @param value field value
     */
    public void set(String fpath, String value) {
        try {
            if (setDatasetPath(fpath, value))
                return;
        } catch (ISOException e) {
            throw new IllegalArgumentException(e.getMessage(), e);
        }
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        for (;;) {
            int fldno = parseInt(st.nextToken());
            if (st.hasMoreTokens()) {
                Object obj = m.getValue(fldno);
                if (obj instanceof ISOMsg)
                    m = (ISOMsg) obj;
                else
                    /**
                     * we need to go deeper, however, if the value == null then
                     * there is nothing to do (unset) at the lower levels, so break now and save some processing.
                     */
                    if (value == null) {
                        break;
                    } else {
                        try {
                            // We have a value to set, so adding a level to hold it is sensible.
                            m.set(m = new ISOMsg (fldno));
                        } catch (ISOException ex) {} //NOPMD: never happens for the given arguments of set methods
                    }
            } else {
                m.set(fldno, value);
                break;
            }
        }
    }

    /**
     * Sets a character field by path and returns this message for fluent chaining.
     *
     * @param fpath dot-separated field path
     * @param value field value
     * @return this message
     */
    public ISOMsg with(String fpath, String value) {
        set(fpath, value);
        return this;
    }

    /**
     * Creates an ISOField associated with fldno within this ISOMsg
     * @param fpath dot-separated field path (i.e. 63.2)
     * @param c component
     * @throws ISOException on error
     */
    public void set(String fpath, ISOComponent c) throws ISOException {
        if (setDatasetPath(fpath, c))
            return;
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        for (;;) {
            int fldno = parseInt(st.nextToken());
            if (st.hasMoreTokens()) {
                Object obj = m.getValue(fldno);
                if (obj instanceof ISOMsg)
                    m = (ISOMsg) obj;
                else
                    /*
                     * we need to go deeper, however, if the value == null then
                     * there is nothing to do (unset) at the lower levels, so break now and save some processing.
                     */
                    if (c == null) {
                        break;
                    } else {
                        // We have a value to set, so adding a level to hold it is sensible.
                        m.set(m = new ISOMsg(fldno));
                    }
            } else {
                if (c != null)
                    c.setFieldNumber(fldno);
                m.set(c);
                break;
            }
        }
    }

    /**
     * Sets a component by path and returns this message for fluent chaining.
     *
     * @param fpath dot-separated field path
     * @param c component to store
     * @return this message
     * @throws ISOException on path or component errors
     */
    public ISOMsg with(String fpath, ISOComponent c) throws ISOException {
        set(fpath, c);
        return this;
    }
    /**
     * Creates an ISOField associated with fldno within this ISOMsg.
     *
     * @param fpath dot-separated field path (i.e. 63.2)
     * @param value binary field value
     */
    public void set(String fpath, byte[] value) {
        try {
            if (setDatasetPath(fpath, value))
                return;
        } catch (ISOException e) {
            throw new IllegalArgumentException(e.getMessage(), e);
        }
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        for (;;) {
            int fldno = parseInt(st.nextToken());
            if (st.hasMoreTokens()) {
                Object obj = m.getValue(fldno);
                if (obj instanceof ISOMsg)
                    m = (ISOMsg) obj;
                else
                    try {
                        m.set(m = new ISOMsg (fldno));
                    } catch (ISOException ex) {} //NOPMD: never happens for the given arguments of set methods
            } else {
                m.set(fldno, value);
                break;
            }
        }
    }

    /**
     * Sets a top-level binary field and returns this message for fluent chaining.
     *
     * @param fldno field number
     * @param value field value
     * @return this message
     */
    public ISOMsg with(int fldno, byte[] value) {
        set(fldno, value);
        return this;
    }

    /**
     * Sets a binary field by path and returns this message for fluent chaining.
     *
     * @param fpath dot-separated field path
     * @param value field value
     * @return this message
     */
    public ISOMsg with(String fpath, byte[] value) {
        set(fpath, value);
        return this;
    }

    /**
     * Creates an ISOBinaryField associated with fldno within this ISOMsg.
     *
     * @param fldno field number
     * @param value field value
     */
    public void set(int fldno, byte[] value) {
        if (value == null) {
            unset(fldno);
            return;
        }

        try {
            set(new ISOBinaryField(fldno, value));
        } catch (ISOException ex) {}; //NOPMD: never happens for the given arguments of set methods
    }


    /**
     * Unset a field if it exists, otherwise ignore.
     * @param fldno - the field number
     */
    @Override
    public void unset (int fldno) {
        if (fields.remove (fldno) != null)
            dirty = maxFieldDirty = true;
    }

    /**
     * Unsets several fields at once
     * @param flds - array of fields to be unset from this ISOMsg
     */
    public void unset (int ... flds) {
        for (int fld : flds)
            unset(fld);
    }

    /**
     * Unset a field referenced by a fpath if it exists, otherwise ignore.
     *
     * @param fpath dot-separated field path (i.e. 63.2)
     */
    public void unset(String fpath) {
        try {
            if (unsetDatasetPath(fpath))
                return;
        } catch (ISOException e) {
            throw new IllegalArgumentException(e.getMessage(), e);
        }
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        ISOMsg lastm = m;
        int fldno = -1 ;
        int lastfldno ;
        for (;;) {
            lastfldno = fldno;
            fldno = parseInt(st.nextToken());
            if (st.hasMoreTokens()) {
                Object obj = m.getValue(fldno);
                if (obj instanceof ISOMsg) {
                    lastm = m;
                    m = (ISOMsg) obj;
                }
                else {
                    // No real way of unset further subfield, exit.
                    break;
                }
            } else {
                m.unset(fldno);
                if (!m.hasFields() && lastfldno != -1) {
                    lastm.unset(lastfldno);
                }
                break;
            }
        }
    }

    /**
     * Unset a a set of fields referenced by fpaths if any ot them exist, otherwise ignore.
     *
     * @param fpaths dot-separated field paths (i.e. 63.2)
     */
    public void unset(String ... fpaths) {
        for (String fpath : fpaths) {
            unset(fpath);
        }
    }

    /**
     * Unsets one or more top-level fields and returns this message for fluent chaining.
     *
     * @param flds field numbers to remove
     * @return this message
     */
    public ISOMsg without(int ... flds) {
        unset(flds);
        return this;
    }

    /**
     * Unsets one or more field paths, including nested composites and dataset elements,
     * and returns this message for fluent chaining.
     *
     * @param fpaths field paths to remove
     * @return this message
     */
    public ISOMsg without(String ... fpaths) {
        unset(fpaths);
        return this;
    }
    /**
     * In order to interchange <b>Composites</b> and <b>Leafs</b> we use
     * getComposite(). A <b>Composite component</b> returns itself and
     * a Leaf returns null.
     *
     * @return ISOComponent
     */
    @Override
    public ISOComponent getComposite() {
        return this;
    }
    /**
     * setup BitMap
     * @exception ISOException on error
     */
    public void recalcBitMap () throws ISOException {
        if (!dirty)
            return;

        int mf = Math.min (getMaxField(), 192);

        BitSet bmap = new BitSet (mf+62 >>6 <<6);
        for (int i=1; i<=mf; i++)
            if (fields.get (i) != null)
                bmap.set (i);
        set (new ISOBitMap (-1, bmap));
        dirty = false;
    }
    /**
     * clone fields
     * @return copy of fields
     */
    @Override
    public Map getChildren() {
        return (Map) ((TreeMap)fields).clone();
    }
    /**
     * Packs this message using the configured packager.
     * @return the packed message
     * @exception ISOException on packing error
     */
    @Override
    public byte[] pack() throws ISOException {
        synchronized (this) {
            recalcBitMap();
            return packager.pack(this);
        }
    }
    /**
     * Unpacks the raw byte array into this message.
     * @param b - raw message
     * @return consumed bytes
     * @exception ISOException on unpacking error
     */
    @Override
    public int unpack(byte[] b) throws ISOException {
        synchronized (this) {
            return packager.unpack(this, b);
        }
    }
    /** {@inheritDoc}
     * @throws IOException on I/O failure
     * @throws ISOException on unpacking error
     */
    @Override
    public void unpack (InputStream in) throws IOException, ISOException {
        synchronized (this) {
            packager.unpack(this, in);
        }
    }
    /**
     * dump the message to a PrintStream. The output is sorta
     * XML, intended to be easily parsed.
     * <br>
     * Each component is responsible for its own dump function,
     * ISOMsg just calls dump on every valid field.
     * @param p - print stream
     * @param indent - optional indent string
     */
    @Override
    public void dump (PrintStream p, String indent) {
        ISOComponent c;
        p.print (indent + "<" + XMLPackager.ISOMSG_TAG);
        switch (direction) {
            case INCOMING:
                p.print (" direction=\"incoming\"");
                break;
            case OUTGOING:
                p.print (" direction=\"outgoing\"");
                break;
        }
        if (fieldNumber != -1)
            p.print (" "+XMLPackager.ID_ATTR +"=\""+fieldNumber +"\"");
        p.println (">");
        String newIndent = indent + "  ";
        if (getPackager() != null) {
           p.println (
              newIndent
           + "<!-- " + getPackager().getDescription() + " -->"
           );
        }
        if (header instanceof Loggeable)
            ((Loggeable) header).dump (p, newIndent);

        for (int i : fields.keySet()) {
           //If you want the bitmap dumped in the log, change the condition from (i >= 0) to (i >= -1). 
            if (i >= 0) {
                if ((c = (ISOComponent) fields.get(i)) != null)
                    c.dump(p, newIndent);
            }
        }

        p.println (indent + "</" + XMLPackager.ISOMSG_TAG+">");
    }
    /**
     * get the component associated with the given field number
     * @param fldno the Field Number
     * @return the Component
     */
    public ISOComponent getComponent(int fldno) {
        return (ISOComponent) fields.get(fldno);
    }
    /**
     * Return the object value associated with the given field number
     * @param fldno the Field Number
     * @return the field Object
     */
    public Object getValue(int fldno) {
        ISOComponent c = getComponent(fldno);
        try {
            return c != null ? c.getValue() : null;
        } catch (ISOException ex) {
            return null; //never happens for the given arguments of getValue method
        }
    }
    /**
     * Return the object value associated with the given field path
     * @param fpath field path
     * @return the field Object (may be null)
     * @throws ISOException on error
     */
    public Object getValue (String fpath) throws ISOException {
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        Object obj;
        for (;;) {
            int fldno = parseInt(st.nextToken());
            obj = m.getValue (fldno);
            if (obj==null){
                // The user will always get a null value for an incorrect path or path not present in the message
                // no point having the ISOException thrown for fields that were not received.
                break;
            }
            if (st.hasMoreTokens()) {
                if (obj instanceof ISOMsg) {
                    m = (ISOMsg) obj;
                }
                else
                    throw new ISOException ("Invalid path '" + fpath + "'");
            } else
                break;
        }
        return obj;
    }
    /**
     * get the component associated with the given field number
     * @param fpath field path
     * @return the Component
     * @throws ISOException on error
     */
    public ISOComponent getComponent (String fpath) throws ISOException {
        StringTokenizer st = new StringTokenizer (fpath, ".");
        ISOMsg m = this;
        ISOComponent obj;
        for (;;) {
            int fldno = parseInt(st.nextToken());
            obj = m.getComponent(fldno);
            if (st.hasMoreTokens()) {
                if (obj instanceof ISOMsg) {
                    m = (ISOMsg) obj;
                }
                else
                    break; // 'Quick' exit if hierarchy is not present.
            } else
                break;
        }
        return obj;
    }
    /**
     * Return the String value associated with the given ISOField number
     * @param fldno the Field Number
     * @return field's String value
     */
    public String getString (int fldno) {
        String s = null;
        if (hasField (fldno)) {
            Object obj = getValue(fldno);
            if (obj instanceof String)
                s = (String) obj;
            else if (obj instanceof byte[])
                s = ISOUtil.hexString((byte[]) obj);
        }
        return s;
    }
    /**
     * Return the String value associated with the given field path
     * @param fpath field path
     * @return field's String value (may be null)
     */
    public String getString (String fpath) {
        String s = null;
        try {
            Object obj = getValue(fpath);
            if (obj instanceof String)
                s = (String) obj;
            else if (obj instanceof byte[])
                s = ISOUtil.hexString ((byte[]) obj);
        } catch (ISOException e) {
            return null;
        }
        return s;
    }
    /**
     * Return the byte[] value associated with the given ISOField number
     * @param fldno the Field Number
     * @return field's byte[] value or null if ISOException or UnsupportedEncodingException happens
     */
    public byte[] getBytes (int fldno) {
        byte[] b = null;
        if (hasField (fldno)) {
            Object obj = getValue(fldno);
            if (obj instanceof String)
                b = ((String) obj).getBytes(ISOUtil.CHARSET);
            else if (obj instanceof byte[])
                b = (byte[]) obj;
        }
        return b;
    }
    /**
     * Return the String value associated with the given field path
     * @param fpath field path
     * @return field's byte[] value (may be null)
     */
    public byte[] getBytes (String fpath) {
        byte[] b = null;
        try {
            Object obj = getValue(fpath);
            if (obj instanceof String)
                b = ((String) obj).getBytes(ISOUtil.CHARSET);
            else if (obj instanceof byte[])
                b = (byte[]) obj;
        } catch (ISOException ignored) {
            return null;
        }
        return b;
    }
    /**
     * Check if a given field is present
     * @param fldno the Field Number
     * @return boolean indicating the existence of the field
     */
    public boolean hasField(int fldno) {
        return fields.get(fldno) != null;
    }
    /**
     * Check if all fields are present
     * @param fields an array of fields to check for presence
     * @return true if all fields are present
     */
    public boolean hasFields (int[] fields) {
        for (int field : fields)
            if (!hasField(field))
                return false;
        return true;
    }

    /**
     * Check if the message has any of these fields
     * @param fields an array of fields to check for presence
     * @return true if at least one field is present
     */
    public boolean hasAny (int[] fields) {
        for (int field : fields)
            if (hasField(field))
                return true;
        return false;
    }
    /**
     * Check if the message has any of these fields
     * @param fields to check for presence
     * @return true if at least one field is present
     */
    public boolean hasAny (String... fields) {
        for (String field : fields)
            if (hasField (field))
                return true;
        return false;
    }

    /**
     * Check if a field indicated by a fpath is present
     * @param fpath dot-separated field path (i.e. 63.2)
     * @return true if field present
     */
     public boolean hasField (String fpath) {
         StringTokenizer st = new StringTokenizer (fpath, ".");
         ISOMsg m = this;
         for (;;) {
             int fldno = parseInt(st.nextToken());
             if (st.hasMoreTokens()) {
                 Object obj = m.getValue(fldno);
                 if (obj instanceof ISOMsg) {
                     m = (ISOMsg) obj;
                 }
                 else {
                     // No real way of checking for further subfields, return false, perhaps should be ISOException?
                     return false;
                 }
             } else {
                 return m.hasField(fldno);
             }
         }
     }
    /**
     * Returns true if this message has at least one field set.
     * @return true if at least one field is present
     */
    public boolean hasFields () {
        return !fields.isEmpty();
    }
    /**
     * Don't call setValue on an ISOMsg. You'll sure get
     * an ISOException. It's intended to be used on Leafs
     * @param obj value to set (not supported on ISOMsg)
     * @throws org.jpos.iso.ISOException always
     * @see ISOField
     * @see ISOException
     */
    @Override
    public void setValue(Object obj) throws ISOException {
        throw new ISOException ("setValue N/A in ISOMsg");
    }

    @Override
    public Object clone() {
        try {
            ISOMsg m = (ISOMsg) super.clone();
            m.fields = (TreeMap) ((TreeMap) fields).clone();
            if (header != null)
                m.header = (ISOHeader) header.clone();
            if (trailer != null)
                m.trailer = trailer.clone();
            for (Integer k : fields.keySet()) {
                ISOComponent c = (ISOComponent) m.fields.get(k);
                if (c instanceof ISOMsg || c instanceof ISODatasetField)
                    m.fields.put(k, cloneComponent(c));
            }
            return m;
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        } catch (ISOException e) {
            throw new IllegalStateException(e);
        }
    }

    /**
     * Partially clone an ISOMsg
     * @param fields int array of fields to go
     * @return new ISOMsg instance
     */
    @SuppressWarnings("PMD.EmptyCatchBlock")
    public Object clone(int ... fields) {
        try {
            ISOMsg m = (ISOMsg) super.clone();
            m.fields = new TreeMap();
            for (int field : fields) {
                if (hasField(field)) {
                    try {
                        ISOComponent c = getComponent(field);
                        if (c instanceof ISOMsg || c instanceof ISODatasetField) {
                            m.set(cloneComponent(c));
                        } else {
                            m.set(c);
                        }
                    } catch (ISOException ignored) {
                        // should never happen
                    }
                }
            }
            return m;
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }
    }

    /**
     * Partially clone an ISOMsg by field paths
     * @param fpaths string array of field paths to copy
     * @return new ISOMsg instance
     */
    public ISOMsg clone(String ... fpaths) {
        try {
            ISOMsg m = (ISOMsg) super.clone();
            m.fields = new TreeMap();
            for (String fpath : fpaths) {
                try {
                    ISOComponent component = getComponent(fpath);
                    if (component instanceof ISOMsg || component instanceof ISODatasetField) {
                        m.set(fpath, cloneComponent(component));
                    } else if (component != null) {
                        m.set(fpath, component);
                    }
                } catch (ISOException ignored) {
                    //should never happen
                }
            }
            return m;
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }
    }

    /**
     * Merges the content of the specified ISOMsg into this ISOMsg instance.
     * It iterates over the fields of the input message and, for each field that is present,
     * sets the corresponding component in this message to the value from the input message.
     * This operation includes all fields that are present in the input message, but does not remove
     * any existing fields from this message unless they are explicitly overwritten by the input message.
     * <p>
     * If the input message contains a header (non-null), this method also clones the header
     * and sets it as the header of this message.
     *
     * @param m The ISOMsg to merge into this ISOMsg. It must not be {@code null}.
     *          The method does nothing if {@code m} is {@code null}.
     * @param mergeHeader A boolean flag indicating whether to merge the header of the input message into this message.
     *
     */
    @SuppressWarnings("PMD.EmptyCatchBlock")
    public void merge (ISOMsg m, boolean mergeHeader) {
        for (int i : m.fields.keySet()) {
            try {
                if (i >= 0 && m.hasField(i))
                    set(m.getComponent(i));
            } catch (ISOException ignored) {
                // should never happen
            }
        }
        if (mergeHeader && m.header != null)
            header = (ISOHeader) m.header.clone();
    }

    /**
     * Merges the content of the specified ISOMsg into this ISOMsg instance, excluding the header.
     * This method is a convenience wrapper around {@link #merge(ISOMsg, boolean)} with the {@code mergeHeader}
     * parameter set to {@code false} for backward compatibility, indicating that the header of the input message
     * will not be merged.
     * @param m the ISOMsg to merge into this message
     */
    public void merge (ISOMsg m) {
        merge (m, false);
    }

    /**
     * @return a string suitable for a log
     */
    @Override
    public String toString() {
        StringBuilder s = new StringBuilder();
        if (isIncoming())
            s.append(" In: ");
        else if (isOutgoing())
            s.append("Out: ");
        else
            s.append("     ");

        s.append(getString(0));
        if (hasField(11)) {
            s.append(' ');
            s.append(getString(11));
        }
        if (hasField(41)) {
            s.append(' ');
            s.append(getString(41));
        }
        return s.toString();
    }
    @Override
    public Object getKey() throws ISOException {
        if (fieldNumber != -1)
            return fieldNumber;
        throw new ISOException ("This is not a subField");
    }
    /** Returns this message itself as its value.
     * @return this ISOMsg
     */
    @Override
    public Object getValue() {
        return this;
    }
    /**
     * Returns true if this is an inner (sub-) message.
     * @return true on inner messages
     */
    public boolean isInner() {
        return fieldNumber > -1;
    }
    /**
     * Sets the message type indicator.
     * @param mti new MTI
     * @exception ISOException if message is inner message
     */
    public void setMTI (String mti) throws ISOException {
        if (isInner())
            throw new ISOException ("can't setMTI on inner message");
        set (new ISOField (0, mti));
    }
    /**
     * moves a field (renumber)
     * @param oldFieldNumber old field number
     * @param newFieldNumber new field number
     * @throws ISOException on error
     */
    public void move (int oldFieldNumber, int newFieldNumber)
        throws ISOException
    {
        ISOComponent c = getComponent (oldFieldNumber);
        unset (oldFieldNumber);
        if (c != null) {
            c.setFieldNumber (newFieldNumber);
            set (c);
        } else
            unset (newFieldNumber);
    }

    @Override
    public int getFieldNumber () {
        return fieldNumber;
    }

    /**
     * Returns true if this message has an MTI field (field 0) set.
     * @return true if MTI is present
     * @exception ISOException if this is an inner message
     */
    public boolean hasMTI() throws ISOException {
        if (isInner())
            throw new ISOException ("can't hasMTI on inner message");
        else
            return hasField(0);
    }
    /**
     * Returns the message type indicator.
     * @return current MTI
     * @exception ISOException on inner message or MTI not set
     */
    public String getMTI() throws ISOException {
        if (isInner())
            throw new ISOException ("can't getMTI on inner message");
        else if (!hasField(0))
            throw new ISOException ("MTI not available");
        return (String) getValue(0);
    }

    /**
     * Returns true if the MTI suggests this is a request message.
     * @return true if message "seems to be" a request
     * @exception ISOException on MTI not set
     */
    public boolean isRequest() throws ISOException {
        return Character.getNumericValue(getMTI().charAt (2))%2 == 0;
    }
    /**
     * Returns true if the MTI suggests this is a response message.
     * @return true if message "seems not to be" a request
     * @exception ISOException on MTI not set
     */
    public boolean isResponse() throws ISOException {
        return !isRequest();
    }
    /**
     * Returns true if this is an authorization message (MTI second digit = 1).
     * @return true if message class is "authorization"
     * @exception ISOException on MTI not set
     */
    public boolean isAuthorization() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '1';
    }
    /**
     * Returns true if this is a financial message (MTI second digit = 2).
     * @return true if message class is "financial"
     * @exception ISOException on MTI not set
     */
    public boolean isFinancial() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '2';
    }
    /**
     * Returns true if this is a file action message (MTI second digit = 3).
     * @return true if message class is "file action"
     * @exception ISOException on MTI not set
     */
    public boolean isFileAction() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '3';
    }
    /**
     * Returns true if this is a reversal message (MTI second digit = 4, last digit 0 or 1).
     * @return true if message class is "reversal"
     * @exception ISOException on MTI not set
     */
    public boolean isReversal() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '4' && (getMTI().charAt(3) == '0' || getMTI().charAt(3) == '1');
    }
    /**
     * Returns true if this is a chargeback message (MTI second digit = 4, last digit 2 or 3).
     * @return true if message class is "chargeback"
     * @exception ISOException on MTI not set
     */
    public boolean isChargeback() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '4' && (getMTI().charAt(3) == '2' || getMTI().charAt(3) == '3');
    }
    /**
     * Returns true if this is a reconciliation message (MTI second digit = 5).
     * @return true if message class is "reconciliation"
     * @exception ISOException on MTI not set
     */
    public boolean isReconciliation() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '5';
    }
    /**
     * Returns true if this is an administrative message (MTI second digit = 6).
     * @return true if message class is "administrative"
     * @exception ISOException on MTI not set
     */
    public boolean isAdministrative() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '6';
    }
    /**
     * Returns true if this is a fee collection message (MTI second digit = 7).
     * @return true if message class is "fee collection"
     * @exception ISOException on MTI not set
     */
    public boolean isFeeCollection() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '7';
    }
    /**
     * Returns true if this is a network management message (MTI second digit = 8).
     * @return true if message class is "network management"
     * @exception ISOException on MTI not set
     */
    public boolean isNetworkManagement() throws ISOException {
        return hasMTI() && getMTI().charAt(1) == '8';
    }
    /**
     * Returns true if this is a retransmission (MTI last digit = 1).
     * @return true if message is a retransmission
     * @exception ISOException on MTI not set
     */
    public boolean isRetransmission() throws ISOException {
        return getMTI().charAt(3) == '1';
    }
    /**
     * sets an appropriate response MTI.
     *
     * i.e. 0100 becomes 0110<br>
     * i.e. 0201 becomes 0210<br>
     * i.e. 1201 becomes 1210<br>
     * @exception ISOException on MTI not set or it is not a request
     */
    public void setResponseMTI() throws ISOException {
        if (!isRequest())
            throw new ISOException ("not a request - can't set response MTI");

        String mti = getMTI();
        char c1 = mti.charAt(3);
        char c2 = '0';
        switch (c1)
        {
            case '0' :
            case '1' : c2='0';break;
            case '2' :
            case '3' : c2='2';break;
            case '4' :
            case '5' : c2='4';break;

        }
        set (new ISOField (0,
            mti.substring(0,2)
            +(Character.getNumericValue(getMTI().charAt (2))+1) + c2
            )
        );
    }
    /**
     * sets an appropriate retransmission MTI<br>
     * @exception ISOException on MTI not set or it is not a request
     */
    public void setRetransmissionMTI() throws ISOException {
        if (!isRequest())
            throw new ISOException ("not a request");

        set (new ISOField (0, getMTI().substring(0,3) + "1"));
    }
    /**
     * Serializes the message header to the given ObjectOutput.
     * @param out the ObjectOutput to write to
     * @throws IOException on write error
     */
    protected void writeHeader (ObjectOutput out) throws IOException {
        int len = header.getLength();
        if (len > 0) {
            out.writeByte ('H');
            out.writeShort (len);
            out.write (header.pack());
        }
    }

    /**
     * Deserializes the message header from the given ObjectInput.
     * @param in the ObjectInput to read from
     * @throws IOException on read error
     * @throws ClassNotFoundException if a referenced class cannot be found
     */
    protected void readHeader (ObjectInput in)
        throws IOException, ClassNotFoundException
    {
        byte[] b = new byte[in.readShort()];
        in.readFully (b);
        setHeader (b);
    }
    /**
     * Serializes the packager class name to the given ObjectOutput.
     * @param out the ObjectOutput to write to
     * @throws IOException on write error
     */
    protected void writePackager(ObjectOutput out) throws IOException {
        out.writeByte('P');
        String pclass = packager.getClass().getName();
        byte[] b = pclass.getBytes();
        out.writeShort(b.length);
        out.write(b);
    }
    /**
     * Deserializes the packager from the given ObjectInput.
     * @param in the ObjectInput to read from
     * @throws IOException on read error
     * @throws ClassNotFoundException if the packager class cannot be found
     */
    protected void readPackager(ObjectInput in) throws IOException,
    ClassNotFoundException {
        byte[] b = new byte[in.readShort()];
        in.readFully(b);
        try {
            Class mypClass = Class.forName(new String(b));
            ISOPackager myp = (ISOPackager) mypClass.newInstance();
            setPackager(myp);
        } catch (Exception e) {
            setPackager(null);
        }

}
    /**
     * Serializes the message direction to the given ObjectOutput.
     * @param out the ObjectOutput to write to
     * @throws IOException on write error
     */
    protected void writeDirection (ObjectOutput out) throws IOException {
        out.writeByte ('D');
        out.writeByte (direction);
    }
    /**
     * Deserializes the message direction from the given ObjectInput.
     * @param in the ObjectInput to read from
     * @throws IOException on read error
     * @throws ClassNotFoundException if a class cannot be found
     */
    protected void readDirection (ObjectInput in)
        throws IOException, ClassNotFoundException
    {
        direction = in.readByte();
    }

    @Override
    public void writeExternal (ObjectOutput out) throws IOException {
        out.writeByte (0);  // reserved for future expansion (version id)
        out.writeShort (fieldNumber);

        if (header != null)
            writeHeader (out);
        if (packager != null)
            writePackager(out);
        if (direction > 0)
            writeDirection (out);

        // List keySet = new ArrayList (fields.keySet());
        // Collections.sort (keySet);
        for (Object o : fields.values()) {
            ISOComponent c = (ISOComponent) o;
            if (c instanceof ISOMsg) {
                writeExternal(out, 'M', c);
            } else if (c instanceof ISOBinaryField) {
                writeExternal(out, 'B', c);
            } else if (c instanceof ISOAmount) {
                writeExternal(out, 'A', c);
            } else if (c instanceof ISOField) {
                writeExternal(out, 'F', c);
            }
        }
        out.writeByte ('E');
    }

    @Override
    public void readExternal  (ObjectInput in)
        throws IOException, ClassNotFoundException
    {
        in.readByte();  // ignore version for now
        fieldNumber = in.readShort();
        byte fieldType;
        ISOComponent c;
        try {
            while ((fieldType = in.readByte()) != 'E') {
                c = null;
                switch (fieldType) {
                    case 'F':
                        c = new ISOField ();
                        break;
                    case 'A':
                        c = new ISOAmount ();
                        break;
                    case 'B':
                        c = new ISOBinaryField ();
                        break;
                    case 'M':
                        c = new ISOMsg ();
                        break;
                    case 'H':
                        readHeader (in);
                        break;
                    case 'P':
                        readPackager(in);
                        break;
                    case 'D':
                        readDirection (in);
                        break;
                    default:
                        throw new IOException ("malformed ISOMsg");
                }
                if (c != null) {
                    ((Externalizable)c).readExternal (in);
                    set (c);
                }
            }
        }
        catch (ISOException e) {
            throw new IOException (e.getMessage());
        }
    }
    /**
     * Let this ISOMsg object hold a weak reference to an ISOSource
     * (usually used to carry a reference to the incoming ISOChannel)
     * @param source an ISOSource
     */
    public void setSource (ISOSource source) {
        this.sourceRef = new WeakReference (source);
    }
    /**
     * Returns the associated ISOSource (e.g. the channel that received this message).
     * @return an ISOSource or null
     */
    public ISOSource getSource () {
        return sourceRef != null ? (ISOSource) sourceRef.get () : null;
    }
    private void writeExternal (ObjectOutput out, char b, ISOComponent c) throws IOException {
        out.writeByte (b);
        ((Externalizable) c).writeExternal (out);
    }
    private int parseInt (String s) {
        return s.startsWith("0x") ? Integer.parseInt(s.substring(2), 16) : Integer.parseInt(s);
    }

    private boolean setDatasetPath(String fpath, Object value) throws ISOException {
        StringTokenizer st = new StringTokenizer(fpath, ".");
        if (st.countTokens() < 2)
            return false;

        int fieldNo = parseInt(st.nextToken());
        ISOFieldPackager fp = null;
        if (packager instanceof ISOBasePackager) {
            fp = ((ISOBasePackager) packager).getFieldPackager(fieldNo);
        }
        if (!(fp instanceof DatasetFieldPackager))
            return false;

        DatasetFieldPackager dfp = (DatasetFieldPackager) fp;
        ISODatasetPackager datasetPackager = dfp.getISODatasetPackager();
        int datasetId;
        int elementId;

        if (!datasetPackager.hasDatasetEnvelope()) {
            if (st.countTokens() != 1)
                return false;
            datasetId = fieldNo;
            elementId = parseInt(st.nextToken());
        } else {
            if (st.countTokens() != 2)
                return false;
            datasetId = parseInt(st.nextToken());
            elementId = parseInt(st.nextToken());
        }

        ISODatasetField field;
        ISOComponent component = getComponent(fieldNo);
        if (component == null) {
            field = new ISODatasetField(fieldNo);
            set(field);
        } else if (component instanceof ISODatasetField) {
            field = (ISODatasetField) component;
        } else {
            throw new ISOException("Field " + fieldNo + " is not a dataset field");
        }

        ISODataset dataset = (ISODataset) field.getDataset(datasetId);
        if (dataset == null) {
            dataset = new ISODataset(datasetId, datasetId <= 0x70 ? DatasetFormat.TLV : DatasetFormat.DBM);
            field.addDataset(dataset);
        }
        dataset.putElement(elementId, toDatasetComponent(elementId, value));
        return true;
    }

    private boolean unsetDatasetPath(String fpath) throws ISOException {
        StringTokenizer st = new StringTokenizer(fpath, ".");
        if (st.countTokens() < 2)
            return false;

        int fieldNo = parseInt(st.nextToken());
        ISOFieldPackager fp = null;
        if (packager instanceof ISOBasePackager) {
            fp = ((ISOBasePackager) packager).getFieldPackager(fieldNo);
        }
        if (!(fp instanceof DatasetFieldPackager))
            return false;

        DatasetFieldPackager dfp = (DatasetFieldPackager) fp;
        ISODatasetPackager datasetPackager = dfp.getISODatasetPackager();
        int datasetId;
        int elementId;

        if (!datasetPackager.hasDatasetEnvelope()) {
            if (st.countTokens() != 1)
                return false;
            datasetId = fieldNo;
            elementId = parseInt(st.nextToken());
        } else {
            if (st.countTokens() != 2)
                return false;
            datasetId = parseInt(st.nextToken());
            elementId = parseInt(st.nextToken());
        }

        ISOComponent component = getComponent(fieldNo);
        if (component == null)
            return true;
        if (!(component instanceof ISODatasetField))
            throw new ISOException("Field " + fieldNo + " is not a dataset field");

        ISODatasetField field = (ISODatasetField) component;
        ISODataset dataset = (ISODataset) field.getDataset(datasetId);
        if (dataset == null)
            return true;

        dataset.removeElement(elementId);
        if (dataset.isEmpty()) {
            field.removeDataset(dataset);
            if (!field.hasDatasets())
                unset(fieldNo);
        }
        return true;
    }

    private ISOComponent toDatasetComponent(int elementId, Object value) throws ISOException {
        if (value instanceof ISOComponent) {
            ISOComponent component = (ISOComponent) value;
            component.setFieldNumber(elementId);
            return component;
        }
        if (value instanceof byte[]) {
            return new ISOBinaryField(elementId, (byte[]) value);
        }
        if (value instanceof String) {
            return new ISOField(elementId, (String) value);
        }
        throw new ISOException("Unsupported dataset value type " + (value != null ? value.getClass().getName() : "null"));
    }

    private ISOComponent cloneComponent(ISOComponent c) throws ISOException {
        if (c instanceof ISOMsg)
            return (ISOComponent) ((ISOMsg) c).clone();
        if (c instanceof ISODatasetField)
            return cloneDatasetField((ISODatasetField) c);
        return c;
    }

    private ISODatasetField cloneDatasetField(ISODatasetField field) throws ISOException {
        ISODatasetField clone = new ISODatasetField(field.getFieldNumber());
        for (Dataset dataset : field.getDatasets()) {
            clone.addDataset(cloneDataset(dataset));
        }
        return clone;
    }

    private ISODataset cloneDataset(Dataset dataset) throws ISOException {
        ISODataset clone = new ISODataset(dataset.getIdentifier(), dataset.getFormat());
        for (DatasetElement element : dataset.getElements()) {
            clone.addElement(element.getId(), cloneDatasetComponent(element.getComponent()), element.isConstructed());
        }
        return clone;
    }

    private ISOComponent cloneDatasetComponent(ISOComponent component) throws ISOException {
        if (component instanceof ISOMsg)
            return (ISOComponent) ((ISOMsg) component).clone();
        if (component instanceof ISOBinaryField)
            return new ISOBinaryField(component.getFieldNumber(), component.getBytes() != null ? component.getBytes().clone() : null);
        if (component instanceof ISOField)
            return new ISOField(component.getFieldNumber(), (String) component.getValue());
        return component;
    }
}