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

Class SMSDeliverReportError

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

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

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

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class SMSDeliverReportError
extends SMSDeliverReport
implements FastSerializable

Representation of a SMS-DELIVER-REPORT TPDU in a RP-ERROR.

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

 SMSDeliverReportError ::= SEQUENCE {
     userDataHeaderIndicator UserDataHeaderIndicator,
     failureCause            SMSFailureCause,
     protocolId              SMSProtocolId            OPTIONAL,
     dataCodingScheme        SMSDataCodingScheme      OPTIONAL,
     userDataLength          INTEGER                  OPTIONAL,
     userData                OCTET STRING
 }

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.1a part (i) p53
	7	6	5	4	3	2	1	0
1 octet	0	User data header indicator	0	0	0	0	Message type 00
1 octet	Failure cause
1 octet	0	0	0	0	0	User data has length?	Has data coding scheme?	Has protocol identifier?
0-1 octets	Protocol id
0-1 octets	Data coding scheme
0-1 octets	User data length
0-158 octets	User data

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

SMSTPDUWithData.UserDataHeaderIndicator

Nested classes/interfaces inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU

SMSTPDU.Type

Field Summary

Fields inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

DataCodingScheme_value, OnlyHeader_present, OnlyHeader_value, ProtocolId_value, UserData_value, UserDataHeaderIndicator_value, UserDataLength_present, UserDataLength_value

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
SMSDeliverReportError() Constructs a new SMSDeliverReportError object with no fields set.
SMSDeliverReportError(byte[] data) Constructs a new SMSDeliverReportError object from network-encoded data.
SMSDeliverReportError(byte[] data, int start, int len) Constructs a new SMSDeliverReportError object from part of network-encoded data.
SMSDeliverReportError(DataInput in) Constructs a new SMSDeliverReportError object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
SMSDeliverReportError	clone() Constructs a copy of this object and everything reachable from it.
static SMSDeliverReportError	copyOf(SMSDeliverReportError 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.
protected void	decode() Computes the decoded form from the encoded form.
protected void	encode() Computes the encoded form from the decoded form.
protected boolean	encodedIsInvalid() Determines whether the encoded form is invalid.
int	getContainedLength(byte[] data, int start, int len) Determines the length of the encoded value that commences at offset start in the given data.
SMSDataCodingScheme	getDataCodingScheme() Gets the value of the coding scheme within the user data.
byte[]	getEncodedForm() Gets the encoded form.
SMSFailureCause	getFailureCause() Gets the value of the reason for failure.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value for the fields of a sequence.
SMSProtocolId	getProtocolId() Gets the value of identifies the above layer protocol.
SMSTPDU.Type	getType() Return the message type of this PDU
byte[]	getUserData() Gets the value of the user data.
SMSTPDUWithData.UserDataHeaderIndicator	getUserDataHeaderIndicator() Gets the value of whether user data contains a header.
int	getUserDataLength() Gets the value of the length of the user data.
boolean	hasFailureCause() Tests whether the field FailureCause has a value.
SMSDeliverReportError	setDataCodingScheme(SMSDataCodingScheme value) Sets the value of the coding scheme within the user data.
SMSDeliverReportError	setFailureCause(SMSFailureCause value) Sets the value of the reason for failure.
SMSDeliverReportError	setProtocolId(SMSProtocolId value) Sets the value of identifies the above layer protocol.
SMSDeliverReportError	setUserData(byte[] value) Sets the value of the user data.
SMSDeliverReportError	setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value) Sets the value of whether user data contains a header.
SMSDeliverReportError	setUserDataLength(int value) Sets the value of the length of the user data.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by SMSDeliverReportError(DataInput).

Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

checkUserDataConstraints, getUserDataHeader, getUserDataString, hasDataCodingScheme, hasOnlyHeader, hasProtocolId, hasUserData, hasUserDataHeaderIndicator, hasUserDataLength, setOnlyHeaderPresent, setReadOnly, setUserDataLengthPresent, setUserDataString, setUserDataString, setUserDataString, setUserDataString

Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU

decodeRPAck, decodeRPAck, decodeRPError, decodeRPError, decodeRPMOData, decodeRPMOData, decodeRPMTData, decodeRPMTData, encodeRPAck, encodeRPError, encodeRPMOData, encodeRPMTData

Methods inherited from class AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SMSDeliverReportError

public SMSDeliverReportError()

Constructs a new SMSDeliverReportError object with no fields set.

SMSDeliverReportError

public SMSDeliverReportError(byte[] data)

Constructs a new SMSDeliverReportError 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

SMSDeliverReportError

public SMSDeliverReportError(byte[] data,
                     int start,
                     int len)

Constructs a new SMSDeliverReportError 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

SMSDeliverReportError

public SMSDeliverReportError(DataInput in)
                      throws IOException

Constructs a new SMSDeliverReportError 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

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by SMSDeliverReportError(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasFailureCause

public boolean hasFailureCause()
                        throws DecodeException

Tests whether the field FailureCause 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 SMSDeliverReport

Throws:

EncodeException - if any mandatory field is not present

getUserDataHeaderIndicator

public SMSTPDUWithData.UserDataHeaderIndicator getUserDataHeaderIndicator()
                                                                   throws DecodeException

Gets the value of whether user data contains a header.

Overrides:

getUserDataHeaderIndicator in class SMSDeliverReport

Returns:

UserDataHeaderIndicator representation of whether user data contains a header

Throws:

DecodeException - if encoded state cannot be decoded

getProtocolId

public SMSProtocolId getProtocolId()
                            throws DecodeException

Gets the value of identifies the above layer protocol.

Overrides:

getProtocolId in class SMSDeliverReport

Returns:

SMSProtocolId representation of identifies the above layer protocol

Throws:

DecodeException - if encoded state cannot be decoded

getDataCodingScheme

public SMSDataCodingScheme getDataCodingScheme()
                                        throws DecodeException

Gets the value of the coding scheme within the user data.

Overrides:

getDataCodingScheme in class SMSDeliverReport

Returns:

SMSDataCodingScheme representation of the coding scheme within the user data

Throws:

DecodeException - if encoded state cannot be decoded

getUserDataLength

public int getUserDataLength()
                      throws DecodeException

Gets the value of the length of the user data.

Overrides:

getUserDataLength in class SMSDeliverReport

Returns:

int representation of the length of the user data

Throws:

DecodeException - if encoded state cannot be decoded

getUserData

public byte[] getUserData()
                   throws DecodeException

Gets the value of the user data.

Overrides:

getUserData in class SMSDeliverReport

Returns:

byte[] representation of the user data

Throws:

DecodeException - if encoded state cannot be decoded

getFailureCause

public SMSFailureCause getFailureCause()
                                throws DecodeException

Gets the value of the reason for failure.

Returns:

SMSFailureCause representation of the reason for failure

Throws:

DecodeException - if encoded state cannot be decoded

setUserDataHeaderIndicator

public SMSDeliverReportError setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value)
                                                 throws IllegalStateException

Sets the value of whether user data contains a header.

Overrides:

setUserDataHeaderIndicator in class SMSDeliverReport

Parameters:

value - UserDataHeaderIndicator representation of whether user data contains a header

Returns:

this

Throws:

IllegalStateException

setProtocolId

public SMSDeliverReportError setProtocolId(SMSProtocolId value)
                                    throws IllegalStateException

Sets the value of identifies the above layer protocol.

Overrides:

setProtocolId in class SMSDeliverReport

Parameters:

value - SMSProtocolId representation of identifies the above layer protocol

Returns:

this

Throws:

IllegalStateException

setDataCodingScheme

public SMSDeliverReportError setDataCodingScheme(SMSDataCodingScheme value)
                                          throws IllegalStateException

Sets the value of the coding scheme within the user data.

Overrides:

setDataCodingScheme in class SMSDeliverReport

Parameters:

value - SMSDataCodingScheme representation of the coding scheme within the user data

Returns:

this

Throws:

IllegalStateException

setUserDataLength

public SMSDeliverReportError setUserDataLength(int value)
                                        throws IllegalStateException

Sets the value of the length of the user data.

Overrides:

setUserDataLength in class SMSDeliverReport

Parameters:

value - int representation of the length of the user data

Returns:

this

Throws:

IllegalStateException

setUserData

public SMSDeliverReportError setUserData(byte[] value)
                                  throws IllegalStateException

Sets the value of the user data.

Overrides:

setUserData in class SMSDeliverReport

Parameters:

value - byte[] representation of the user data

Returns:

this

Throws:

IllegalStateException

setFailureCause

public SMSDeliverReportError setFailureCause(SMSFailureCause value)
                                      throws IllegalStateException

Sets the value of the reason for failure.

Parameters:

value - SMSFailureCause representation of the reason for failure

Returns:

this

Throws:

IllegalStateException

copyOf

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

SMSDeliverReportError

clone

public SMSDeliverReportError clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

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

getEncodedForm

public byte[] getEncodedForm()
                      throws EncodeException

Gets the encoded form.

Specified by:

getEncodedForm in class SMSTPDU

Returns:

encoded form

Throws:

EncodeException - if encoding fails

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

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if encoding fails

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if decoding fails