Web Application (Android Servlet) Sample Code: Bug in Installation Code

Summary

Sometimes, the SOP application may fail to install its web application with null pointer exception. This may be caused by the use of the sample code. Please read this document for details, and correct the application if necessary.

Symptom

At an unexpected timing, the SOP application installs the web application, and it fails with NullPointerException.

Cause

The SOP application may be trying to install the web application when it should not. The SOP application may starts to install the web application when it receives “web application installation failure” intent ( RESULT=false, ERROR_CODE=3(BUSY) ) if the web application installation code is same as the SmartSDK web application sample code.

The sample code didn’t check if the failure intent is for itself or for other SOP application, and it starts to install the web application whenever any web application installation fails. Proceeding with the unintended installation fails with a null pointer exception.

Resolution

Please fix the web application installation code as shown below.  The same fix will be included in future SmartSDK release (planned: March 2017).

Code fix details

Portion of WebAppInstallerSample jp.co.ricoh.ssdk.sample.servlet.SystemReceiver #onReceive(Context, Intent)

else if (ACTION_RES_INSTALL_WEB_APPLICATION.equals(intent.getAction())) { // ADD THIS CODE // check packageName: is this for me? String pkgName = intent.getStringExtra(PACKAGE_NAME); if (!packageName.equals(pkgName)) { return; // it is not for me. just return } // check the webapp installation result String reqId = intent.getStringExtra(REQUEST_ID); String pkgName = intent.getStringExtra(PACKAGE_NAME); boolean result = intent.getBooleanExtra(RESULT, false); int err = intent.getIntExtra(ERROR_CODE, -1); String name = reqIdMap.get(reqId); //the app only has its own reqID in reqIdMap reqIdMap.remove(reqId); // handle err if (err == 0) { // no error Log.d(TAG, "install success."); } else if (err == 1) { // invalid parameter Log.d(TAG, "install fail. invalid parameter."); } else if (err == 2) { // already installed Log.d(TAG, "install fail. WebApp(" + name + ") already installed."); } else if (err == 3) { // server service is busy. try install again installServlet(context, name); //NPE if name == null } else if (err == 4) { // other err Log.d(TAG, "install fail. the others err."); }