Class SMSSubmitReportError
- 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.SMSSubmitReport
-
- com.opencloud.slee.resources.in.datatypes.sms.SMSSubmitReportError
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class SMSSubmitReportError extends SMSSubmitReport implements FastSerializable
Representation of a SMS-SUBMIT-REPORT TPDU in a RP-ERROR, 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.
SMSSubmitReportError ::= SEQUENCE { userDataHeaderIndicator UserDataHeaderIndicator, failureCause SMSFailureCause, serviceCentreTimeStamp SMSTimeStamp, 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.2a part (i) pp58-59 7 6 5 4 3 2 1 0 1 octet 0 User data header indicator 0 0 0 0 Message type
011 octet Failure cause 1 octet 0 0 0 0 0 Has user data length? Has data coding scheme? Has protocol identifier? 7 octets Service center time stamp 0-1 octets Protocol id 0-1 octets Data coding scheme 0-1 octets User data length 0-151 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.SMSSubmitReport
ServiceCentreTimeStamp_value
-
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 com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
isDecoded
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
encoded
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description SMSSubmitReportError()
Constructs a new SMSSubmitReportError object with no fields set.SMSSubmitReportError(byte[] data)
Constructs a new SMSSubmitReportError object from network-encoded data.SMSSubmitReportError(byte[] data, int start, int len)
Constructs a new SMSSubmitReportError object from part of network-encoded data.SMSSubmitReportError(DataInput in)
Constructs a new SMSSubmitReportError object from data deserialized from a stream that was written bytoStream(DataOutput)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.SMSSubmitReportError
clone()
Constructs a copy of this object and everything reachable from it.static SMSSubmitReportError
copyOf(SMSSubmitReportError 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 offsetstart
in the givendata
.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 SMSSubmit 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.SMSTimeStamp
getServiceCentreTimeStamp()
Gets the value of time when the SC received the SMSSubmit.SMSTPDU.Type
getType()
Return the message type of this PDUbyte[]
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.SMSSubmitReportError
setDataCodingScheme(SMSDataCodingScheme value)
Sets the value of the coding scheme within the user data.SMSSubmitReportError
setFailureCause(SMSFailureCause value)
Sets the value of the reason for SMSSubmit failure.SMSSubmitReportError
setProtocolId(SMSProtocolId value)
Sets the value of identifies the above layer protocol.SMSSubmitReportError
setServiceCentreTimeStamp(SMSTimeStamp value)
Sets the value of time when the SC received the SMSSubmit.SMSSubmitReportError
setUserData(byte[] value)
Sets the value of the user data.SMSSubmitReportError
setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value)
Sets the value of whether user data contains a header.SMSSubmitReportError
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 bySMSSubmitReportError(DataInput)
.-
Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSSubmitReport
hasServiceCentreTimeStamp, setReadOnly
-
Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData
checkUserDataConstraints, getUserDataHeader, getUserDataString, hasDataCodingScheme, hasOnlyHeader, hasProtocolId, hasUserData, hasUserDataHeaderIndicator, hasUserDataLength, setOnlyHeaderPresent, 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 com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
checkDecode, checkModifyAndDecode
-
Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString
-
Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly
-
-
-
-
Constructor Detail
-
SMSSubmitReportError
public SMSSubmitReportError()
Constructs a new SMSSubmitReportError object with no fields set.
-
SMSSubmitReportError
public SMSSubmitReportError(byte[] data)
Constructs a new SMSSubmitReportError 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
-
SMSSubmitReportError
public SMSSubmitReportError(byte[] data, int start, int len)
Constructs a new SMSSubmitReportError object from part of network-encoded data. The part starts at indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- if len is negative
-
SMSSubmitReportError
public SMSSubmitReportError(DataInput in) throws IOException
Constructs a new SMSSubmitReportError object from data deserialized from a stream that was written bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- 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 bySMSSubmitReportError(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- 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 classSMSSubmitReport
- 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 classSMSSubmitReport
- Returns:
- UserDataHeaderIndicator representation of whether user data contains a header
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getServiceCentreTimeStamp
public SMSTimeStamp getServiceCentreTimeStamp() throws DecodeException
Gets the value of time when the SC received the SMSSubmit.- Overrides:
getServiceCentreTimeStamp
in classSMSSubmitReport
- Returns:
- SMSTimeStamp representation of time when the SC received the SMSSubmit
- 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 classSMSSubmitReport
- 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 classSMSSubmitReport
- 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 classSMSSubmitReport
- 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 classSMSSubmitReport
- 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 SMSSubmit failure.- Returns:
- SMSFailureCause representation of the reason for SMSSubmit failure
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setUserDataHeaderIndicator
public SMSSubmitReportError setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value) throws IllegalStateException
Sets the value of whether user data contains a header.- Overrides:
setUserDataHeaderIndicator
in classSMSSubmitReport
- Parameters:
value
- UserDataHeaderIndicator representation of whether user data contains a header- Returns:
- this
- Throws:
IllegalStateException
-
setServiceCentreTimeStamp
public SMSSubmitReportError setServiceCentreTimeStamp(SMSTimeStamp value) throws IllegalStateException
Sets the value of time when the SC received the SMSSubmit.- Overrides:
setServiceCentreTimeStamp
in classSMSSubmitReport
- Parameters:
value
- SMSTimeStamp representation of time when the SC received the SMSSubmit- Returns:
- this
- Throws:
IllegalStateException
-
setProtocolId
public SMSSubmitReportError setProtocolId(SMSProtocolId value) throws IllegalStateException
Sets the value of identifies the above layer protocol.- Overrides:
setProtocolId
in classSMSSubmitReport
- Parameters:
value
- SMSProtocolId representation of identifies the above layer protocol- Returns:
- this
- Throws:
IllegalStateException
-
setDataCodingScheme
public SMSSubmitReportError setDataCodingScheme(SMSDataCodingScheme value) throws IllegalStateException
Sets the value of the coding scheme within the user data.- Overrides:
setDataCodingScheme
in classSMSSubmitReport
- Parameters:
value
- SMSDataCodingScheme representation of the coding scheme within the user data- Returns:
- this
- Throws:
IllegalStateException
-
setUserDataLength
public SMSSubmitReportError setUserDataLength(int value) throws IllegalStateException
Sets the value of the length of the user data.- Overrides:
setUserDataLength
in classSMSSubmitReport
- Parameters:
value
- int representation of the length of the user data- Returns:
- this
- Throws:
IllegalStateException
-
setUserData
public SMSSubmitReportError setUserData(byte[] value) throws IllegalStateException
Sets the value of the user data.- Overrides:
setUserData
in classSMSSubmitReport
- Parameters:
value
- byte[] representation of the user data- Returns:
- this
- Throws:
IllegalStateException
-
setFailureCause
public SMSSubmitReportError setFailureCause(SMSFailureCause value) throws IllegalStateException
Sets the value of the reason for SMSSubmit failure.- Parameters:
value
- SMSFailureCause representation of the reason for SMSSubmit failure- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static SMSSubmitReportError copyOf(SMSSubmitReportError 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:
- SMSSubmitReportError
-
clone
public SMSSubmitReportError clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- 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 classAbstractFieldsObject
- 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 classSMSTPDU
- 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
-
getContainedLength
public int getContainedLength(byte[] data, int start, int len)
Determines the length of the encoded value that commences at offsetstart
in the givendata
. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the givenlen
is returned. If the encoded value is so currupt that its length cannot be determined, then0
is returned.- Parameters:
data
- network-encoded datastart
- index into data where value commenceslen
- 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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if encoding fails
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if decoding fails
-
-