Bug:26056 interface to new update policy property of the REST server

git-svn-id: svn+ssh://svn.marklogic.com/project/engsvn/client-api/java/branches/b2_0@163636 62cac252-8da6-4816-9e9d-6dc37b19578c

Author: ehennum

src/main/java/com/marklogic/client/admin/ServerConfigurationManager.java

@@ -26,6 +26,36 @@
  * of the server.
  */
 public interface ServerConfigurationManager {
+	/**
+	 * Specifies the policy for updating documents in the database. 
+	 */
+	public enum UpdatePolicy {
+		/**
+		 * A document can be updated or deleted only if its version number
+		 * is supplied and matches; a document can be created only if no
+		 * version number is supplied and the document doesn't exist. This
+		 * update policy requires optimistic locking.
+		 */
+		VERSION_REQUIRED,
+		/**
+		 * A document can be updated or deleted if its version number is
+		 * not supplied or if the version number matches. This update policy
+		 * provides for optional optimistic locking.
+		 */
+		VERSION_OPTIONAL,
+		/**
+		 * If a document exists, the supplied metadata is merged with the
+		 * persisted document metadata. This update policy is the default
+		 * (equivalent to content versions of Policy.NONE).
+		 */
+		MERGE_METADATA,
+		/**
+		 * The document is written without testing whether it exists. Only
+		 * the supplied metadata is persisted. This update policy is slightly
+		 * faster than other update policies.
+		 */
+		OVERWRITE_METADATA
+	}
 	/**
 	 * Specifies the policy for use of a capability. 
 	 */
@@ -116,15 +146,28 @@ public void writeConfiguration()
 	public void setServerRequestLogging(Boolean on);
 
 	/**
-	 * Returns whether the server requires, allows, or ignores document versionss
+	 * Returns the policy for updating or deleting documents in the database.
+	 * @return	the policy controlling updates or deletes
+	 */
+	public UpdatePolicy getUpdatePolicy();
+	/**
+	 * Specifies the policy for updating or deleting documents in the database.
+	 * @param policy	the policy controlling updates or deletes
+	 */
+	public void setUpdatePolicy(UpdatePolicy policy);
+
+	/**
+	 * Returns whether the server requires, allows, or ignores document versions
 	 * on document read, write, and delete requests.
 	 * @return	the policy as required, optional, or none
+	 * @deprecated	use {@link #getUpdatePolicy()}, which provides more alternatives
 	 */
 	public Policy getContentVersionRequests();
 	/**
-	 * Specifies whether the server requires, allows, or ignores document versionss
+	 * Specifies whether the server requires, allows, or ignores document versions
 	 * on document read, write, and delete requests.
 	 * @param policy	required, optional, or none for document versions
+	 * @deprecated	use {@link #setUpdatePolicy(UpdatePolicy)}, which provides more alternatives
 	 */
 	public void setContentVersionRequests(Policy policy);
 

src/main/java/com/marklogic/client/impl/ServerConfigurationManagerImpl.java

@@ -51,13 +51,14 @@ class ServerConfigurationManagerImpl
 
 	static final private String REST_API_NS = "http://marklogic.com/rest-api";
 
-	private Boolean validatingQueries;
-	private Boolean validatingQueryOptions;
-	private String  defaultDocumentReadTransform;
-	private Boolean defaultDocumentReadTransformAll;
-	private Boolean serverRequestLogging;
-	private Policy  contentVersions;
-	private Format  errorFormat;
+	private Boolean       validatingQueries;
+	private Boolean       validatingQueryOptions;
+	private String        defaultDocumentReadTransform;
+	private Boolean       defaultDocumentReadTransformAll;
+	private Boolean       serverRequestLogging;
+	private Policy        contentVersions;
+	private UpdatePolicy  updatePolicy;
+	private Format        errorFormat;
 
     private RESTServices          services;
 	private HandleFactoryRegistry handleRegistry;
@@ -97,6 +98,7 @@ public void readConfiguration()
 			defaultDocumentReadTransformAll = null;
 			serverRequestLogging            = null;
 			contentVersions                 = null;
+			updatePolicy                    = null;
 
 			while (reader.hasNext()) {
 				if (reader.next() != XMLStreamReader.START_ELEMENT)
@@ -115,12 +117,21 @@ public void readConfiguration()
 					serverRequestLogging = Boolean.valueOf(reader.getElementText());
 				} else if ("content-versions".equals(localName)) {
 					contentVersions = Enum.valueOf(Policy.class, reader.getElementText().toUpperCase());
+				} else if ("update-policy".equals(localName)) {
+					updatePolicy = Enum.valueOf(UpdatePolicy.class,
+							reader.getElementText().toUpperCase().replace("-", "_"));
 				} else if ("error-format".equals(localName)) {
 					errorFormat = Format.valueOf(reader.getElementText().toUpperCase());
 				}
 			}
 
 			reader.close();
+
+			if (contentVersions == null) {
+				updatePolicyToContentVersion();
+			} else if (updatePolicy == null) {
+				contentVersionToUpdatePolicy();
+			}
 		} catch (XMLStreamException e) {
 			logger.error("Failed to read server configuration stream",e);
 			throw new MarkLogicInternalException(e);
@@ -178,6 +189,11 @@ public void write(OutputStream out) throws IOException {
 				serializer.writeCharacters(contentVersions.name().toLowerCase());
 				serializer.writeEndElement();
 			}
+			if (updatePolicy != null) {
+				serializer.writeStartElement(REST_API_NS, "update-policy");
+				serializer.writeCharacters(updatePolicy.name().toLowerCase().replace("_", "-"));
+				serializer.writeEndElement();
+			}
 			if (errorFormat != null) {
 				serializer.writeStartElement(REST_API_NS, "error-format");
 				serializer.writeCharacters(errorFormat.name().toLowerCase());
@@ -238,13 +254,44 @@ public void setServerRequestLogging(Boolean on) {
 		serverRequestLogging = on;
 	}
 
+	@Override
+	public UpdatePolicy getUpdatePolicy() {
+		return updatePolicy;
+	}
+	@Override
+	public void setUpdatePolicy(UpdatePolicy updatePolicy) {
+		this.updatePolicy = updatePolicy;
+		updatePolicyToContentVersion();
+	}
+	private void updatePolicyToContentVersion() {
+		if (updatePolicy == null) {
+			return;
+		}
+		switch (updatePolicy) {
+		case VERSION_REQUIRED: contentVersions = Policy.REQUIRED; break;
+		case VERSION_OPTIONAL: contentVersions = Policy.OPTIONAL; break;
+		case MERGE_METADATA:   contentVersions = Policy.NONE;     break;
+		}
+	}
+
 	@Override
 	public Policy getContentVersionRequests() {
 		return contentVersions;
 	}
 	@Override
 	public void setContentVersionRequests(Policy policy) {
 		contentVersions = policy;
+		contentVersionToUpdatePolicy();
+	}
+	private void contentVersionToUpdatePolicy() {
+		if (contentVersions == null) {
+			return;
+		}
+		switch (contentVersions) {
+		case REQUIRED: updatePolicy = UpdatePolicy.VERSION_REQUIRED; break;
+		case OPTIONAL: updatePolicy = UpdatePolicy.VERSION_OPTIONAL; break;
+		case NONE:     updatePolicy = UpdatePolicy.MERGE_METADATA;   break;
+		}
 	}
 
 	@Override

src/test/java/com/marklogic/client/test/ConditionalDocumentTest.java

@@ -27,16 +27,16 @@
 import org.xml.sax.SAXException;
 
 import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.FailedRequestException;
 import com.marklogic.client.ForbiddenUserException;
 import com.marklogic.client.ResourceNotFoundException;
 import com.marklogic.client.ResourceNotResendableException;
-import com.marklogic.client.document.DocumentDescriptor;
-import com.marklogic.client.FailedRequestException;
-import com.marklogic.client.io.Format;
 import com.marklogic.client.admin.ServerConfigurationManager;
-import com.marklogic.client.admin.ServerConfigurationManager.Policy;
+import com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy;
+import com.marklogic.client.document.DocumentDescriptor;
 import com.marklogic.client.document.XMLDocumentManager;
 import com.marklogic.client.impl.FailedRequest;
+import com.marklogic.client.io.Format;
 import com.marklogic.client.io.StringHandle;
 
 public class ConditionalDocumentTest {
@@ -49,7 +49,7 @@ public static void beforeClass()
 		Common.connectAdmin();
 		serverConfig = Common.client.newServerConfigManager();
 		serverConfig.readConfiguration();
-		serverConfig.setContentVersionRequests(Policy.REQUIRED);
+		serverConfig.setUpdatePolicy(UpdatePolicy.VERSION_REQUIRED);
 		serverConfig.writeConfiguration();
 		adminClient = Common.client;
 		Common.release();
@@ -60,7 +60,7 @@ public static void beforeClass()
 	public static void afterClass()
 	throws FailedRequestException, ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException {
 		Common.release();
-		serverConfig.setContentVersionRequests(Policy.NONE);
+		serverConfig.setUpdatePolicy(UpdatePolicy.MERGE_METADATA);
 		serverConfig.writeConfiguration();
 		adminClient.release();
 	}