uicc.usim.toolkit
Interface USATEnvelopeHandler
- All Superinterfaces:
- uicc.toolkit.BERTLVViewHandler, uicc.toolkit.EnvelopeHandler, uicc.toolkit.ViewHandler
- public interface USATEnvelopeHandler
- extends uicc.toolkit.EnvelopeHandler
The USATEnvelopeHandler interface contains basic methods to handle the SMS Envelope
data field. This interface will be used by the Toolkit applet in order to
have access to the current SMS Envelope information. No constructor is available
for the Toolkit applet.
- See Also:
EnvelopeHandler
Method Summary |
short |
getSecuredDataLength()
Looks for the length of the Secured Data from the Command Packet in the first SMS TPDU
or Cell Broadcast Page Simple TLV contained in the Envelope handler. |
short |
getSecuredDataOffset()
Looks for the Secured Data from the Command Packet in the first SMS TPDU
or Cell Broadcast Page Simple TLV contained in the Envelope handler. |
short |
getShortMessageLength()
Looks for the length of the Short Message in the User Data part of the first SMS TPDU or Cell Broadcast Page COMPREHENSION TLV
contained in the USATEnvelopeHandler. |
short |
getShortMessageOffset()
Looks for the Short Message offset in the User Data part of the first SMS TPDU
or of the first Cell Broadcast Page Simple TLV contained in the USATEnvelopeHandler.
|
short |
getTPUDLOffset()
Looks for the TP-UDL field in the first TPDU TLV element in the Envelope
data field. |
short |
getUserDataLength()
Looks for the TP-User Data field in the first TPDU TLV element contained in the Envelope Handler. |
Methods inherited from interface uicc.toolkit.EnvelopeHandler |
getChannelIdentifier, getChannelStatus, getItemIdentifier |
Methods inherited from interface uicc.toolkit.BERTLVViewHandler |
getSize, getTag |
Methods inherited from interface uicc.toolkit.ViewHandler |
compareValue, copy, copyValue, findAndCompareValue, findAndCompareValue, findAndCopyValue, findAndCopyValue, findTLV, getCapacity, getLength, getValueByte, getValueLength, getValueShort |
getTPUDLOffset
public short getTPUDLOffset()
throws uicc.toolkit.ToolkitException
- Looks for the TP-UDL field in the first TPDU TLV element in the Envelope
data field.
This method can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV, EVENT_FORMATTED_SMS_PP_UPD, EVENT_UNFORMATTED_SMS_PP_ENV, EVENT_UNFORMATTED_SMS_PP_UPD.
If the element is available it becomes the TLV selected.
- Returns:
- TPUDL offset in the first TPDU TLV element if TPUDL exists.
The value retrieved by using getValueByte is meaningless when the message is
Concatenated. To retrieve the TP-User-Data-Length the method getUserDataLength() shall be used.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable TPDU TLV element or if the TPUDL field does not exist
getSecuredDataOffset
public short getSecuredDataOffset()
throws uicc.toolkit.ToolkitException
- Looks for the Secured Data from the Command Packet in the first SMS TPDU
or Cell Broadcast Page Simple TLV contained in the Envelope handler.
This can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV, EVENT_FORMATTED_SMS_PP_UPD, if the SMS TP-UD is formatted
according to TS 31.115 Single or Concatenated Short Message.
- EVENT_FORMATTED_SMS_CB, if the Cell Broadcast Page is formatted according to TS 31.115.
If the element is available it becomes the TLV selected.
- Returns:
- the offset of the Secured Data first byte in the first SMS TPDU or Cell Broadcast Page TLV element.
If the Secured Data length is zero the value returned shall be the offset of the first byte following
the TS 31.115 Command Packet structure.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable SMS TPDU or Cell Broadcast Page TLV element or wrong data format
getSecuredDataLength
public short getSecuredDataLength()
throws uicc.toolkit.ToolkitException
- Looks for the length of the Secured Data from the Command Packet in the first SMS TPDU
or Cell Broadcast Page Simple TLV contained in the Envelope handler.
This can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV, EVENT_FORMATTED_SMS_PP_UPD, if the SMS TP-UD
is formatted according to TS 31.115 Single or Concatenated Short Message.
- EVENT_FORMATTED_SMS_CB, if the Cell Broadcast Page is formatted according to TS 31.115.
If the element is available it becomes the TLV selected.
- Returns:
- the length of the Secured Data contained in the first SMS TPDU or Cell Broadcast Page TLV element (without padding bytes).
If the Secured Data length is zero, no exception shall be thrown.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable SMS TPDU or Cell Broadcast Page TLV element or wrong data format
getUserDataLength
public short getUserDataLength()
throws uicc.toolkit.ToolkitException
- Looks for the TP-User Data field in the first TPDU TLV element contained in the Envelope Handler.
This method can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV,EVENT_FORMATTED_SMS_PP_UPD, EVENT_UNFORMATTED_SMS_PP_ENV, EVENT_UNFORMATTED_SMS_PP_UPD.
If the element is available it becomes the TLV selected.
- Returns:
- the length of the User Data contained in the first SMS TPDU TLV element.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable TPDU TLV element or wrong data format
getShortMessageOffset
public short getShortMessageOffset()
throws uicc.toolkit.ToolkitException
- Looks for the Short Message offset in the User Data part of the first SMS TPDU
or of the first Cell Broadcast Page Simple TLV contained in the USATEnvelopeHandler.
If this offset is available the simple TLV element becomes the TLV selected.
This can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV, EVENT_FORMATTED_SMS_PP_UPD, EVENT_UNFORMATTED_SMS_PP_ENV,
EVENT_UNFORMATTED_SMS_PP_UPD. It returns the offset of the first byte in the User Data part of the first SMS TPDU.
It is the offset of the first byte after the UDH, if any.
This can be used on the events:
- EVENT_FORMATTED_SMS_CB, EVENT_UNFORMATTED_SMS_CB. It returns the offset of the first
byte in the User Data part of the first Cell Broadcast Page Simple TLV. Is is the offset of the first byte after
the UDH, if any.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable SMS TPDU or Cell Broadcast Page or wrong data format
getShortMessageLength
public short getShortMessageLength()
throws uicc.toolkit.ToolkitException
- Looks for the length of the Short Message in the User Data part of the first SMS TPDU or Cell Broadcast Page COMPREHENSION TLV
contained in the USATEnvelopeHandler.
This can be used on the events:
- EVENT_FORMATTED_SMS_PP_ENV, EVENT_FORMATTED_SMS_PP_UPD, EVENT_UNFORMATTED_SMS_PP_ENV, EVENT_UNFORMATTED_SMS_PP_UPD.
It, returns the length of the Short Message in the User Data part of the first SMS TPDU. This length does not include the UDH, if any.
This can be used on the events:
- EVENT_FORMATTED_SMS_CB, EVENT_UNFORMATTED_SMS_CB. It returns the length of the Short Message in the
User Data part of the first Cell Broadcast Page Simple TLV element. This length does not include the UDH, if any.
If this length is available the simple TLV becomes the TLV selected.
- Returns:
- the length of the Short Message in the User Data part of the first SMS TPDU or Cell Broadcast Page Simple TLV element.
This length does not include the UDH, if any. If the Short Message length is zero, no exception shall be thrown.
- Throws:
uicc.toolkit.ToolkitException
- with the following reason codes:
UNAVAILABLE_ELEMENT
in case of unavailable SMS TPDU or Cell Broadcast Page or wrong data format
Copyright © European Telecommunications Standards Institute 2004. All rights reserved.