ie.omk.smpp.message.QueryMsgDetails 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.Address;
import ie.omk.smpp.util.GSMConstants;
import ie.omk.smpp.util.SMPPIO;

import java.io.OutputStream;

/**
 * Query Message details. Get all information about an existing message at the
 * SMSC. Relevant inherited fields from SMPPPacket: 

 * 
 * messageId source
 * 
 * 
 * @author Oran Kelly
 * @version 1.0
 */
public class QueryMsgDetails extends ie.omk.smpp.message.SMPPRequest {
    /** Length of the message text required */
    private int smLength;

    /**
     * Construct a new QueryMsgDetails.
     */
    public QueryMsgDetails() {
        super(QUERY_MSG_DETAILS);
    }

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

    /**
     * Set the number of bytes of the original message required. Minimum request
     * length is 0, maximum is 160. If the length is outside these bounds, it
     * will be set to the min or max.
     * 
     * @param len
     *            The number of bytes required.
     */
    public void setSmLength(int len) {
        smLength = len;

        if (smLength < 0) {
            smLength = 0;
        }
        if (smLength > 160) {
            smLength = 160;
        }
    }

    /** Get the number of bytes of the original message being requested. */
    public int getSmLength() {
        return smLength;
    }

    public int getBodyLength() {
        int len = ((messageId != null) ? messageId.length() : 0)
                + ((source != null) ? source.getLength() : 3);

        // 1 1-byte integer, 1 c-string
        return len + 1 + 1;
    }

    /**
     * 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 {
        SMPPIO.writeCString(getMessageId(), out);

        if (source != null) {
            source.writeTo(out);
        } else {
            // Write ton=0(null), npi=0(null), address=\0(nul)
            new Address(GSMConstants.GSM_TON_UNKNOWN,
                    GSMConstants.GSM_NPI_UNKNOWN, "").writeTo(out);
        }
        SMPPIO.writeInt(smLength, 1, out);
    }

    public void readBodyFrom(byte[] body, int offset)
            throws SMPPProtocolException {
        messageId = SMPPIO.readCString(body, offset);
        offset += messageId.length() + 1;

        source = new Address();
        source.readFrom(body, offset);
        offset += source.getLength();

        smLength = SMPPIO.bytesToInt(body, offset++, 1);
    }

    /**
     * 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_msg_details");
    }
}