Merge pull request #45 from shellygms/master

DocumentDB Java SDK 1.7.0 Release

Author: Shelly Guo

README.md

@@ -14,7 +14,7 @@ To get the binaries of this library as distributed by Microsoft, ready for use w
     <dependency>
     	<groupId>com.microsoft.azure</groupId>
     	<artifactId>azure-documentdb</artifactId>
-    	<version>1.6.0</version>
+    	<version>1.7.0</version>
     </dependency>
 
 ###Option 2: Source Via Git
@@ -92,9 +92,9 @@ public class SampleApp {
         DocumentCollection myCollection = new DocumentCollection();
         myCollection.setId(COLLECTION_ID);
 
-        // Configure the new collection performance tier to S1.
+        // Set the provisioned throughput for this collection to be 1000 RUs.
         RequestOptions requestOptions = new RequestOptions();
-        requestOptions.setOfferType("S1");
+        requestOptions.setOfferThroughput(1000);
 
         // Create a new collection.
         myCollection = documentClient.createCollection(

changelog.md

@@ -1,3 +1,7 @@
+## Changes in 1.7.0 : ##
+
+	- Added support for expiring documents by setting the default time-to-live on collections and time-to-live override on documents.
+
 ## Changes in 1.6.0 : ##
 
 	- Added support to set offer throughput for collections created with variable pricing structure.

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.microsoft.azure</groupId>
   <artifactId>azure-documentdb</artifactId>
-  <version>1.6.0</version>
+  <version>1.7.0</version>
   <name>${project.groupId}:${project.artifactId}</name>
   <description>Java SDK for Microsoft Azure DocumentDB</description>
   <url>http://azure.microsoft.com/en-us/services/documentdb/</url>

src/com/microsoft/azure/documentdb/Constants.java

@@ -117,7 +117,11 @@ static class Properties {
         static final String PARTITION_KEY_PATHS = "paths";
         static final String PARTITION_KIND = "kind";
         static final String RESOURCE_PARTITION_KEY = "resourcePartitionKey";
-    }
+
+        //Time-to-Live
+        static final String TTL = "ttl";
+        static final String DEFAULT_TTL = "defaultTtl";
+}
 
     static class ResourceKeys {
         static final String ATTACHMENTS = "Attachments";

src/com/microsoft/azure/documentdb/Document.java

@@ -53,4 +53,41 @@ static Document FromObject(Object document) {
         }
         return typedDocument;
     }
+    
+    /**
+     * Sets the document's time-to-live value.
+     * <p>
+     * A document's time-to-live value is an optional property. If set, the document expires after the specified number
+     * of seconds since its last write time. The value of this property should be one of the following:
+     * 		null - indicates the time-to-live value for this document inherits from the parent collection's default time-to-live value.
+     * 		nonzero positive integer - indicates the number of seconds before the document expires. It overrides the default time-to-live
+     * 			value specified on the parent collection, unless the parent collection's default time-to-live is null.
+     * 		-1 - indicates the document never expires. It overrides the default time-to-live
+     * 			value specified on the parent collection, unless the parent collection's default time-to-live is null.
+     * 
+     * @param timeToLive the document's time-to-live value in seconds.
+     */
+    public void setTimeToLive(Integer timeToLive) {
+    	// a "null" value is represented as a missing element on the wire.
+    	// setting timeToLive to null should remove the property from the property bag.
+    	if (timeToLive != null) {
+    		super.set(Constants.Properties.TTL, timeToLive);
+    	}
+    	else if (super.has(Constants.Properties.TTL)) {
+    		super.remove(Constants.Properties.TTL);
+    	}
+    }
+
+    /**
+     * Gets the document's time-to-live value.
+     * 
+     * @return the document's time-to-live value in seconds.
+     */
+    public Integer getTimeToLive() {
+    	if (super.has(Constants.Properties.TTL)) {
+    		return super.getInt(Constants.Properties.TTL);
+    	}
+    	
+    	return null;
+    }
 }

src/com/microsoft/azure/documentdb/DocumentCollection.java

@@ -95,6 +95,44 @@ public PartitionKeyDefinition getPartitionKey() {
     	return null;
     }
 
+    /**
+     * Sets the collection's default time-to-live value.
+     * <p>
+     * The default time-to-live value on a collection is an optional property. If set, the documents within the collection
+     * expires after the specified number of seconds since their last write time. The value of this property should be one of the following:
+     * 		null - indicates evaluation of time-to-live is disabled and documents within the collection will never expire, regardless whether
+     * 			individual documents have their time-to-live set.
+     * 		nonzero positive integer - indicates the default time-to-live value for all documents within the collection. This value can be overridden
+     * 			by individual documents' time-to-live value.
+     * 		-1 - indicates by default all documents within the collection never expire. This value can be overridden by individual documents' 
+     * 			time-to-live value.
+     * 
+     * @param timeToLive the default time-to-live value in seconds.
+     */
+    public void setDefaultTimeToLive(Integer timeToLive) {
+    	// a "null" value is represented as a missing element on the wire.
+    	// setting timeToLive to null should remove the property from the property bag.
+    	if (timeToLive != null) {
+    		super.set(Constants.Properties.DEFAULT_TTL, timeToLive);
+    	}
+    	else if (super.has(Constants.Properties.DEFAULT_TTL)) {
+    		super.remove(Constants.Properties.DEFAULT_TTL);
+    	}
+    }
+
+    /**
+     * Gets the collection's default time-to-live value.
+     * 
+     * @return the the default time-to-live value in seconds.
+     */
+    public Integer getDefaultTimeToLive() {
+    	if (super.has(Constants.Properties.DEFAULT_TTL)) {
+    		return super.getInt(Constants.Properties.DEFAULT_TTL);
+    	}
+    	
+    	return null;
+    }
+    
     /**
      * Gets the self-link for documents in a collection.
      * 

src/com/microsoft/azure/documentdb/HashPartitionResolver.java

@@ -130,7 +130,7 @@ public String resolveForCreate(Object document) {
     /**
      * Resolves the collection for reading/querying the documents based on the partition key.
      * 
-     * @param partitionKey the partition key used to resolve the collection.
+     * @param partitionKey the partition key value
      * 
      * @return collection Self link(s) or Name based link(s) which should handle the Read operation
      */

src/com/microsoft/azure/documentdb/HttpConstants.java

@@ -166,7 +166,7 @@ public static class HttpHeaders {
 
     public static class Versions {
         public static String CURRENT_VERSION = "2015-12-16";
-        public static String USER_AGENT = "documentdb-java-sdk-1.6.0";
+        public static String USER_AGENT = "documentdb-java-sdk-1.7.0";
     }
 
     public static class StatusCodes {

src/com/microsoft/azure/documentdb/PartitionKey.java

@@ -28,7 +28,7 @@ public PartitionKey(Object key) {
 	 * Create a new instance of the PartitionKey object from a serialized JSON string.
 	 * 
 	 * @param jsonString
-	 *            the value of the partition key in JSON form.
+	 *            the JSON string representation of this PartitionKey object.
 	 *            
 	 * @return the PartitionKey instance.
 	 */

src/com/microsoft/azure/documentdb/RangePartitionResolver.java

@@ -81,7 +81,7 @@ public String resolveForCreate(Object document) {
     /**
      * Resolves the collection for reading/querying the documents based on the partition key.
      * 
-     * @param partitionKey the partition key used to resolve the collection.
+     * @param partitionKey the partition key value. 
      * 
      * @return collection Self link(s) or Name based link(s) which should handle the Read operation.
      */