avh4 / maven-android-sdk-deployer

A tool to install components of the Android SDK to use with the Maven Android Plugin.

Maven Android SDK Deployer

Author: Manfred Moser [email protected] at simpligility technologies inc

The Maven Android SDK Deployer is a helper maven project that can be used to install the libraries necessary to build Android applications with Maven and the Android Maven Plugin directly from your local Android SDK installation.

ATTENTION! Currently some android.jar artifacts are available in Maven central and unless you use maps or usb related dependencies, android 3.0+, the compatibility library jar files or insist on using the original jar files from the local SDK install, you will not need this tool anymore.

You will however need this tool to access the latest Android 2.3 release or to work around bugs like missing JSON libraries in some older artifacts deployed to Maven central. If you use this tool make sure your dependencies are as documented here.

The android.jar artifacts in Maven central are available with the groupId com.google.android, whereas this tool uses android.android to avoid overlap.

How to Use

Download the latest Android SDK from http://developer.android.com/sdk/index.html following the instructions there.

• For the default usage of the deployer install all platforms and add-on apis, ensure that all folder in the platforms folder have names like android-3, android-4 and so on.

• If you find names using the platform version (e.g. 15) in the folder name reinstall that platform from the android tool.

• In a similar manner the folder names in add-ons have to use the pattern addon_google_apis_google_inc_-3 up to addon_google_apis_google_inc_-8. - If the folder names are different reinstall the add-ons as well

Set up the environment variable ANDROID_HOME to contain the absolute folder you just installed the SDK to (e.g. under bash: export ANDROID_HOME=/opt/android_sdk_linux) and ensure that the folder for ANDROID_HOME and all files within are readable by the current user

Run the command

mvn install

in the root folder of this project (same as README you are just reading) to install all platforms and add-on apis

To install only a certain sdk level use

mvn install -P 1.5
mvn install -P 1.6
mvn install -P 2.1
mvn install -P 2.2
mvn install -P 2.3.3
mvn install -P 3.0
mvn install -P 3.1
mvn install -P 3.2
mvn install -P 4.0
mvn install -P 4.0.3

As a result you should find the android.jar and maps.jar in various versions in your users local repository (~/.m2/repository/android and ~/.m2/repository/com/google/android/maps and ) and you can therefore use the following dependencies in your project

For the core platforms

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>1.5_r4</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>1.6_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>2.1_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>2.2_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>2.3.3_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>3.0_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>3.1_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>3.2_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>4.0_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>android</groupId>
  <artifactId>android</artifactId>
  <version>4.0.3_r1</version>
  <scope>provided</scope>
</dependency>

For the maps add ons

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>3_r3</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>4_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>7_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>8_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>10_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>11_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>12_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>13_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>14_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.google.android.maps</groupId>
  <artifactId>maps</artifactId>
  <version>15_r1</version>
  <scope>provided</scope>
</dependency>

For the usb add on

<dependency>
  <groupId>com.android.future</groupId>
  <artifactId>usb</artifactId>
  <version>10_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.android.future</groupId>
  <artifactId>usb</artifactId>
  <version>12_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.android.future</groupId>
  <artifactId>usb</artifactId>
  <version>13_r1</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.android.future</groupId>
  <artifactId>usb</artifactId>
  <version>14_r2</version>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.android.future</groupId>
  <artifactId>usb</artifactId>
  <version>15_r1</version>
  <scope>provided</scope>
</dependency>

For the compatibility extra (ATTENTION! Do NOT use provided scope!!)

<dependency>
  <groupId>android.support</groupId>
  <artifactId>compatibility-v4</artifactId>
  <version>r6</version>
</dependency>

<dependency>
  <groupId>android.support</groupId>
  <artifactId>compatibility-v13</artifactId>
  <version>r6</version>
</dependency>

To install only a specific module use

    mvn clean install -N

in any parent folder of the desired package and then the usual 1 mvn clean install

For example to install only the compatibility v4 extra you can do the following

    mvn clean install -N
    cd extras
    mvn clean install -N
    cd compatibility-v4
    mvn clean install

Similar for only API level 12 add on use

    mvn clean install -N
    cd add-ons
    mvn clean install -N
    cd google-apis-12
    mvn clean install

The same could be done with deploy

How To Use for Deploying Onto Remote Server

The above deployment works fine for one machine, but what if you need to supply a whole team of developers and a cluster of build machines with the artifacts.

As a condition you need to have a repository server used by all those machines and the following process will deploy to this server, which will in turn provide the artifacts to all the machines.

Edit the repo.url property in the pom.xml to point to the repository you want to publish to and then add a server with the credentials to your settings.xml.

<settings>
  <servers>
    <server>
      <id>android.repo</id>
      <username>your username</username>
      <password>your password</password>
    </server>
  </servers>
</settings>

Run the command

mvn deploy

in the root folder of this project (same as README you are just reading), you can also use the same profile options for the different api level. As a result you should find the artifact in the repository of your remote server

For more information about this stuff look at the documentation for the maven-deploy-plugin.

Mailinglist - Questions

Please direct any questions to the community at the Maven Android Developers mailing list at http://groups.google.com/group/maven-android-developers

Known problems

• Platforms and Add on folder names changes in SDK

When updating an existing android sdk install the add-ons subfolder can sometimes be reused and their contents be updates so you could end up with e.g. the google maps-4r2 in a folder named google_apis-4_r01. To work around this just uninstall the affected add-on and reinstall it with the android sdk tool.

Similarly the platform specific folder used to be e.g. android-1.5 and is now android-3 using the api level as the numeric identifier. If your SDK install uses the old folder names for any platform simply reinstall that platform with the android tool.

ATTENTION with ADK 14

The SDK changed folder names again. This time for all the Google Add Ons. The Maven Android SDK Deployer' is adapted to the new naming scheme. To do that yourself remove all "Google APIs by Google Inc" in the android SDK manager and install them again.

Issues

If you find any problems or would like to suggest a feature, please feel free to file an issue on github at http://github.com/mosabua/maven-android-sdk-deployer/issues

Potential todo items

• add custom pom files for install/deploy that eg. define dependency from maps to android jar

• maybe some sort of reporting of errors, failures and success as well

Additional Contributors

• Hugo Josefson [email protected] - properties plugin usage
• Jake Wharton [email protected] - 3.2, compatibility v13 and 4.0.3 support
• https://github.com/holdensmagicalunicorn - spelling fix
• Guto Maia [email protected]- initial USB add on support
• Lorenzo Villani - initial 4.0 support