Package com.opencloud.slee.resources.in.datatypes.sms

Class SMSStatusReport

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class SMSStatusReport
extends SMSTPDUWithData
implements FastSerializable
    Representation of a SMS-STATUS-REPORT TPDU as defined in 3GPP TS 23.040 V9.0.0 (2009-06).

    The API offered by this class is as if the type were specified in ASN.1 as follows. 

     SMSStatusReport ::= SEQUENCE {
     onlyHeader              NULL OPTIONAL,
     userDataHeaderIndicator UserDataHeaderIndicator,
     statusReportQualifier   BOOLEAN,
     moreMessagesToSend      MoreMessagesToSend,
     loopPrevention          BOOLEAN OPTIONAL,
     messageReference        INTEGER,
     recipientAddress        SMSAddress,
     serviceCentreTimeStamp  SMSTimeStamp,
     dischargeTime           SMSTimeStamp,
     status                  INTEGER,
     protocolId              SMSProtocolId        OPTIONAL,
     dataCodingScheme        SMSDataCodingScheme  OPTIONAL,
     userDataLength          INTEGER OPTIONAL,
     userData                OCTET STRING OPTIONAL
 }
    The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below.

    Data Encoding - based on 3GPP TS 23.040 V9.0.0 (2009-06) §9.2.2.3 pp60-61
    76543210
    1 octet0User data header indicatorStatus report qualifier?0Loop prevention?More messages to sendMessage type
    10
    1 octetMessage reference
    2-12 octetsRecipient address
    7 octetsService center time stamp
    7 octetsDischarge time
    1 octetStatus
    0-1 octets00000Has user data length?Has data coding scheme?Has protocol identifier?
    0-1 octetsProtocol id
    0-1 octetsData coding scheme
    0-1 octetsUser data length
    0-143 octetsUser data

    In the above table, field names ending in ? are booleans: 1 for true, 0 for false.

    Field loopPrevention is optional because that bit was spare prior to release 6 of 3GPP TS 23.040.

    See Also:
    Serialized Form

    • Constructor Detail

      • SMSStatusReport

        public SMSStatusReport()
        Constructs a new SMSStatusReport object with no fields set.

      • SMSStatusReport

        public SMSStatusReport​(byte[] data)
        Constructs a new SMSStatusReport object from network-encoded data. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        Throws:
        NullPointerException - if data is null

      • SMSStatusReport

        public SMSStatusReport​(byte[] data,
                       int start,
                       int len)
        Constructs a new SMSStatusReport object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        start - starting offset of network-encoded data in byte array
        len - default length if not predictable
        Throws:
        NullPointerException - if data is null
        IllegalArgumentException - if len is negative

      • SMSStatusReport

        public SMSStatusReport​(DataInput in)
                throws IOException
        Constructs a new SMSStatusReport object from data deserialized from a stream that was written by toStream(DataOutput).
        Parameters:
        in - the stream to read from
        Throws:
        EOFException - if reading is pre-empted by end-of-file
        IOException - if the data cannot be read

    • Method Detail

      • hasStatusReportQualifier

        public boolean hasStatusReportQualifier()
                                 throws DecodeException
        Tests whether the field StatusReportQualifier has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setStatusReportQualifierPresent

        public SMSStatusReport setStatusReportQualifierPresent​(boolean flag)
                                                throws IllegalStateException
        Sets the presence or absence of the field StatusReportQualifier.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • hasMoreMessagesToSend

        public boolean hasMoreMessagesToSend()
                              throws DecodeException
        Tests whether the field MoreMessagesToSend has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasLoopPrevention

        public boolean hasLoopPrevention()
                          throws DecodeException
        Tests whether the field LoopPrevention has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setLoopPreventionPresent

        public SMSStatusReport setLoopPreventionPresent​(boolean flag)
                                         throws IllegalStateException
        Sets the presence or absence of the field LoopPrevention.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • hasMessageReference

        public boolean hasMessageReference()
                            throws DecodeException
        Tests whether the field MessageReference has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setMessageReferencePresent

        public SMSStatusReport setMessageReferencePresent​(boolean flag)
                                           throws IllegalStateException
        Sets the presence or absence of the field MessageReference.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • hasRecipientAddress

        public boolean hasRecipientAddress()
                            throws DecodeException
        Tests whether the field RecipientAddress has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasServiceCentreTimeStamp

        public boolean hasServiceCentreTimeStamp()
                                  throws DecodeException
        Tests whether the field ServiceCentreTimeStamp has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasDischargeTime

        public boolean hasDischargeTime()
                         throws DecodeException
        Tests whether the field DischargeTime has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasStatus

        public boolean hasStatus()
                  throws DecodeException
        Tests whether the field Status has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setStatusPresent

        public SMSStatusReport setStatusPresent​(boolean flag)
                                 throws IllegalStateException
        Sets the presence or absence of the field Status.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • getStatusReportQualifier

        public boolean getStatusReportQualifier()
                                 throws DecodeException
        Gets the value of whether the previously submitted TPDU was a SMSSubmit or SMSCommand.
        Returns:
        boolean representation of whether the previously submitted TPDU was a SMSSubmit or SMSCommand
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getMoreMessagesToSend

        public SMSStatusReport.MoreMessagesToSend getMoreMessagesToSend()
                                                         throws DecodeException
        Gets the value of whether there are no more messages to send.
        Returns:
        MoreMessagesToSend representation of whether there are no more messages to send
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getLoopPrevention

        public boolean getLoopPrevention()
                          throws DecodeException
        Gets the value of whether SMS applications should inhibit forwarding or automatic message generation that could cause infinite looping.
        Returns:
        boolean representation of whether SMS applications should inhibit forwarding or automatic message generation that could cause infinite looping
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getMessageReference

        public int getMessageReference()
                        throws DecodeException
        Gets the value of identifies the previously submitted SMSSubmit or SMSCommand.
        Returns:
        int representation of identifies the previously submitted SMSSubmit or SMSCommand
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getRecipientAddress

        public SMSAddress getRecipientAddress()
                               throws DecodeException
        Gets the value of recipient of the previously submitted mobile originated short message.
        Returns:
        SMSAddress representation of recipient of the previously submitted mobile originated short message
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getServiceCentreTimeStamp

        public SMSTimeStamp getServiceCentreTimeStamp()
                                       throws DecodeException
        Gets the value of time when the SC received the previously sent SMSSUBMIT.
        Returns:
        SMSTimeStamp representation of time when the SC received the previously sent SMSSUBMIT
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getDischargeTime

        public SMSTimeStamp getDischargeTime()
                              throws DecodeException
        Gets the value of time associated with a particular TP-ST outcome.
        Returns:
        SMSTimeStamp representation of time associated with a particular TP-ST outcome
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getStatus

        public int getStatus()
              throws DecodeException
        Gets the value of status of the previously sent mobile originated short message.
        Returns:
        int representation of status of the previously sent mobile originated short message
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setStatusReportQualifier

        public SMSStatusReport setStatusReportQualifier​(boolean value)
                                         throws IllegalStateException
        Sets the value of whether the previously submitted TPDU was a SMSSubmit or SMSCommand.
        Parameters:
        value - boolean representation of whether the previously submitted TPDU was a SMSSubmit or SMSCommand
        Returns:
        this
        Throws:
        IllegalStateException

      • setLoopPrevention

        public SMSStatusReport setLoopPrevention​(boolean value)
                                  throws IllegalStateException
        Sets the value of whether SMS applications should inhibit forwarding or automatic message generation that could cause infinite looping.
        Parameters:
        value - boolean representation of whether SMS applications should inhibit forwarding or automatic message generation that could cause infinite looping
        Returns:
        this
        Throws:
        IllegalStateException

      • setMessageReference

        public SMSStatusReport setMessageReference​(int value)
                                    throws IllegalStateException
        Sets the value of identifies the previously submitted SMSSubmit or SMSCommand.
        Parameters:
        value - int representation of identifies the previously submitted SMSSubmit or SMSCommand
        Returns:
        this
        Throws:
        IllegalStateException

      • setRecipientAddress

        public SMSStatusReport setRecipientAddress​(SMSAddress value)
                                    throws IllegalStateException
        Sets the value of recipient of the previously submitted mobile originated short message.
        Parameters:
        value - SMSAddress representation of recipient of the previously submitted mobile originated short message
        Returns:
        this
        Throws:
        IllegalStateException

      • setServiceCentreTimeStamp

        public SMSStatusReport setServiceCentreTimeStamp​(SMSTimeStamp value)
                                          throws IllegalStateException
        Sets the value of time when the SC received the previously sent SMSSUBMIT.
        Parameters:
        value - SMSTimeStamp representation of time when the SC received the previously sent SMSSUBMIT
        Returns:
        this
        Throws:
        IllegalStateException

      • setStatus

        public SMSStatusReport setStatus​(int value)
                          throws IllegalStateException
        Sets the value of status of the previously sent mobile originated short message.
        Parameters:
        value - int representation of status of the previously sent mobile originated short message
        Returns:
        this
        Throws:
        IllegalStateException

      • copyOf

        public static SMSStatusReport copyOf​(SMSStatusReport from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        SMSStatusReport

      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]

      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value for the fields of a sequence. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • encodedIsInvalid

        protected boolean encodedIsInvalid()
        Determines whether the encoded form is invalid.
        Returns:
        boolean

      • getType

        public SMSTPDU.Type getType()
        Description copied from class: SMSTPDU
        Return the message type of this PDU
        Specified by:
        getType in class SMSTPDU
        Returns:
        the type

      • getContainedLength

        public int getContainedLength​(byte[] data,
                              int start,
                              int len)
        Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        length of encoded value, or 0 if not decodable
        Throws:
        NullPointerException - if data is null

      • newInstanceOnlyHeader

        public static SMSStatusReport newInstanceOnlyHeader()
        Factory method that creates an instance for representing only a header (no data).
        Returns:
        SMSStatusReport

      • decodeRPUIHeaderStatusReport

        public static SMSStatusReport decodeRPUIHeaderStatusReport​(byte[] message,
                                                           int start,
                                                           int len)
        Constructs a new SMSStatusReport with no data (header only) from the given data. Decoding is deferred until needed.
        Parameters:
        message - a bytearray containing the encoded header
        start - the offset within 'message' to begin decoding
        len - the number of valid bytes after 'offset' to decode (must be at least 1)
        Returns:
        SMSStatusReport
        Throws:
        NullPointerException - if message is null
        ArrayIndexOutOfBoundsException - if start or len are out of range

      • decodeRPUIHeaderStatusReport

        public static SMSStatusReport decodeRPUIHeaderStatusReport​(byte[] message)
        Constructs a new SMSStatusReport with no data (header only) from the given data. Equivalent to decodeRPUIHeaderStatusReport(message, 0, message.length)
        Parameters:
        message - a bytearray containing the encoded header
        Returns:
        SMSStatusReport
        Throws:
        NullPointerException - if message is null

      • encodeRPUIHeaderStatusReport

        public static byte[] encodeRPUIHeaderStatusReport​(SMSStatusReport smsStatusReport)
                                           throws EncodeException
        Encodes the given SMSStatusReport for sending as the payload of a SM-RP-UIHeader message.
        Parameters:
        smsStatusReport - the pdu to encode
        Returns:
        the encoded form of smsStatusReport
        Throws:
        EncodeException - if smsStatusReport is not only a header