A.2 Sim.toolkit
3GPP51.013Release 17Test specification for Subscriber Identity Module (SIM) Application Programming Interface (API) for Java CardTS
|
Class Name |
Acronyms |
Numbering on 5 bits |
|---|---|---|
|
ToolkitConstants |
TKC |
00001 |
|
ToolkitInterface |
TKI |
00010 |
|
EditHandler |
EDH |
00011 |
|
EnvelopeHandler |
ENH |
00100 |
|
EnvelopeResponseHandler |
ERH |
00101 |
|
MEProfile |
MEP |
00110 |
|
ProactiveHandler |
PAH |
00111 |
|
ProactiveResponseHandler |
PRH |
01000 |
|
ToolkitRegistry |
TKR |
01001 |
|
ViewHandler |
VWH |
01010 |
|
ToolkitException |
TKE |
01011 |
A.2.1 ToolkitConstants
|
Method Name |
Acronyms |
Numbering on 6 bits |
|
Constants |
CONS |
000001 |
A.2.2 ToolkitInterface methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|
void processToolkit (byte event) |
PRTKB |
000001 |
A.2.3 EditHandler methods
The numbering of the EditHandler methods it will be done in the classes inherit it: EnvelopeResponseHandler, ProactiveHandler, because the methods provided by this class as it is declared ‘abstract’.
A.2.4 EnvelopeHandler methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|---|---|---|
|
Byte getEnvelopeTag() |
GENT |
000001 |
|
Byte getItemIdentifier() |
GIID |
000010 |
|
Short getSecuredDataLength() |
GSDL |
000011 |
|
Short getSecuredDataOffset() |
GSDO |
000100 |
|
GTHD |
000101 |
|
|
Short getTPUDLOffset() |
GTPO |
000110 |
|
Short getCapacity() |
GCAP |
010010 |
|
Short getUserDataLength() |
GUDL |
010011 |
|
Byte getChannelIdentifier() |
GCID |
010100 |
|
Inherited Method Name: ViewHandler |
||
|
Byte compareValue(short valueOffset,byte[] compareBuffer,short compareOffset, short compareLength) |
CPRVS_BSS |
000111 |
|
Short copy(byte[] dstBuffer,short dstOffset,short dstLength) |
COPY_BSS |
001000 |
|
Short copyValue(short valueOffset, byte[] dstBuffer,short dstOffset,short dstLength) |
CPYVS_BSS |
001001 |
|
Byte findAndCompareValue(byte tag,byte[] compareBuffer,short compareOffset) |
FACRB_BS |
001010 |
|
Byte findAndCompareValue(byte tag,byte occurrence, short valueOffset,byte[] compareBuffer,short compareOffset,short compareLength) |
FACRBBS_BSS |
001011 |
|
Short FindAndCopyValue(byte tag,byte occurrence,short valueOffset, byte[] dstBuffer, short dstOffset, short dstLength) |
FACYBBS_BSS |
001100 |
|
Short findAndCopyValue(byte tag,byte[] dstBuffer,short dstOffset) |
FACYB_BS |
001101 |
|
Byte FindTLV(byte tag,byte occurrence) |
FINDBB |
001110 |
|
Short GetLength() |
GLEN |
001111 |
|
Byte GetValueByte(short valueOffset) |
GVBYS |
010000 |
|
Short GetValueLength() |
GVLE |
010001 |
A.2.5 EnvelopeResponseHandler methods
|
Method Name |
Acronym |
Numbering on 6 bits |
|
GTHD |
000001 |
|
|
Void post(byte statusType) |
POSTB |
000010 |
|
Void postAsBERTLV(byte statusType, byte tag) |
POSTBB |
000011 |
|
Short getCapacity() |
GCAP |
010101 |
|
Inherited Method Name: EditHandler |
||
|
Void appendArray(byte[] buffer, short offset, short length, short dstLength) |
APDA_BSS |
000100 |
|
Void appendTLV(byte tag, byte value) |
APTLBB |
000101 |
|
Void appendTLV(byte tag, byte[] value, short valueOffset, short valueLength) |
APTLB_BSS |
000110 |
|
Void appendTLV(byte tag, byte value1, byte value2) |
APTLBBB |
000111 |
|
Void appendTLV(byte tag, byte value1, byte[] value2, short value2Offset, short value2Length) |
APTLBB_BSS |
001000 |
|
Void clear() |
CLER |
001001 |
|
Inherited Method Name: ViewHandler |
||
|
Byte compareValue(short valueOffset,byte[] compareBuffer,short compareOffset, short compareLength) |
CPRVS_BSS |
001010 |
|
Short Copy(byte[] dstBuffer,short dstOffset,short dstLength) |
COPY_BSS |
001011 |
|
Short CopyValue(short valueOffset, byte[] dstBuffer,short dstOffset,short dstLength) |
CPYVS_BSS |
001100 |
|
Byte findAndCompareValue(byte tag,byte[] compareBuffer,short compareOffset) |
FACRB_BS |
001101 |
|
Byte findAndCompareValue(byte tag,byte occurence, short valueOffset,byte[] compareBuffer,short compareOffset,short compareLength) |
FACRBBS_BSS |
001110 |
|
Short findAndCopyValue(byte tag,byte occurence,short valueOffset, byte[] dstBuffer, short dstOffset, short dstLength) |
FACYBBS_BSS |
001111 |
|
Short findAndCopyValue(byte tag,byte[] dstBuffer,short dstOffset) |
FACYB_BS |
010000 |
|
Byte findTLV(byte tag,byte occurrence) |
FINDBB |
010001 |
|
Short GetLength() |
GLEN |
010010 |
|
Byte getValueByte(short valueOffset) |
GVBYS |
010011 |
|
Short getValueLength() |
GVLE |
010100 |
A.2.6 MEProfile methods
|
Method Name |
Acronym |
Numbering on 6 bits |
|---|---|---|
|
static boolean check(byte index) |
CHECB |
000001 |
|
static boolean check(byte[] mask, short offset, short length) |
CHECBSS |
000010 |
|
static boolean check(short index) |
CHECS |
000011 |
|
static short copy(short startOffset, byte[] dstBuffer, short dstOffset, short dstLength) |
COPYS_BSS |
000100 |
|
static short getValue(short indexMSB, short indexLSB) |
GVALSS |
000101 |
A.2.7 ProactiveHandler methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|
ProactiveHandler getTheHandler() |
GTHD |
000001 |
|
Void init(byte type, byte qualifier, byte dstDevice) |
INITBBB |
000010 |
|
Void initDisplayText(byte qualifier, byte dcs, byte[] buffer, short offset, short length) |
INDTBB_BSS |
000011 |
|
Void initGetInkey(byte qualifier, byte dcs, byte[] buffer, short offset, short length) |
INGKBB_BSS |
000100 |
|
Void initGetInput(byte qualifier, byte dcs, byte[] buffer, short offset, short length, short minRespLength, short maxRespLength) |
INGPBB_BSSSS |
000101 |
|
Byte send() |
SEND |
000110 |
|
Short getCapacity() |
GCAP |
011000 |
|
Void initCloseChannel(byte bChannelIdentifier) |
ICCHB |
011001 |
|
Inherited Method Name: EditHandler |
||
|
Void appendArray(byte[] buffer, short offset, short length, short dstLength) |
APDA_BSS |
000111 |
|
Void appendTLV(byte tag, byte value) |
APTLBB |
001000 |
|
Void appendTLV(byte tag, byte[] value, short valueOffset, short valueLength) |
APTLB_BSS |
001001 |
|
Void appendTLV(byte tag, byte value1, byte value2) |
APTLBBB |
001010 |
|
Void appendTLV(byte tag, byte value1, byte[] value2, short value2Offset, short value2Length) |
APTLBB_BSS |
001011 |
|
Void clear() |
CLER |
001100 |
|
Inherited Method Name: ViewHandler |
||
|
Byte compareValue(short valueOffset,byte[] compareBuffer,short compareOffset, short compareLength) |
CPRVS_BSS |
001101 |
|
Short copy(byte[] dstBuffer,short dstOffset,short dstLength) |
COPY_BSS |
001110 |
|
Short copyValue(short valueOffset, byte[] dstBuffer,short dstOffset,short dstLength) |
CPYVS_BSS |
001111 |
|
Byte findAndCompareValue(byte tag,byte[] compareBuffer,short compareOffset) |
FACRB_BS |
010000 |
|
Byte findAndCompareValue(byte tag,byte occurence, short valueOffset,byte[] compareBuffer,short compareOffset,short compareLength) |
FACRBBS_BSS |
010001 |
|
Short findAndCopyValue(byte tag,byte occurence,short valueOffset, byte[] dstBuffer, short dstOffset, short dstLength) |
FACYBBS_BSS |
010010 |
|
Short findAndCopyValue(byte tag,byte[] dstBuffer,short dstOffset) |
FACYB_BS |
010011 |
|
Byte findTLV(byte tag,byte occurrence) |
FINDBB |
010100 |
|
Short getLength() |
GLEN |
010101 |
|
Byte getValueByte(short valueOffset) |
GVBYS |
010110 |
|
Short getValueLength() |
GVLE |
010111 |
A.2.8 ProactiveResponseHandler methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|
Short copyAdditionalInformation(byte[] dstBuffer, short dstOffset, short dstLength) |
CPAI_BSS |
000001 |
|
Short copyTextString(byte[] dstBuffer, short dstOffset) |
CPTS_BS |
000010 |
|
Short getAdditionalInformationLength() |
GTIL |
000011 |
|
Byte getGeneralResult() |
GTGR |
000100 |
|
Byte getItemIdentifier() |
GTII |
000101 |
|
Byte getTextStringCodingScheme() |
GTCS |
000110 |
|
Short getTextStringLength() |
GTTL |
000111 |
|
ProactiveResponseHandler getTheHandler() |
GTHD |
001000 |
|
Short getCapacity() |
GCAP |
010100 |
|
Byte getChannelIdentifier() |
GCID |
010101 |
|
Short copyChannelData(byte[] dstBuffer, short dstOffset, short dstLength) |
CCHD_BSS |
010110 |
|
Inherited Method Name: ViewHandler |
||
|
Byte CompareValue(short valueOffset,byte[] compareBuffer,short compareOffset, short compareLength) |
CPRVS_BSS |
001001 |
|
Short Copy(byte[] dstBuffer,short dstOffset,short dstLength) |
COPY_BSS |
001010 |
|
Short CopyValue(short valueOffset, byte[] dstBuffer,short dstOffset,short dstLength) |
CPYVS_BSS |
001011 |
|
Byte FindAndCompareValue(byte tag,byte[] compareBuffer,short compareOffset) |
FACRB_BS |
001100 |
|
Byte findAndCompareValue(byte tag,byte occurence, short valueOffset,byte[] compareBuffer,short compareOffset,short compareLength) |
FACRBBS_BSS |
001101 |
|
Short FindAndCopyValue(byte tag,byte occurence,short valueOffset, byte[] dstBuffer, short dstOffset, short dstLength) |
FACYBBS_BSS |
001110 |
|
Short findAndCopyValue(byte tag,byte[] dstBuffer,short dstOffset) |
FACYB_BS |
001111 |
|
Byte FindTLV(byte tag,byte occurrence) |
FINDBB |
010000 |
|
Short GetLength() |
GLEN |
010001 |
|
Byte GetValueByte(short valueOffset) |
GVBYS |
010010 |
|
Short GetValueLength() |
GVLE |
010011 |
A.2.9 ToolkitRegistry methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|---|---|---|
|
ATIM |
000001 |
|
|
changeMenuEntry(byte id, byte[] menuEntry, short offset, short length, byte nextAction, boolean helpSupported, byte iconQualifier, short iconIdentifier) |
CMETB_BSSBZBS |
000010 |
|
clearEvent(byte event) |
CEVTB |
000011 |
|
disableMenuEntry(byte id) |
DMETB |
000100 |
|
enableMenuEntry(byte id) |
EMETB |
000101 |
|
getEntry() |
GETY |
000110 |
|
GPOL |
000111 |
|
|
initMenuEntry(byte[] menuEntry, short offset, short length, byte nextAction, boolean helpSupported, byte iconQualifier, short iconIdentifier) |
IMET_BSSBZBS |
001000 |
|
isEventSet(byte event) |
IEVSB |
001001 |
|
releaseTimer(byte timerIdentifier) |
RTIM |
001010 |
|
requestPollInterval(short duration) |
RPOL |
001011 |
|
setEvent(byte event) |
SEVTB |
001100 |
|
setEventList(byte[] eventList, short offset, short length) |
SEVL_BSS |
001101 |
A.2.10 ViewHandler methods
The numbering of the ViewHandler methods it will be done in the classes inherit it: EditHandler, EnvelopeHandler, ProactiveResponseHandler, ProactiveHandler, because the methods provided by this class as it is declared ‘abstract’.
A.2.11 ToolkitException methods
|
Method Name |
Acronyms |
Numbering on 6 bits |
|
Static void throwIt(short reason) |
THITS |
000001 |
|
ToolkitException(short reason) |
COORS |
000010 |
|
Constants |
CONS |
000011 |
Annex B (normative):
Script file syntax and format description