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

Class SMSCommand

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class SMSCommand
extends SMSTPDU
implements FastSerializable
    Representation of a SMS-COMMAND TPDU.

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

     SMSCommand ::= SEQUENCE {
     onlyHeader              NULL OPTIONAL,
     userDataHeaderIndicator UserDataHeaderIndicator,
     statusReportRequest     StatusReportRequest,
     messageReference        INTEGER,
     protocolId              SMSProtocolId,
     commandType             INTEGER,
     messageNumber           INTEGER,
     destinationAddress      SMSAddress,
     commandData             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.4 pp62-63
    76543210
    1 octet0User data header indicatorStatus report request000Message type
    10
    1 octetMessage reference
    1 octetProtocol id
    1 octetCommand type
    1 octetMessage number
    2-12 octetsDestination address
    1 octetCommand data length
    0-156 octetsCommand data

    Field onlyHeader, when present, causes the commandData field to be omitted on encoding and to be required to be absent on decoding; it doesn't prevent a value from being set for that field, that field still participates in the Map returned by getFieldsMap(), and hence equals(), hashCode() and toString() are still affected.

    See Also:
    Serialized Form

    • Constructor Detail

      • SMSCommand

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

      • SMSCommand

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

      • SMSCommand

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

      • SMSCommand

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

      • hasOnlyHeader

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

      • setOnlyHeaderPresent

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

      • hasUserDataHeaderIndicator

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

      • 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

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

      • hasProtocolId

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

      • hasCommandType

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

      • setCommandTypePresent

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

      • hasMessageNumber

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

      • setMessageNumberPresent

        public SMSCommand setMessageNumberPresent​(boolean flag)
                                   throws IllegalStateException
        Sets the presence or absence of the field MessageNumber.
        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

      • hasCommandData

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

      • checkFieldsSet

        public void checkFieldsSet()
                    throws EncodeException
        Checks that all mandatory fields are present. Should be called immediately before all calls to encode().
        Overrides:
        checkFieldsSet in class SMSTPDU
        Throws:
        EncodeException - if any mandatory field is not present

      • getUserDataHeaderIndicator

        public SMSCommand.UserDataHeaderIndicator getUserDataHeaderIndicator()
                                                              throws DecodeException
        Gets the value of whether command data contains a header.
        Returns:
        UserDataHeaderIndicator representation of whether command data contains a header
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getStatusReportRequest

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

      • getMessageReference

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

      • getProtocolId

        public SMSProtocolId getProtocolId()
                            throws DecodeException
        Gets the value of identifies the above layer protocol.
        Returns:
        SMSProtocolId representation of identifies the above layer protocol
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getCommandType

        public int getCommandType()
                   throws DecodeException
        Gets the value of the operation to be performed on a SM.
        Returns:
        int representation of the operation to be performed on a SM
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getMessageNumber

        public int getMessageNumber()
                     throws DecodeException
        Gets the value of indicates which SM in the SC to operate on.
        Returns:
        int representation of indicates which SM in the SC to operate on
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getDestinationAddress

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

      • getCommandData

        public byte[] getCommandData()
                      throws DecodeException
        Gets the value of the command data.
        Returns:
        byte[] representation of the command data
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setCommandType

        public SMSCommand setCommandType​(int value)
                          throws IllegalStateException
        Sets the value of the operation to be performed on a SM.
        Parameters:
        value - int representation of the operation to be performed on a SM
        Returns:
        this
        Throws:
        IllegalStateException

      • setMessageNumber

        public SMSCommand setMessageNumber​(int value)
                            throws IllegalStateException
        Sets the value of indicates which SM in the SC to operate on.
        Parameters:
        value - int representation of indicates which SM in the SC to operate on
        Returns:
        this
        Throws:
        IllegalStateException

      • copyOf

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

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

      • decodeRPUIHeaderCommand

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

      • decodeRPUIHeaderCommand

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

      • encodeRPUIHeaderCommand

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