#Microsoft Azure Storage SDK for Android

This project provides a client library for Android that makes it easy to consume Microsoft Azure Storage services. For documentation please see the AndroidDocs.

#Features

• Blob
  • Create/Read/Update/Delete containers
  • Create/Read/Update/Delete blobs
  • Advanced Blob Operations
• Queue
  • Create/Delete Queues
  • Insert/Peek Queue Messages
  • Advanced Queue Operations
• Table
  • Create/Read/Update/Delete tables
  • Create/Read/Update/Delete entities
  • Batch operations
  • Advanced Table Operations

#Getting Started

##Download ###Option 1: Source Zip

To download a copy of the source code, click "Download ZIP" on the right side of the page or click here. Unzip and navigate to the microsoft-azure-storage folder.

###Option 2: Source via Git

To get the source code of the SDK via git just type:

git clone git://github.com/Azure/azure-storage-android.git
cd ./azure-storage-android/microsoft-azure-storage

###Option 3: aar via Gradle

To get the binaries of this library as distributed by Microsoft, ready for use within your project, you can use Gradle.

First, add mavenCentral to your repositories by adding the following to your gradle build file:

repositories {
    mavenCentral()
}

Then, add a dependency by adding the following to your gradle build file:

dependencies {
    compile 'com.microsoft.azure.android:azure-storage-android:0.3.0@aar'
}

###Option 4: aar via Maven

To get the binaries of this library as distributed by Microsoft, ready for use within your project, you can use Maven.

<dependency>
	<groupId>com.microsoft.azure.android</groupId>
	<artifactId>azure-storage-android</artifactId>
	<version>0.3.1</version>
	<type>aar</type>
</dependency>

##Minimum Requirements and Setup

• Jackson-Core is used for JSON parsing.
• Android 4.0/15+
• (Optional) Gradle or Maven

This library is currently tested to work on Android versions 4.0+. Compatibility with older versions is not guaranteed.

##Usage

To use this SDK to call Microsoft Azure storage services, you need to first create an account.

Samples are provided in the microsoft-azure-storage-samples folder. The unit tests in microsoft-azure-storage-test can also be helpful.

Make sure the storage client library is added as a project dependency. If using source and in Eclipse, right click on the project, select "Properties", navigate to the Android tab, and under "Library" click "Add.." and select the project. To do this, the storage client library should already be imported into Eclipse as an Android project.

If using Maven or Gradle, Jackson-Core should be automatically added to the build path. Otherwise, please download the jar and add it to your build path. Also, please make sure that the jar will be added to your project's apk. To do this in Eclipse, right click your project, select "Build Path->Configure Build Path", navigate to the "Order and Export" tab and check the box next to the jackson-core jar.

##Code Sample

The following is a quick example on how to upload a file to azure blob and download it back. You may also download and view the samples in the microsoft-azure-storage-samples folder. For additional information on using the Android client library, the Java general documentation and Java How To guides for blobs, queues, tables may be helpful.

import java.io.*;

import com.microsoft.azure.storage.*;
import com.microsoft.azure.storage.blob.*;

public class BlobSample {
	public static final String storageConnectionString =
		"DefaultEndpointsProtocol=http;"
		+ "AccountName=your_account_name;"
		+ "AccountKey= your_account_key";

	public static void main(String[] args) {
		try {
			CloudStorageAccount account = CloudStorageAccount.parse(storageConnectionString);
            CloudBlobClient serviceClient = account.createCloudBlobClient();

            // Container name must be lower case.
            CloudBlobContainer container = serviceClient.getContainerReference("myimages");
            container.createIfNotExists();

            // Set anonymous read access on the container.
            BlobContainerPermissions containerPermissions = new BlobContainerPermissions();
            containerPermissions.setPublicAccess(BlobContainerPublicAccessType.CONTAINER);
            container.uploadPermissions(containerPermissions);

            // Upload an image file.
            CloudBlockBlob blob = container.getBlockBlobReference("image1.jpg");
            File sourceFile = new File("c:\\myimages\\image1.jpg");
            blob.upload(new FileInputStream(sourceFile), sourceFile.length());

            // Download the image file.
            File destinationFile = new File(sourceFile.getParentFile(), "image1Download.tmp");
            blob.downloadToFile(destinationFile.getAbsolutePath());
        }
        catch (FileNotFoundException fileNotFoundException) {
            System.out.print("FileNotFoundException encountered: ");
            System.out.println(fileNotFoundException.getMessage());
            System.exit(-1);
        }
        catch (StorageException storageException) {
            System.out.print("StorageException encountered: ");
            System.out.println(storageException.getMessage());
            System.exit(-1);
        }
        catch (Exception e) {
            System.out.print("Exception encountered: ");
            System.out.println(e.getMessage());
            System.exit(-1);
        }
	}
}

#Need Help?

Be sure to check out the Azure Developer Forums on MSDN or the Developer Forums on Stack Overflow if you have trouble with the provided code.

#Contribute Code or Provide Feedback

If you would like to become an active contributor to this project please follow the instructions provided in Azure Projects Contribution Guidelines.

If you encounter any bugs with the library please file an issue in the Issues section of the project.

#Learn More

• Azure Storage Service
• Azure Storage Team Blog
• AndroidDocs