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

Class SMSSubmit

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class SMSSubmit
extends SMSTPDUWithData
implements FastSerializable
    Representation of a SMS-SUBMIT TPDU.

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

     SMSSubmit ::= SEQUENCE {
     onlyHeader              NULL OPTIONAL,
     replyPath               ReplyPath,
     userDataHeaderIndicator UserDataHeaderIndicator,
     statusReportRequest     StatusReportRequest,
     rejectDuplicates        BOOLEAN,
     messageReference        INTEGER,
     destinationAddress      SMSAddress,
     protocolId              SMSProtocolId,
     dataCodingScheme        SMSDataCodingScheme,
     validityPeriod          ValidityPeriod 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.2 pp55-58
    76543210
    1 octetReply pathUser data header indicatorStatus report requestValidity period formatReject duplicates?Message type
    01
    1 octetMessage reference
    2-12 octetsDestination address
    1 octetProtocol id
    1 octetData coding scheme
    0,1,7 octetsValidity period
    1 octetUser data length
    0-140 octetsUser data

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

    • Constructor Detail

      • SMSSubmit

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

      • SMSSubmit

        public SMSSubmit​(byte[] data)
        Constructs a new SMSSubmit 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

      • SMSSubmit

        public SMSSubmit​(byte[] data,
                 int start,
                 int len)
        Constructs a new SMSSubmit 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

      • SMSSubmit

        public SMSSubmit​(DataInput in)
          throws IOException
        Constructs a new SMSSubmit 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

      • hasRejectDuplicates

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

      • setRejectDuplicatesPresent

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

      • hasStatusReportRequest

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

      • hasReplyPath

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

      • 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 SMSSubmit 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

      • hasDestinationAddress

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

      • hasValidityPeriod

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

      • getRejectDuplicates

        public boolean getRejectDuplicates()
                            throws DecodeException
        Gets the value of whether the SC shall accept an SMSSubmit for an SM still held in the SC which has the same TP-MR and the same TP-DA as a previously submitted SM from the same OA.
        Returns:
        boolean representation of whether the SC shall accept an SMSSubmit for an SM still held in the SC which has the same TP-MR and the same TP-DA as a previously submitted SM from the same OA
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getStatusReportRequest

        public SMSSubmit.StatusReportRequest getStatusReportRequest()
                                                     throws DecodeException
        Gets the value of whether the MS is requesting a status report.
        Returns:
        StatusReportRequest representation of whether the MS is requesting a status report
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getReplyPath

        public SMSSubmit.ReplyPath getReplyPath()
                                 throws DecodeException
        Gets the value of the request for reply path.
        Returns:
        ReplyPath representation of the request for reply path
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getMessageReference

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

      • getDestinationAddress

        public SMSAddress getDestinationAddress()
                                 throws DecodeException
        Gets the value of the address of the destination SME.
        Returns:
        SMSAddress representation of the address of the destination SME
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getValidityPeriod

        public SMSSubmit.ValidityPeriod getValidityPeriod()
                                           throws DecodeException
        Gets the value of the time from where the message is no longer valid.
        Returns:
        ValidityPeriod representation of the time from where the message is no longer valid
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setRejectDuplicates

        public SMSSubmit setRejectDuplicates​(boolean value)
                              throws IllegalStateException
        Sets the value of whether the SC shall accept an SMSSubmit for an SM still held in the SC which has the same TP-MR and the same TP-DA as a previously submitted SM from the same OA.
        Parameters:
        value - boolean representation of whether the SC shall accept an SMSSubmit for an SM still held in the SC which has the same TP-MR and the same TP-DA as a previously submitted SM from the same OA
        Returns:
        this
        Throws:
        IllegalStateException

      • setMessageReference

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

      • copyOf

        public static SMSSubmit copyOf​(SMSSubmit 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:
        SMSSubmit

      • 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 SMSSubmit newInstanceOnlyHeader()
        Factory method that creates an instance for representing only a header (no data).
        Returns:
        SMSSubmit

      • decodeRPUIHeaderSubmit

        public static SMSSubmit decodeRPUIHeaderSubmit​(byte[] message,
                                               int start,
                                               int len)
        Constructs a new SMSSubmit 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:
        SMSSubmit
        Throws:
        NullPointerException - if message is null
        ArrayIndexOutOfBoundsException - if start or len are out of range

      • decodeRPUIHeaderSubmit

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

      • encodeRPUIHeaderSubmit

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