FileDocCategorySizeDatePackage
SmsHeader.javaAPI DocAndroid 5.1 API13619Thu Mar 12 22:22:54 GMT 2015com.android.internal.telephony

SmsHeader

public class SmsHeader extends Object
SMS user data header, as specified in TS 23.040 9.2.3.24.

Fields Summary
public static final int
ELT_ID_CONCATENATED_8_BIT_REFERENCE
SMS user data header information element identifiers. (see TS 23.040 9.2.3.24)
public static final int
ELT_ID_SPECIAL_SMS_MESSAGE_INDICATION
public static final int
ELT_ID_APPLICATION_PORT_ADDRESSING_8_BIT
public static final int
ELT_ID_APPLICATION_PORT_ADDRESSING_16_BIT
public static final int
ELT_ID_SMSC_CONTROL_PARAMS
public static final int
ELT_ID_UDH_SOURCE_INDICATION
public static final int
ELT_ID_CONCATENATED_16_BIT_REFERENCE
public static final int
ELT_ID_WIRELESS_CTRL_MSG_PROTOCOL
public static final int
ELT_ID_TEXT_FORMATTING
public static final int
ELT_ID_PREDEFINED_SOUND
public static final int
ELT_ID_USER_DEFINED_SOUND
public static final int
ELT_ID_PREDEFINED_ANIMATION
public static final int
ELT_ID_LARGE_ANIMATION
public static final int
ELT_ID_SMALL_ANIMATION
public static final int
ELT_ID_LARGE_PICTURE
public static final int
ELT_ID_SMALL_PICTURE
public static final int
ELT_ID_VARIABLE_PICTURE
public static final int
ELT_ID_USER_PROMPT_INDICATOR
public static final int
ELT_ID_EXTENDED_OBJECT
public static final int
ELT_ID_REUSED_EXTENDED_OBJECT
public static final int
ELT_ID_COMPRESSION_CONTROL
public static final int
ELT_ID_OBJECT_DISTR_INDICATOR
public static final int
ELT_ID_STANDARD_WVG_OBJECT
public static final int
ELT_ID_CHARACTER_SIZE_WVG_OBJECT
public static final int
ELT_ID_EXTENDED_OBJECT_DATA_REQUEST_CMD
public static final int
ELT_ID_RFC_822_EMAIL_HEADER
public static final int
ELT_ID_HYPERLINK_FORMAT_ELEMENT
public static final int
ELT_ID_REPLY_ADDRESS_ELEMENT
public static final int
ELT_ID_ENHANCED_VOICE_MAIL_INFORMATION
public static final int
ELT_ID_NATIONAL_LANGUAGE_SINGLE_SHIFT
public static final int
ELT_ID_NATIONAL_LANGUAGE_LOCKING_SHIFT
public static final int
PORT_WAP_PUSH
public static final int
PORT_WAP_WSP
public PortAddrs
portAddrs
public ConcatRef
concatRef
public ArrayList
specialSmsMsgList
public ArrayList
miscEltList
public int
languageTable
7 bit national language locking shift table, or 0 for GSM default 7 bit alphabet.
public int
languageShiftTable
7 bit national language single shift table, or 0 for GSM default 7 bit extension table.
Constructors Summary
public SmsHeader()
Methods Summary
public static com.android.internal.telephony.SmsHeaderfromByteArray(byte[] data)
Create structured SmsHeader object from serialized byte array representation. (see TS 23.040 9.2.3.24)

param
data is user data header bytes
return
SmsHeader object

        ByteArrayInputStream inStream = new ByteArrayInputStream(data);
        SmsHeader smsHeader = new SmsHeader();
        while (inStream.available() > 0) {
            /**
             * NOTE: as defined in the spec, ConcatRef and PortAddr
             * fields should not reoccur, but if they do the last
             * occurrence is to be used.  Also, for ConcatRef
             * elements, if the count is zero, sequence is zero, or
             * sequence is larger than count, the entire element is to
             * be ignored.
             */
            int id = inStream.read();
            int length = inStream.read();
            ConcatRef concatRef;
            PortAddrs portAddrs;
            switch (id) {
            case ELT_ID_CONCATENATED_8_BIT_REFERENCE:
                concatRef = new ConcatRef();
                concatRef.refNumber = inStream.read();
                concatRef.msgCount = inStream.read();
                concatRef.seqNumber = inStream.read();
                concatRef.isEightBits = true;
                if (concatRef.msgCount != 0 && concatRef.seqNumber != 0 &&
                        concatRef.seqNumber <= concatRef.msgCount) {
                    smsHeader.concatRef = concatRef;
                }
                break;
            case ELT_ID_CONCATENATED_16_BIT_REFERENCE:
                concatRef = new ConcatRef();
                concatRef.refNumber = (inStream.read() << 8) | inStream.read();
                concatRef.msgCount = inStream.read();
                concatRef.seqNumber = inStream.read();
                concatRef.isEightBits = false;
                if (concatRef.msgCount != 0 && concatRef.seqNumber != 0 &&
                        concatRef.seqNumber <= concatRef.msgCount) {
                    smsHeader.concatRef = concatRef;
                }
                break;
            case ELT_ID_APPLICATION_PORT_ADDRESSING_8_BIT:
                portAddrs = new PortAddrs();
                portAddrs.destPort = inStream.read();
                portAddrs.origPort = inStream.read();
                portAddrs.areEightBits = true;
                smsHeader.portAddrs = portAddrs;
                break;
            case ELT_ID_APPLICATION_PORT_ADDRESSING_16_BIT:
                portAddrs = new PortAddrs();
                portAddrs.destPort = (inStream.read() << 8) | inStream.read();
                portAddrs.origPort = (inStream.read() << 8) | inStream.read();
                portAddrs.areEightBits = false;
                smsHeader.portAddrs = portAddrs;
                break;
            case ELT_ID_NATIONAL_LANGUAGE_SINGLE_SHIFT:
                smsHeader.languageShiftTable = inStream.read();
                break;
            case ELT_ID_NATIONAL_LANGUAGE_LOCKING_SHIFT:
                smsHeader.languageTable = inStream.read();
                break;
            case ELT_ID_SPECIAL_SMS_MESSAGE_INDICATION:
                SpecialSmsMsg specialSmsMsg = new SpecialSmsMsg();
                specialSmsMsg.msgIndType = inStream.read();
                specialSmsMsg.msgCount = inStream.read();
                smsHeader.specialSmsMsgList.add(specialSmsMsg);
                break;
            default:
                MiscElt miscElt = new MiscElt();
                miscElt.id = id;
                miscElt.data = new byte[length];
                inStream.read(miscElt.data, 0, length);
                smsHeader.miscEltList.add(miscElt);
            }
        }
        return smsHeader;
public static byte[]toByteArray(com.android.internal.telephony.SmsHeader smsHeader)
Create serialized byte array representation from structured SmsHeader object. (see TS 23.040 9.2.3.24)

return
Byte array representing the SmsHeader

        if ((smsHeader.portAddrs == null) &&
            (smsHeader.concatRef == null) &&
            (smsHeader.specialSmsMsgList.isEmpty()) &&
            (smsHeader.miscEltList.isEmpty()) &&
            (smsHeader.languageShiftTable == 0) &&
            (smsHeader.languageTable == 0)) {
            return null;
        }

        ByteArrayOutputStream outStream =
                new ByteArrayOutputStream(SmsConstants.MAX_USER_DATA_BYTES);
        ConcatRef concatRef = smsHeader.concatRef;
        if (concatRef != null) {
            if (concatRef.isEightBits) {
                outStream.write(ELT_ID_CONCATENATED_8_BIT_REFERENCE);
                outStream.write(3);
                outStream.write(concatRef.refNumber);
            } else {
                outStream.write(ELT_ID_CONCATENATED_16_BIT_REFERENCE);
                outStream.write(4);
                outStream.write(concatRef.refNumber >>> 8);
                outStream.write(concatRef.refNumber & 0x00FF);
            }
            outStream.write(concatRef.msgCount);
            outStream.write(concatRef.seqNumber);
        }
        PortAddrs portAddrs = smsHeader.portAddrs;
        if (portAddrs != null) {
            if (portAddrs.areEightBits) {
                outStream.write(ELT_ID_APPLICATION_PORT_ADDRESSING_8_BIT);
                outStream.write(2);
                outStream.write(portAddrs.destPort);
                outStream.write(portAddrs.origPort);
            } else {
                outStream.write(ELT_ID_APPLICATION_PORT_ADDRESSING_16_BIT);
                outStream.write(4);
                outStream.write(portAddrs.destPort >>> 8);
                outStream.write(portAddrs.destPort & 0x00FF);
                outStream.write(portAddrs.origPort >>> 8);
                outStream.write(portAddrs.origPort & 0x00FF);
            }
        }
        if (smsHeader.languageShiftTable != 0) {
            outStream.write(ELT_ID_NATIONAL_LANGUAGE_SINGLE_SHIFT);
            outStream.write(1);
            outStream.write(smsHeader.languageShiftTable);
        }
        if (smsHeader.languageTable != 0) {
            outStream.write(ELT_ID_NATIONAL_LANGUAGE_LOCKING_SHIFT);
            outStream.write(1);
            outStream.write(smsHeader.languageTable);
        }
        for (SpecialSmsMsg specialSmsMsg : smsHeader.specialSmsMsgList) {
            outStream.write(ELT_ID_SPECIAL_SMS_MESSAGE_INDICATION);
            outStream.write(2);
            outStream.write(specialSmsMsg.msgIndType & 0xFF);
            outStream.write(specialSmsMsg.msgCount & 0xFF);
        }
        for (MiscElt miscElt : smsHeader.miscEltList) {
            outStream.write(miscElt.id);
            outStream.write(miscElt.data.length);
            outStream.write(miscElt.data, 0, miscElt.data.length);
        }
        return outStream.toByteArray();
public java.lang.StringtoString()

        StringBuilder builder = new StringBuilder();
        builder.append("UserDataHeader ");
        builder.append("{ ConcatRef ");
        if (concatRef == null) {
            builder.append("unset");
        } else {
            builder.append("{ refNumber=" + concatRef.refNumber);
            builder.append(", msgCount=" + concatRef.msgCount);
            builder.append(", seqNumber=" + concatRef.seqNumber);
            builder.append(", isEightBits=" + concatRef.isEightBits);
            builder.append(" }");
        }
        builder.append(", PortAddrs ");
        if (portAddrs == null) {
            builder.append("unset");
        } else {
            builder.append("{ destPort=" + portAddrs.destPort);
            builder.append(", origPort=" + portAddrs.origPort);
            builder.append(", areEightBits=" + portAddrs.areEightBits);
            builder.append(" }");
        }
        if (languageShiftTable != 0) {
            builder.append(", languageShiftTable=" + languageShiftTable);
        }
        if (languageTable != 0) {
            builder.append(", languageTable=" + languageTable);
        }
        for (SpecialSmsMsg specialSmsMsg : specialSmsMsgList) {
            builder.append(", SpecialSmsMsg ");
            builder.append("{ msgIndType=" + specialSmsMsg.msgIndType);
            builder.append(", msgCount=" + specialSmsMsg.msgCount);
            builder.append(" }");
        }
        for (MiscElt miscElt : miscEltList) {
            builder.append(", MiscElt ");
            builder.append("{ id=" + miscElt.id);
            builder.append(", length=" + miscElt.data.length);
            builder.append(", data=" + HexDump.toHexString(miscElt.data));
            builder.append(" }");
        }
        builder.append(" }");
        return builder.toString();