forked from Azure/azure-sdk-for-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
184a702
commit fd078e8
Showing
259 changed files
with
10,657 additions
and
12,581 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,133 @@ | ||
| #Windows Azure Storage SDK for Java | ||
| #Microsoft Azure Storage SDK for Java | ||
|
|
||
| This project provides a client library in Java that makes it easy to consume Windows Azure Storage services. For documentation please see the [Windows Azure Java Developer Center](http://www.windowsazure.com/en-us/develop/java/) and the [JavaDocs](http://dl.windowsazure.com/storage/javadoc). | ||
| This project provides a client library in Java that makes it easy to consume Microsoft Azure Storage services. For documentation please see the Microsoft Azure [Java Developer Center](http://azure.microsoft.com/en-us/develop/java/) and the [JavaDocs](http://dl.windowsazure.com/storage/javadoc). | ||
|
|
||
| #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 operation | ||
| * Batch operations | ||
| * Advanced Table Operations | ||
|
|
||
| #Getting Started | ||
|
|
||
| ##Download | ||
| ###Option 1: Via Git | ||
| ###Option 1: Via Maven | ||
|
|
||
| To get the source code of the SDK via git just type: | ||
|
|
||
| git clone git://github.com/WindowsAzure/azure-storage-java.git | ||
| cd ./azure-storage-java/microsoft-azure-storage | ||
| mvn compile | ||
|
|
||
| ###Option 2: Via Maven | ||
|
|
||
| To get the binaries of this library as distributed by Microsoft, ready for use | ||
| within your project you can also have them installed by the Java package manager Maven. | ||
| To get the binaries of this library as distributed by Microsoft, ready for use within your project, you can use Maven. | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>com.microsoft.windowsazure.storage</groupId> | ||
| <artifactId>microsoft-windowsazure-storage-sdk</artifactId> | ||
| <version>0.6.0</version> | ||
| <version>0.7.0</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| ###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-java.git | ||
| cd ./azure-storage-java/microsoft-azure-storage | ||
| mvn compile | ||
|
|
||
| ###Option 3: Source Zip | ||
|
|
||
| To download a copy of the source code, click "Download ZIP" on the right side of the page or click [here](https://github.com/Azure/azure-storage-java/archive/master.zip). Unzip and navigate to the microsoft-azure-storage folder. | ||
|
|
||
| ##Minimum Requirements | ||
|
|
||
| * Java 1.6 | ||
| * Java 1.6+ | ||
| * [Jackson-Core](https://github.com/FasterXML/jackson-core) is used for JSON parsing. | ||
| * (Optional) [SLF4J](http://www.slf4j.org/) is a logging facade. | ||
| * (Optional) [SLF4J binding](http://www.slf4j.org/manual.html) is used to associate a specific logging framework with SLF4J. | ||
| * (Optional) Maven | ||
|
|
||
|
|
||
| The two dependencies, [Jackson-Core](https://github.com/FasterXML/jackson-core) and [SLF4J](http://www.slf4j.org/), will be added automatically if Maven is used. Otherwise, please download the jars and add them to your build path. | ||
|
|
||
| SLF4J is only needed if you enable logging through the OperationContext class. If you plan to use logging, please also download an [SLF4J binding](http://repo2.maven.org/maven2/org/slf4j/) which will link the SLF4J API with the logging implementation of your choice. Simple is a good default. See the [SLF4J user manual](http://www.slf4j.org/manual.html) for more information. | ||
|
|
||
| ##Usage | ||
|
|
||
| To use this SDK to call Windows Azure services, you need to first create an | ||
| account. To host your Java code in Windows Azure, you additionally need to download | ||
| the full Windows Azure SDK for Java - which includes packaging, emulation, and | ||
| deployment tools. | ||
| To use this SDK to call Microsoft Azure storage services, you need to first [create an account](https://account.windowsazure.com/signup). | ||
|
|
||
| Samples are provided in the microsoft-azure-storage-samples folder. The unit tests in microsoft-azure-storage-test can also be helpful. | ||
|
|
||
| ##Code Sample | ||
|
|
||
| The following is a quick example on how to set up a Azure blob using the API and uploading a file to it. For additional information on using the client libraries to access Azure services see the How To guides for [blobs](http://www.windowsazure.com/en-us/develop/java/how-to-guides/blob-storage/), [queues](http://www.windowsazure.com/en-us/develop/java/how-to-guides/queue-service/) and [tables](http://www.windowsazure.com/en-us/develop/java/how-to-guides/table-service/) and the [general documentation](http://www.windowsazure.com/en-us/develop/java/). | ||
| 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 client libraries to access Azure services see the How To guides for [blobs](http://azure.microsoft.com/en-us/documentation/articles/storage-java-how-to-use-blob-storage/), [queues](http://azure.microsoft.com/en-us/documentation/articles/storage-java-how-to-use-queue-storage/), [tables](http://azure.microsoft.com/en-us/documentation/articles/storage-java-how-to-use-table-storage/) and the [general documentation](http://azure.microsoft.com/en-us/develop/java/). | ||
|
|
||
| ```java | ||
| import java.io.*; | ||
|
|
||
| import com.microsoft.windowsazure.storage.*; | ||
| import com.microsoft.windowsazure.storage.blob.*; | ||
| 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"; | ||
| "DefaultEndpointsProtocol=http;" | ||
| + "AccountName=your_account_name;" | ||
| + "AccountKey= your_account_key"; | ||
|
|
||
| public static void main(String[] args) { | ||
| try { | ||
| CloudStorageAccount account; | ||
| CloudBlobClient serviceClient; | ||
| CloudBlobContainer container; | ||
| CloudBlockBlob blob; | ||
|
|
||
| account = CloudStorageAccount.parse(storageConnectionString); | ||
| serviceClient = account.createCloudBlobClient(); | ||
| // Container name must be lower case. | ||
| container = serviceClient.getContainerReference("blobsample"); | ||
| container.createIfNotExists(); | ||
|
|
||
| // Set anonymous access on the container. | ||
| BlobContainerPermissions containerPermissions; | ||
| containerPermissions = new BlobContainerPermissions(); | ||
| container.uploadPermissions(containerPermissions); | ||
|
|
||
| // Upload an image file. | ||
| blob = container.getBlockBlobReference("image1.jpg"); | ||
| File fileReference = new File("c:\\myimages\\image1.jpg"); | ||
| blob.upload(new FileInputStream(fileReference), fileReference.length()); | ||
| } 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); | ||
| } | ||
|
|
||
| CloudStorageAccount account = CloudStorageAccount.parse(storageConnectionString); | ||
| CloudBlobClient serviceClient = account.createCloudBlobClient(); | ||
|
|
||
| // Container name must be lower case. | ||
| CloudBlobContainer container = serviceClient.getContainerReference("myimages"); | ||
| container.createIfNotExists(); | ||
|
|
||
| // 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 Windows Azure [Developer Forums on MSDN](http://social.msdn.microsoft.com/Forums/windowsazure/en-US/home?forum=windowsazuredata) or the [Developer Forums on Stack Overflow](http://stackoverflow.com/questions/tagged/azure+windows-azure-storage) if you have trouble with the provided code. | ||
| Be sure to check out the Microsoft Azure [Developer Forums on MSDN](http://social.msdn.microsoft.com/Forums/windowsazure/en-US/home?forum=windowsazuredata) or the [Developer Forums on Stack Overflow](http://stackoverflow.com/questions/tagged/azure+windows-azure-storage) 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 [Windows Azure Projects Contribution Guidelines](http://windowsazure.github.com/guidelines.html). | ||
| If you would like to become an active contributor to this project please follow the instructions provided in [Azure Projects Contribution Guidelines](http://azure.github.io/guidelines.html). | ||
|
|
||
| If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/WindowsAzure/azure-storage-java/issues) section of the project. | ||
| If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-storage-java/issues) section of the project. | ||
|
|
||
| #Learn More | ||
|
|
||
| * [Windows Azure Java Developer Center](http://www.windowsazure.com/en-us/develop/java/) | ||
| * [Windows Azure Storage Service](http://www.windowsazure.com/en-us/documentation/services/storage/) | ||
| * [JavaDocs](http://dl.windowsazure.com/storage/javadoc) | ||
| * [Azure Developer Center](http://azure.microsoft.com/en-us/develop/java/) | ||
| * [Azure Storage Service](http://azure.microsoft.com/en-us/documentation/services/storage/) | ||
| * [Azure Storage Team Blog](http://blogs.msdn.com/b/windowsazurestorage/) | ||
| * [JavaDocs](http://dl.windowsazure.com/storage/javadoc) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.