CommandParamsFactorypublic class CommandParamsFactory extends android.os.Handler Factory class, used for decoding raw byte arrays, received from baseband,
into a CommandParams object. |
Fields Summary |
---|
private static CommandParamsFactory | sInstance | private IconLoader | mIconLoader | private CommandParams | mCmdParams | private int | mIconLoadState | private RilMessageDecoder | mCaller | static final int | MSG_ID_LOAD_ICON_DONE | static final int | LOAD_NO_ICON | static final int | LOAD_SINGLE_ICON | static final int | LOAD_MULTI_ICONS | static final int | REFRESH_NAA_INIT_AND_FULL_FILE_CHANGE | static final int | REFRESH_NAA_INIT_AND_FILE_CHANGE | static final int | REFRESH_NAA_INIT | static final int | REFRESH_UICC_RESET |
Methods Summary |
---|
static synchronized com.android.internal.telephony.gsm.stk.CommandParamsFactory | getInstance(RilMessageDecoder caller, com.android.internal.telephony.gsm.SIMFileHandler fh)
if (sInstance != null) {
return sInstance;
}
if (fh != null) {
return new CommandParamsFactory(caller, fh);
}
return null;
| public void | handleMessage(android.os.Message msg)
switch (msg.what) {
case MSG_ID_LOAD_ICON_DONE:
sendCmdParams(setIcons(msg.obj));
break;
}
| void | make(BerTlv berTlv)
if (berTlv == null) {
return;
}
// reset global state parameters.
mCmdParams = null;
mIconLoadState = LOAD_NO_ICON;
// only proactive command messages are processed.
if (berTlv.getTag() != BerTlv.BER_PROACTIVE_COMMAND_TAG) {
sendCmdParams(ResultCode.CMD_TYPE_NOT_UNDERSTOOD);
return;
}
boolean cmdPending = false;
List<ComprehensionTlv> ctlvs = berTlv.getComprehensionTlvs();
// process command dtails from the tlv list.
CommandDetails cmdDet = processCommandDetails(ctlvs);
if (cmdDet == null) {
sendCmdParams(ResultCode.CMD_TYPE_NOT_UNDERSTOOD);
return;
}
// extract command type enumeration from the raw value stored inside
// the Command Details object.
AppInterface.CommandType cmdType = AppInterface.CommandType
.fromInt(cmdDet.typeOfCommand);
if (cmdType == null) {
sendCmdParams(ResultCode.CMD_TYPE_NOT_UNDERSTOOD);
return;
}
try {
switch (cmdType) {
case SET_UP_MENU:
cmdPending = processSelectItem(cmdDet, ctlvs);
break;
case SELECT_ITEM:
cmdPending = processSelectItem(cmdDet, ctlvs);
break;
case DISPLAY_TEXT:
cmdPending = processDisplayText(cmdDet, ctlvs);
break;
case SET_UP_IDLE_MODE_TEXT:
cmdPending = processSetUpIdleModeText(cmdDet, ctlvs);
break;
case GET_INKEY:
cmdPending = processGetInkey(cmdDet, ctlvs);
break;
case GET_INPUT:
cmdPending = processGetInput(cmdDet, ctlvs);
break;
case SEND_DTMF:
case SEND_SMS:
case SEND_SS:
case SEND_USSD:
cmdPending = processEventNotify(cmdDet, ctlvs);
break;
case SET_UP_CALL:
cmdPending = processSetupCall(cmdDet, ctlvs);
break;
case REFRESH:
processRefresh(cmdDet, ctlvs);
cmdPending = false;
break;
case LAUNCH_BROWSER:
cmdPending = processLaunchBrowser(cmdDet, ctlvs);
break;
case PLAY_TONE:
cmdPending = processPlayTone(cmdDet, ctlvs);
break;
default:
// unsupported proactive commands
mCmdParams = new CommandParams(cmdDet);
sendCmdParams(ResultCode.CMD_TYPE_NOT_UNDERSTOOD);
return;
}
} catch (ResultException e) {
mCmdParams = new CommandParams(cmdDet);
sendCmdParams(e.result());
return;
}
if (!cmdPending) {
sendCmdParams(ResultCode.OK);
}
| private CommandDetails | processCommandDetails(java.util.List ctlvs)
CommandDetails cmdDet = null;
if (ctlvs != null) {
// Search for the Command Details object.
ComprehensionTlv ctlvCmdDet = searchForTag(
ComprehensionTlvTag.COMMAND_DETAILS, ctlvs);
if (ctlvCmdDet != null) {
try {
cmdDet = ValueParser.retrieveCommandDetails(ctlvCmdDet);
} catch (ResultException e) {
StkLog.d(this, "Failed to procees command details");
}
}
}
return cmdDet;
| private boolean | processDisplayText(CommandDetails cmdDet, java.util.List ctlvs)Processes DISPLAY_TEXT proactive command from the SIM card.
StkLog.d(this, "process DisplayText");
TextMessage textMsg = new TextMessage();
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.TEXT_STRING,
ctlvs);
if (ctlv != null) {
textMsg.text = ValueParser.retrieveTextString(ctlv);
}
// If the tlv object doesn't exist or the it is a null object reply
// with command not understood.
if (textMsg.text == null) {
throw new ResultException(ResultCode.CMD_DATA_NOT_UNDERSTOOD);
}
ctlv = searchForTag(ComprehensionTlvTag.IMMEDIATE_RESPONSE, ctlvs);
if (ctlv != null) {
textMsg.responseNeeded = false;
}
// parse icon identifier
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
textMsg.iconSelfExplanatory = iconId.selfExplanatory;
}
// parse tone duration
ctlv = searchForTag(ComprehensionTlvTag.DURATION, ctlvs);
if (ctlv != null) {
textMsg.duration = ValueParser.retrieveDuration(ctlv);
}
// Parse command qualifier parameters.
textMsg.isHighPriority = (cmdDet.commandQualifier & 0x01) != 0;
textMsg.userClear = (cmdDet.commandQualifier & 0x80) != 0;
mCmdParams = new DisplayTextParams(cmdDet, textMsg);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processEventNotify(CommandDetails cmdDet, java.util.List ctlvs)Processes EVENT_NOTIFY message from baseband.
StkLog.d(this, "process EventNotify");
TextMessage textMsg = new TextMessage();
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.ALPHA_ID,
ctlvs);
if (ctlv != null) {
textMsg.text = ValueParser.retrieveAlphaId(ctlv);
} else {
throw new ResultException(ResultCode.REQUIRED_VALUES_MISSING);
}
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
textMsg.iconSelfExplanatory = iconId.selfExplanatory;
}
textMsg.responseNeeded = false;
mCmdParams = new DisplayTextParams(cmdDet, textMsg);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processGetInkey(CommandDetails cmdDet, java.util.List ctlvs)Processes GET_INKEY proactive command from the SIM card.
StkLog.d(this, "process GetInkey");
Input input = new Input();
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.TEXT_STRING,
ctlvs);
if (ctlv != null) {
input.text = ValueParser.retrieveTextString(ctlv);
} else {
throw new ResultException(ResultCode.REQUIRED_VALUES_MISSING);
}
// parse icon identifier
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
}
input.minLen = 1;
input.maxLen = 1;
input.digitOnly = (cmdDet.commandQualifier & 0x01) == 0;
input.ucs2 = (cmdDet.commandQualifier & 0x02) != 0;
input.yesNo = (cmdDet.commandQualifier & 0x04) != 0;
input.helpAvailable = (cmdDet.commandQualifier & 0x80) != 0;
mCmdParams = new GetInputParams(cmdDet, input);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processGetInput(CommandDetails cmdDet, java.util.List ctlvs)Processes GET_INPUT proactive command from the SIM card.
StkLog.d(this, "process GetInput");
Input input = new Input();
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.TEXT_STRING,
ctlvs);
if (ctlv != null) {
input.text = ValueParser.retrieveTextString(ctlv);
} else {
throw new ResultException(ResultCode.REQUIRED_VALUES_MISSING);
}
ctlv = searchForTag(ComprehensionTlvTag.RESPONSE_LENGTH, ctlvs);
if (ctlv != null) {
try {
byte[] rawValue = ctlv.getRawValue();
int valueIndex = ctlv.getValueIndex();
input.minLen = rawValue[valueIndex] & 0xff;
input.maxLen = rawValue[valueIndex + 1] & 0xff;
} catch (IndexOutOfBoundsException e) {
throw new ResultException(ResultCode.CMD_DATA_NOT_UNDERSTOOD);
}
} else {
throw new ResultException(ResultCode.REQUIRED_VALUES_MISSING);
}
ctlv = searchForTag(ComprehensionTlvTag.DEFAULT_TEXT, ctlvs);
if (ctlv != null) {
input.defaultText = ValueParser.retrieveTextString(ctlv);
}
// parse icon identifier
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
}
input.digitOnly = (cmdDet.commandQualifier & 0x01) == 0;
input.ucs2 = (cmdDet.commandQualifier & 0x02) != 0;
input.echo = (cmdDet.commandQualifier & 0x04) == 0;
input.packed = (cmdDet.commandQualifier & 0x08) != 0;
input.helpAvailable = (cmdDet.commandQualifier & 0x80) != 0;
mCmdParams = new GetInputParams(cmdDet, input);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processLaunchBrowser(CommandDetails cmdDet, java.util.List ctlvs)Processes LAUNCH_BROWSER proactive command from the SIM card.
StkLog.d(this, "process LaunchBrowser");
TextMessage confirmMsg = new TextMessage();
IconId iconId = null;
String url = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.URL, ctlvs);
if (ctlv != null) {
try {
byte[] rawValue = ctlv.getRawValue();
int valueIndex = ctlv.getValueIndex();
int valueLen = ctlv.getLength();
if (valueLen > 0) {
url = GsmAlphabet.gsm8BitUnpackedToString(rawValue,
valueIndex, valueLen);
} else {
url = null;
}
} catch (IndexOutOfBoundsException e) {
throw new ResultException(ResultCode.CMD_DATA_NOT_UNDERSTOOD);
}
}
// parse alpha identifier.
ctlv = searchForTag(ComprehensionTlvTag.ALPHA_ID, ctlvs);
if (ctlv != null) {
confirmMsg.text = ValueParser.retrieveAlphaId(ctlv);
}
// parse icon identifier
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
confirmMsg.iconSelfExplanatory = iconId.selfExplanatory;
}
// parse command qualifier value.
LaunchBrowserMode mode;
switch (cmdDet.commandQualifier) {
case 0x00:
default:
mode = LaunchBrowserMode.LAUNCH_IF_NOT_ALREADY_LAUNCHED;
break;
case 0x02:
mode = LaunchBrowserMode.USE_EXISTING_BROWSER;
break;
case 0x03:
mode = LaunchBrowserMode.LAUNCH_NEW_BROWSER;
break;
}
mCmdParams = new LaunchBrowserParams(cmdDet, confirmMsg, url, mode);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processPlayTone(CommandDetails cmdDet, java.util.List ctlvs)Processes PLAY_TONE proactive command from the SIM card.
StkLog.d(this, "process PlayTone");
Tone tone = null;
TextMessage textMsg = new TextMessage();
Duration duration = null;
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.TONE, ctlvs);
if (ctlv != null) {
// Nothing to do for null objects.
if (ctlv.getLength() > 0) {
try {
byte[] rawValue = ctlv.getRawValue();
int valueIndex = ctlv.getValueIndex();
int toneVal = rawValue[valueIndex];
tone = Tone.fromInt(toneVal);
} catch (IndexOutOfBoundsException e) {
throw new ResultException(
ResultCode.CMD_DATA_NOT_UNDERSTOOD);
}
}
}
// parse alpha identifier
ctlv = searchForTag(ComprehensionTlvTag.ALPHA_ID, ctlvs);
if (ctlv != null) {
textMsg.text = ValueParser.retrieveAlphaId(ctlv);
}
// parse tone duration
ctlv = searchForTag(ComprehensionTlvTag.DURATION, ctlvs);
if (ctlv != null) {
duration = ValueParser.retrieveDuration(ctlv);
}
// parse icon identifier
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
textMsg.iconSelfExplanatory = iconId.selfExplanatory;
}
boolean vibrate = (cmdDet.commandQualifier & 0x01) != 0x00;
textMsg.responseNeeded = false;
mCmdParams = new PlayToneParams(cmdDet, textMsg, tone, duration, vibrate);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processRefresh(CommandDetails cmdDet, java.util.List ctlvs)Processes REFRESH proactive command from the SIM card.
StkLog.d(this, "process Refresh");
// REFRESH proactive command is rerouted by the baseband and handled by
// the telephony layer. IDLE TEXT should be removed for a REFRESH command
// with "initialization" or "reset"
switch (cmdDet.commandQualifier) {
case REFRESH_NAA_INIT_AND_FULL_FILE_CHANGE:
case REFRESH_NAA_INIT_AND_FILE_CHANGE:
case REFRESH_NAA_INIT:
case REFRESH_UICC_RESET:
mCmdParams = new DisplayTextParams(cmdDet, null);
break;
}
return false;
| private boolean | processSelectItem(CommandDetails cmdDet, java.util.List ctlvs)Processes SELECT_ITEM proactive command from the SIM card.
StkLog.d(this, "process SelectItem");
Menu menu = new Menu();
IconId titleIconId = null;
ItemsIconId itemsIconId = null;
Iterator<ComprehensionTlv> iter = ctlvs.iterator();
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.ALPHA_ID,
ctlvs);
if (ctlv != null) {
menu.title = ValueParser.retrieveAlphaId(ctlv);
}
while (true) {
ctlv = searchForNextTag(ComprehensionTlvTag.ITEM, iter);
if (ctlv != null) {
menu.items.add(ValueParser.retrieveItem(ctlv));
} else {
break;
}
}
// We must have at least one menu item.
if (menu.items.size() == 0) {
throw new ResultException(ResultCode.REQUIRED_VALUES_MISSING);
}
ctlv = searchForTag(ComprehensionTlvTag.ITEM_ID, ctlvs);
if (ctlv != null) {
// STK items are listed 1...n while list start at 0, need to
// subtract one.
menu.defaultItem = ValueParser.retrieveItemId(ctlv) - 1;
}
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
mIconLoadState = LOAD_SINGLE_ICON;
titleIconId = ValueParser.retrieveIconId(ctlv);
menu.titleIconSelfExplanatory = titleIconId.selfExplanatory;
}
ctlv = searchForTag(ComprehensionTlvTag.ITEM_ICON_ID_LIST, ctlvs);
if (ctlv != null) {
mIconLoadState = LOAD_MULTI_ICONS;
itemsIconId = ValueParser.retrieveItemsIconId(ctlv);
menu.itemsIconSelfExplanatory = itemsIconId.selfExplanatory;
}
boolean presentTypeSpecified = (cmdDet.commandQualifier & 0x01) != 0;
if (presentTypeSpecified) {
if ((cmdDet.commandQualifier & 0x02) == 0) {
menu.presentationType = PresentationType.DATA_VALUES;
} else {
menu.presentationType = PresentationType.NAVIGATION_OPTIONS;
}
}
menu.softKeyPreferred = (cmdDet.commandQualifier & 0x04) != 0;
menu.helpAvailable = (cmdDet.commandQualifier & 0x80) != 0;
mCmdParams = new SelectItemParams(cmdDet, menu, titleIconId != null);
// Load icons data if needed.
switch(mIconLoadState) {
case LOAD_NO_ICON:
return false;
case LOAD_SINGLE_ICON:
mIconLoader.loadIcon(titleIconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
break;
case LOAD_MULTI_ICONS:
int[] recordNumbers = itemsIconId.recordNumbers;
if (titleIconId != null) {
// Create a new array for all the icons (title and items).
recordNumbers = new int[itemsIconId.recordNumbers.length + 1];
recordNumbers[0] = titleIconId.recordNumber;
System.arraycopy(itemsIconId.recordNumbers, 0, recordNumbers,
1, itemsIconId.recordNumbers.length);
}
mIconLoader.loadIcons(recordNumbers, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
break;
}
return true;
| private boolean | processSetUpEventList(CommandDetails cmdDet, java.util.List ctlvs)Processes SET_UP_EVENT_LIST proactive command from the SIM card.
StkLog.d(this, "process SetUpEventList");
//
// ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.EVENT_LIST,
// ctlvs);
// if (ctlv != null) {
// try {
// byte[] rawValue = ctlv.getRawValue();
// int valueIndex = ctlv.getValueIndex();
// int valueLen = ctlv.getLength();
//
// } catch (IndexOutOfBoundsException e) {}
// }
return true;
| private boolean | processSetUpIdleModeText(CommandDetails cmdDet, java.util.List ctlvs)Processes SET_UP_IDLE_MODE_TEXT proactive command from the SIM card.
StkLog.d(this, "process SetUpIdleModeText");
TextMessage textMsg = new TextMessage();
IconId iconId = null;
ComprehensionTlv ctlv = searchForTag(ComprehensionTlvTag.TEXT_STRING,
ctlvs);
if (ctlv != null) {
textMsg.text = ValueParser.retrieveTextString(ctlv);
}
// load icons only when text exist.
if (textMsg.text != null) {
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
iconId = ValueParser.retrieveIconId(ctlv);
textMsg.iconSelfExplanatory = iconId.selfExplanatory;
}
}
mCmdParams = new DisplayTextParams(cmdDet, textMsg);
if (iconId != null) {
mIconLoadState = LOAD_SINGLE_ICON;
mIconLoader.loadIcon(iconId.recordNumber, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private boolean | processSetupCall(CommandDetails cmdDet, java.util.List ctlvs)Processes SETUP_CALL proactive command from the SIM card.
StkLog.d(this, "process SetupCall");
Iterator<ComprehensionTlv> iter = ctlvs.iterator();
ComprehensionTlv ctlv = null;
// User confirmation phase message.
TextMessage confirmMsg = new TextMessage();
// Call set up phase message.
TextMessage callMsg = new TextMessage();
IconId confirmIconId = null;
IconId callIconId = null;
// get confirmation message string.
ctlv = searchForNextTag(ComprehensionTlvTag.ALPHA_ID, iter);
if (ctlv != null) {
confirmMsg.text = ValueParser.retrieveAlphaId(ctlv);
}
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
confirmIconId = ValueParser.retrieveIconId(ctlv);
confirmMsg.iconSelfExplanatory = confirmIconId.selfExplanatory;
}
// get call set up message string.
ctlv = searchForNextTag(ComprehensionTlvTag.ALPHA_ID, iter);
if (ctlv != null) {
callMsg.text = ValueParser.retrieveAlphaId(ctlv);
}
ctlv = searchForTag(ComprehensionTlvTag.ICON_ID, ctlvs);
if (ctlv != null) {
callIconId = ValueParser.retrieveIconId(ctlv);
callMsg.iconSelfExplanatory = callIconId.selfExplanatory;
}
mCmdParams = new CallSetupParams(cmdDet, confirmMsg, callMsg);
if (confirmIconId != null || callIconId != null) {
mIconLoadState = LOAD_MULTI_ICONS;
int[] recordNumbers = new int[2];
recordNumbers[0] = confirmIconId != null
? confirmIconId.recordNumber : -1;
recordNumbers[1] = callIconId != null ? callIconId.recordNumber
: -1;
mIconLoader.loadIcons(recordNumbers, this
.obtainMessage(MSG_ID_LOAD_ICON_DONE));
return true;
}
return false;
| private ComprehensionTlv | searchForNextTag(ComprehensionTlvTag tag, java.util.Iterator iter)Search for the next COMPREHENSION-TLV object with the given tag from a
list iterated by {@code iter}. {@code iter} points to the object next to
the found object when this method returns. Used for searching the same
list for similar tags, usually item id.
int tagValue = tag.value();
while (iter.hasNext()) {
ComprehensionTlv ctlv = iter.next();
if (ctlv.getTag() == tagValue) {
return ctlv;
}
}
return null;
| private ComprehensionTlv | searchForTag(ComprehensionTlvTag tag, java.util.List ctlvs)Search for a COMPREHENSION-TLV object with the given tag from a list
Iterator<ComprehensionTlv> iter = ctlvs.iterator();
return searchForNextTag(tag, iter);
| private void | sendCmdParams(ResultCode resCode)
mCaller.sendMessageParamsDecoded(resCode, mCmdParams);
| private ResultCode | setIcons(java.lang.Object data)
Bitmap[] icons = null;
int iconIndex = 0;
if (data == null) {
return ResultCode.PRFRMD_ICON_NOT_DISPLAYED;
}
switch(mIconLoadState) {
case LOAD_SINGLE_ICON:
mCmdParams.setIcon((Bitmap) data);
break;
case LOAD_MULTI_ICONS:
icons = (Bitmap[]) data;
// set each item icon.
for (Bitmap icon : icons) {
mCmdParams.setIcon(icon);
}
break;
}
return ResultCode.OK;
|
|