Create a native Android app with MAM SDK

Introduction

1. Start tunnel.
2. Enabling a WebView object for tunneling.

Pre-requisites

• Experience in developing Android mobile apps using Java.
• Access to Citrix Endpoint Management environment to upload .mdx and .apk files and distribute the app.
• Access to an Android Enterprise account to upload .aab or .apk files to Managed Google Play.
• Access to test micro VPN tunneling with your app through Citrix Gateway.
• Recommended reading:
  • Generate a key and KeyStore to sign your apps.
  • Setting up the MAM SDK library.
  • Basics of building a simple UI.

Overview

1. Launch Android Studio and create an empty app.
2. Set up the MAM SDK library and build environment of your app.
3. Create the UI template of your test app.
4. Add the underlying logic to integrate your app with MAM SDK.
5. Build your app.
6. Distribute your app.
7. Test your app.

Create your sample app

• Generate a key and KeyStore to sign your apps - Android Studio

• Verify 1 - You have created two new files - mamsdk.properties, and keystore.properties.
  Ensure that you have created and correctly populated the two files: mamsdk.properties and keystore.properties.
    ##### Enter MAM SDK Maven library URL #####
  mamSdkLibraryMaven=https://raw.githubusercontent.com/citrix/citrix-mam-sdks/main/maven

  ##### Enter MAM SDK Tools library URL #####
  mamSdkLibraryTools=https://github.com/citrix/citrix-mam-sdks/raw/main/tools/java

  ##### Enter the latest MAM SDK version number (e.g. 21.9.0.+) #####
  mamSdkVersion=21.9.0.+

  ##### Enter the app's package name (e.g. com.citrix.mvpntestapp). The Package name has to be globally unique #####
  appPackageName=com.citrix.nativemamsdkapp  #### Enter KeyStore Path (e.g. <folder location>/mycompany.keystore ) #####
  keyStorePath=<path to KeyStore>/keystore

  #### Enter KeyStore Password #####
  keystorePassword=test123

  #### Enter Key Alias #####
  keyAlias=key0

  #### Enter Key Password #####
  keyPassword=test123
• Verify 2 - Modify the build.gradle file inside your root folder and click Sync Now in Android Studio.
  The final build.gradle file in the root folder module should have the following content:
  // Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.2.2"
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

// Load KeyStore properties
def keystorePropertiesFile = rootProject.file("keystore.properties")
def keystoreProperties = new Properties()
keystoreProperties.load(new FileInputStream(keystorePropertiesFile))

// Load Citrix MAM SDK properties
def mamsdkPropertiesFile = rootProject.file("mamsdk.properties")
def mamsdkProperties = new Properties()
mamsdkProperties.load(new FileInputStream(mamsdkPropertiesFile))

ext {
    mamSdkLibraryMaven = mamsdkProperties['mamSdkLibraryMaven']
    if (mamSdkLibraryMaven.isEmpty()) {
        throw new GradleException('ERROR: mamSdkLibraryMaven property value is missing in mamsdk.properties.')
    }
    println 'mamSdkLibraryMaven:' + mamSdkLibraryMaven
    mamSdkLibraryTools = mamsdkProperties['mamSdkLibraryTools']
    if (mamSdkLibraryTools.isEmpty()) {
        throw new GradleException('ERROR: mamSdkLibraryTools property value is missing in mamsdk.properties.')
    }
    println 'mamSdkLibraryTools:' + mamSdkLibraryTools
    mamSdkVersion = mamsdkProperties['mamSdkVersion']
    if (mamSdkVersion.isEmpty()) {
        throw new GradleException('ERROR: mamSdkVersion property value is missing in mamsdk.properties.')
    }
    println 'mamSdkVersion:' + mamSdkVersion
    appPackageName = mamsdkProperties['appPackageName']
    if (appPackageName.isEmpty()) {
        throw new GradleException('ERROR: appPackageName property value is missing in mamsdk.properties.')
    }
    println 'appPackageName:' + appPackageName
    keyStorePath = keystoreProperties['keyStorePath']
    if (keyStorePath.isEmpty()) {
        throw new GradleException('ERROR: keyStorePath property value is missing in keystore.properties.')
    }
    println 'keyStorePath:' + keyStorePath
    keystorePassword = keystoreProperties['keystorePassword']
    if (keystorePassword.isEmpty()) {
        throw new GradleException('ERROR: keystorePassword property value is missing in keystore.properties.')
    }
    keyAlias = keystoreProperties['keyAlias']
    if (keyAlias.isEmpty()) {
        throw new GradleException('ERROR: keyAlias property value is missing in keystore.properties.')
    }
    keyPassword = keystoreProperties['keyPassword']
    if (keyPassword.isEmpty()) {
        throw new GradleException('ERROR: keyPassword property value is missing in keystore.properties.')
    }
}

allprojects {
    repositories {
        maven { url "$rootProject.ext.mamSdkLibraryMaven" }
        google()
        mavenCentral()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}
• Verify 3 - Modify the build.gradle file inside your app module and click Sync Now in Android Studio.
  The final build.gradle file in your app module should have the following content:
  plugins {
    id 'com.android.application'
    id "de.undercouch.download" version "4.1.1"
}

android {
    compileSdkVersion 30
    buildToolsVersion "31.0.0"
    defaultConfig {
        applicationId "${rootProject.ext.appPackageName}"
        minSdkVersion 24
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    signingConfigs {
        debug {
            storeFile file(rootProject.ext.keyStorePath)
            storePassword "$rootProject.ext.keystorePassword"
            keyAlias "$rootProject.ext.keyAlias"
            keyPassword "$rootProject.ext.keyPassword"
        }
        release {
            storeFile file(rootProject.ext.keyStorePath)
            storePassword "$rootProject.ext.keystorePassword"
            keyAlias "$rootProject.ext.keyAlias"
            keyPassword "$rootProject.ext.keyPassword"
        }
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release
        }
        debug {
            signingConfig signingConfigs.debug
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    implementation "com.citrix.android.sdk:mamsdk:${rootProject.ext.mamSdkVersion}"
    implementation 'androidx.appcompat:appcompat:1.3.1'
    implementation 'com.google.android.material:material:1.4.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

task downloadTools(type: Download, dependsOn: build) {
    src "${rootProject.ext.mamSdkLibraryTools}/managed-app-utility.jar"
    dest "$buildDir/tools/managed-app-utility.jar"
    overwrite false
}

task generateMdx(type: Exec, dependsOn: [downloadTools]) {
    commandLine 'java', '-jar', "$buildDir/tools/managed-app-utility.jar", 'wrap',
            '-in', "$buildDir/outputs/apk/release/${project.name}-release.apk",
            '-out', "$buildDir/outputs/apk/release/${project.name}.mdx",
            '-appType', 'sdkapp',
            '-storeUrl', "https://play.google.com/store/apps/details?id=${rootProject.ext.appPackageName}",
            '-keystore', "${rootProject.ext.keyStorePath}",
            '-storepass', "${rootProject.ext.keystorePassword}",
            '-keyalias', "${rootProject.ext.keyAlias}",
            '-keypass', "${rootProject.ext.keyPassword}"
}

build.finalizedBy generateMdx

• Verify 4 - Proguard-rules are added in the file proguard-rules.pro within your app module.
• Verify 5 - Modify your app's AndroidManifest.xml file usually located here: app > src > main
  The final AndroidManifest.xml file should have the following content:
  <?xml version="1.0" encoding="utf-8"?>
    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
            xmlns:tools="http://schemas.android.com/tools"
            package="com.example.nativemamsdkapp">
        <application
                    android:allowBackup="true"
                    android:icon="@mipmap/ic_launcher"
                    android:label="@string/app_name"
                    android:roundIcon="@mipmap/ic_launcher_round"
                    android:supportsRtl="true"
                    tools:replace="android:theme"
                    android:theme="@style/Theme.NativeMAMSDKApp" >
            <uses-library android:name="org.apache.http.legacy" android:required="false" />
            <activity android:name=".MainActivity" >
                <intent-filter>
                    <action android:name="android.intent.action.MAIN" />
                    <category android:name="android.intent.category.LAUNCHER" />
                </intent-filter>
            </activity>
        </application>
        <queries>
            <package android:name="com.zenprise" />
            <package android:name="com.citrix.Receiver" />
        </queries>
    </manifest>