ie.omk.smpp.message.QueryLastMsgsResp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smppapi Show documentation
Java Implementation of the Short Message Peer to Peer API.
The newest version!
package ie.omk.smpp.message;

import ie.omk.smpp.util.SMPPIO;

import java.io.OutputStream;
import java.util.Iterator;
import java.util.List;
import java.util.Vector;

/**
 * SMSC response to a QueryLastMsgs request.
 * 
 * @author Oran Kelly
 * @version 1.0
 */
public class QueryLastMsgsResp extends ie.omk.smpp.message.SMPPResponse {
    /** The table of messages returned */
    private List messageTable = new Vector();

    /**
     * Construct a new QueryLastMsgsResp.
     */
    public QueryLastMsgsResp() {
        super(QUERY_LAST_MSGS_RESP);
    }

    /**
     * Construct a new QueryLastMsgsResp with specified sequence number.
     * 
     * @param seqNum
     *            The sequence number to use
     * @deprecated
     */
    public QueryLastMsgsResp(int seqNum) {
        super(QUERY_LAST_MSGS_RESP, seqNum);
    }

    /**
     * Create a new QueryLastMsgsResp packet in response to a BindReceiver. This
     * constructor will set the sequence number to it's expected value.
     * 
     * @param r
     *            The Request packet the response is to
     */
    public QueryLastMsgsResp(QueryLastMsgs r) {
        super(r);
    }

    /**
     * Add a message Id to the response packet.
     * 
     * @param id
     *            The message Id to add to the packet.
     * @return The current number of message Ids (including the new one).
     * @throws ie.omk.smpp.message.InvalidParameterValueException
     *             if the id is invalid.
     */
    public int addMessageId(String id) {
        if (!version.validateMessageId(id)) {
            throw new InvalidParameterValueException("Invalid message ID", id);
        }

        synchronized (messageTable) {
            messageTable.add(id);
            return messageTable.size();
        }
    }

    /** Get the number of message Ids. */
    public int getMsgCount() {
        return messageTable.size();
    }

    /**
     * Get a String array of the message Ids.
     * 
     * @return A String array of all the message Ids.
     */
    public String[] getMessageIds() {
        String[] ids;
        int loop = 0;

        synchronized (messageTable) {
            if (messageTable.size() == 0) {
                return null;
            }

            ids = new String[messageTable.size()];
            Iterator i = messageTable.iterator();
            while (i.hasNext()) {
                ids[loop++] = (String) i.next();
            }
        }

        return ids;
    }

    public int getBodyLength() {
        // 1 1-byte integer!
        int size = 1;
        synchronized (messageTable) {
            Iterator i = messageTable.iterator();
            while (i.hasNext()) {
                size += ((String) i.next()).length() + 1;
            }
        }

        return size;
    }

    /**
     * Write a byte representation of this packet to an OutputStream
     * 
     * @param out
     *            The OutputStream to write to
     * @throws java.io.IOException
     *             if there's an error writing to the output stream.
     */
    protected void encodeBody(OutputStream out) throws java.io.IOException {
        synchronized (messageTable) {
            int size = messageTable.size();
            SMPPIO.writeInt(size, 1, out);
            Iterator i = messageTable.iterator();
            while (i.hasNext()) {
                SMPPIO.writeCString((String) i.next(), out);
            }
        }
    }

    public void readBodyFrom(byte[] body, int offset)
            throws SMPPProtocolException {
        int msgCount = 0;
        msgCount = SMPPIO.bytesToInt(body, offset++, 1);

        for (int loop = 0; loop < msgCount; loop++) {
            String s = SMPPIO.readCString(body, offset);
            offset += s.length() + 1;
            messageTable.add(s);
        }
    }

    /**
     * Convert this packet to a String. Not to be interpreted programmatically,
     * it's just dead handy for debugging!
     */
    public String toString() {
        return new String("query_last_msgs_resp");
    }
}