querylastmsgsresp.java

短信短消息SMPP开发的JAVA API最新版本。

/*
 * Java SMPP API
 * Copyright (C) 1998 - 2002 by Oran Kelly
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * A copy of the LGPL can be viewed at http://www.gnu.org/copyleft/lesser.html
 * Java SMPP API author: [e-mail]
 * Java SMPP API Homepage: http://smppapi.sourceforge.net/
 * $Id: QueryLastMsgsResp.java,v 1.17 2004/07/11 20:28:08 orank Exp $
 */
package ie.omk.smpp.message;

import ie.omk.smpp.util.SMPPIO;

import java.io.OutputStream;
import java.util.Iterator;
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 Vector 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.addElement(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()
    {
	String s = null;

	// 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
    {
	String s = null;
	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;
	long id = 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.addElement(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");
    }
}