This documentation is for WSO2 IoT Server 3.1.0. View the documentation for the latest release.
Customizing the Android APK File - IoT Server 3.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You will want to make changes to the Android Application Package (APK) that is in WSO2 IoT Server to suit your business or Organization requirements. For example, you will want to white label the WSO2 Android agent. In such situations, you need to do the required changes and create a new APK file. 



  1. Download and install Android Studio.

    For more information, see installing Android Studio.

  2. Replace the android.jar file that is in the <ANDROID_STUDIO>/<SDK location>/platforms/android-<CURRENT_API_LEVEL>
    directory with the android.jar file. You can get the new jar file using one of the following options:

    • Download the Android Open Source Project (AOSP) and build the source code to get the jar file for the required SDK level.

    • Use a pre-built jar file from a third party developer. You can find it here.

      Make sure to use the jar file that matches the compileSdkVersion of the WSO2 Android agent. Currently, the compileSdkVersion is 25.

    Why is this needed?

    The WSO2 Android agent requires access to hidden APIs (APIs that are available at runtime). Therefore, you need to replace the anrdoid.jar file as mentioned in this step.

  3. WSO2 IoT Server supports API levels from 17 to 25. Therefore, install the Android API levels from 17 to 25 on Android Studio.
    1. Open Android Studio.
    2. Click SDK Manager.
    3. Click the SDK Platform tab and select the 17 and 25 API levels.
    4. Click Apply.

Creating a new APK

  1. Clone the cdmf-agent-android GIT repository. This will be referred to as <ANDROID_AGENT_SOURCE_CODE>.

    Step 1 - git clone
    Step 2 - git checkout tags/<server_compatible_tag_name>

    Check the WSO2 IoT Server and Agent Compatibility and find out what tag of this repo you need to checkout.
    Example: WSO2 IoT Server 3.0.0 is compatible with the WSO2 Android agent 2.0.1. Therefore, the release tag will be v2.0.1. 

    git checkout tags/v2.0.1
  2. Open the client folder that is in the <ANDROID_AGENT_SOURCE_CODE> via Android Studio.
  3. Do the necessary changes you wish to make. 
    Example:  You can perform the following modifications to the client/client/build.gradle file: 
      • Update the value http ofthe buildConfigField “String”, SERVER_PROTOCOL”, “\http://\”” attributeto https if you wish to change the protocol to https. 
      • Update the value null ofthe buildConfigField “String”, DEFAULT_HOST”, “null” attribute to your hostname, e.g., for https and forhttp. 
  4. The Android agent can't be built via the usual android developer SDK, as it requires access to developer restricted APIs. Therefore, you need to replace the existing android.jar file that is in the <SDK_LOCATION>/platforms/android-<COMPILE_SDK_VERSION> directory with the explicitly built android.jar file that has access to the restricted APIs. 
    You can get the new jar file using one of the following methods:

  5. Build the project to create a new APK file that has all the changes you made.

  6. Rename the created .apk fileto  android-agent.apk.
  7. Copy the renamed file and replace it instead of the existing android-agent.apk file that is in the <IoT_HOME>/core/repository/deployment/server/jaggeryapps/android-web-agent/app/pages/ directory.
  • No labels