From 0cfef55837bd7796340266fa418e0f668da910cf Mon Sep 17 00:00:00 2001
From: remillet <remillet@yahoo.com>
Date: Wed, 27 Apr 2016 11:51:02 -0700
Subject: [PATCH] CSPACE-6937-A: Adding API to allow client to check whether or
 not an authority supports synchronization.

---
 .../common/vocabulary/AuthorityResource.java  | 21 +++++++++++++---
 .../services/client/AuthorityClient.java      |  8 +++++--
 .../services/client/AuthorityClientImpl.java  | 24 +++++++++++++++++--
 .../services/client/AuthorityProxy.java       |  5 ++++
 .../config/src/main/resources/service.xsd     |  1 +
 5 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/AuthorityResource.java b/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/AuthorityResource.java
index 4ba1a8707..74f95a625 100644
--- a/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/AuthorityResource.java
+++ b/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/AuthorityResource.java
@@ -77,6 +77,7 @@ import org.collectionspace.services.common.vocabulary.nuxeo.AuthorityDocumentMod
 import org.collectionspace.services.common.vocabulary.nuxeo.AuthorityItemDocumentModelHandler;
 import org.collectionspace.services.common.workflow.service.nuxeo.WorkflowDocumentModelHandler;
 import org.collectionspace.services.config.ClientType;
+import org.collectionspace.services.config.service.ServiceBindingType;
 import org.collectionspace.services.jaxb.AbstractCommonList;
 import org.collectionspace.services.lifecycle.TransitionDef;
 import org.collectionspace.services.nuxeo.client.java.DocumentModelHandler;
@@ -339,6 +340,14 @@ public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
     	}
     }
 
+    protected boolean supportsSync(String tenantId, String serviceName) {
+    	boolean result = false;
+    	
+        ServiceBindingType sb = getTenantBindingsReader().getServiceBinding(tenantId, getServiceName());
+        result = sb.isSupportsSynchronization();
+        
+        return result;
+    }
 
     /**
      * Synchronizes the authority and its terms with a Shared Authority Server.
@@ -352,7 +361,7 @@ public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
     public byte[] synchronize(
             @Context Request request,
             @Context UriInfo ui,
-            @PathParam("csid") String csid) {
+            @PathParam("csid") String identifier) {
     	byte[] result;
     	boolean neededSync = false;
         PoxPayloadOut payloadOut = null;
@@ -360,13 +369,19 @@ public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
         
         try {
             ServiceContext<PoxPayloadIn, PoxPayloadOut> ctx = createServiceContext(ui);
+            /*
+             * Make sure this authority service supports synchronization
+             */
+            if (supportsSync(ctx.getTenantId(), ctx.getServiceName()) == false) {
+            	throw new DocumentException(Response.Status.FORBIDDEN.getStatusCode());
+            }
             AuthorityDocumentModelHandler handler = (AuthorityDocumentModelHandler)createDocumentHandler(ctx);
-            specifier = Specifier.getSpecifier(csid, "getAuthority", "GET");
+            specifier = Specifier.getSpecifier(identifier, "getAuthority", "GET");
             handler.setShouldUpdateRevNumber(AuthorityServiceUtils.DONT_UPDATE_REV); // Never update rev number on sync calls
             neededSync = getRepositoryClient(ctx).synchronize(ctx, specifier, handler);
             payloadOut = ctx.getOutput();
         } catch (Exception e) {
-            throw bigReThrow(e, ServiceMessages.SYNC_FAILED, csid);
+            throw bigReThrow(e, ServiceMessages.SYNC_FAILED, identifier);
         }
 
         //
diff --git a/services/client/src/main/java/org/collectionspace/services/client/AuthorityClient.java b/services/client/src/main/java/org/collectionspace/services/client/AuthorityClient.java
index a55aadd46..9ae1208c4 100644
--- a/services/client/src/main/java/org/collectionspace/services/client/AuthorityClient.java
+++ b/services/client/src/main/java/org/collectionspace/services/client/AuthorityClient.java
@@ -64,8 +64,12 @@ public interface AuthorityClient<AUTHORITY_ITEM_TYPE, P extends AuthorityProxy>
     /*
      * Synchronization methods
      */
-    Response syncByName(String name);
-
+    
+    public Response syncByName(String name);
+    
+    public Response sync(String identifier);
+    
+    public boolean supportsSync();
     
     /*
      * READ/GET by name method
diff --git a/services/client/src/main/java/org/collectionspace/services/client/AuthorityClientImpl.java b/services/client/src/main/java/org/collectionspace/services/client/AuthorityClientImpl.java
index 903c76f83..2059a59d5 100644
--- a/services/client/src/main/java/org/collectionspace/services/client/AuthorityClientImpl.java
+++ b/services/client/src/main/java/org/collectionspace/services/client/AuthorityClientImpl.java
@@ -78,12 +78,32 @@ public abstract class AuthorityClientImpl<AUTHORITY_ITEM_TYPE, P extends Authori
     }
     
     /*
-     * Synchronization method
+     * Synchronization methods
      */
+    
+    @Override
     public Response syncByName(String name) {
     	return getProxy().syncByName(name);
     }
-
+    
+    @Override
+    public Response sync(String identifier) {
+    	return getProxy().sync(identifier);
+    }
+    
+    @Override
+    public boolean supportsSync() {
+    	boolean result = true;
+    	
+    	Response response = getProxy().sync("-1"); // Check to see if the Authority (in general) supports sync for any of its instances
+    	int status = response.getStatus();
+    	if (status == Response.Status.FORBIDDEN.getStatusCode()) {
+    		result = false;
+    	}
+    	
+    	return result;
+    }
+    
     /*
      * 
      */
diff --git a/services/client/src/main/java/org/collectionspace/services/client/AuthorityProxy.java b/services/client/src/main/java/org/collectionspace/services/client/AuthorityProxy.java
index 4102d548f..2f1500e33 100644
--- a/services/client/src/main/java/org/collectionspace/services/client/AuthorityProxy.java
+++ b/services/client/src/main/java/org/collectionspace/services/client/AuthorityProxy.java
@@ -83,6 +83,11 @@ public interface AuthorityProxy extends CollectionSpaceCommonListPoxProxy {
     @Path("/urn:cspace:name({name})/sync")
     Response syncByName(@PathParam("name") String name);
     
+    // Sync by name or CSID
+    @GET
+    @Path("/{identifier}/sync")
+    public Response sync(String identifier);
+    
     /*
      * READ/GET Methods
      */
diff --git a/services/config/src/main/resources/service.xsd b/services/config/src/main/resources/service.xsd
index 79cbb15dc..03ac2f072 100644
--- a/services/config/src/main/resources/service.xsd
+++ b/services/config/src/main/resources/service.xsd
@@ -60,6 +60,7 @@
         <xs:attribute name="name" type="xs:string" use="required"/>
         <xs:attribute name="type" type="xs:string" use="optional"/>
         <xs:attribute name="version" type="types:VersionType" use="required"/>
+        <xs:attribute name="supportsSynchronization" type="xs:boolean" default="false"/>
     </xs:complexType>
 
     <!--
-- 
2.47.3