From: Patrick Schmitz <pschmitz@berkeley.edu>
Date: Wed, 26 Oct 2011 00:09:00 +0000 (+0000)
Subject: CSPACE-4406 - added support for refObjs for vocabulary service items, so that termLis... 
X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=5be11411015c67698ad2af92b5c3fe55dee33602;p=tmp%2Fjakarta-migration.git

CSPACE-4406 - added support for refObjs for vocabulary service items, so that termList items can check for usage. Uses new termRef configuration, so that authorityRefs paylaods do not include termList items in the results.
---

diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/vocabulary/vocabulary.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/vocabulary/vocabulary.xml
index a4839170f..64aa09f3e 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/vocabulary/vocabulary.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/vocabulary/vocabulary.xml
@@ -6,7 +6,7 @@
 		<auth ID="testAdministator">YWRtaW5AY29sbGVjdGlvbnNwYWNlLm9yZzpBZG1pbmlzdHJhdG9y</auth>
 	</auths>
 	<testGroup ID="TestOrder" autoDeletePOSTS="true">
-        <!-- The purpose of this testGroup is to test the new "order" field
+		<!-- The purpose of this testGroup is to test the new "order" field
 	      that was added in http://issues.collectionspace.org/browse/CSPACE-573
 	      and to ensure that this order field is returned in list results, 
 	      and that duplicate values for the order field is accepted.
@@ -46,25 +46,34 @@
 				<var ID="displayName">TestOrder item ${itemID} order ${order}</var>
 			</vars>
 		</test>
-		
+
 		<test ID="GetVocabularies" auth="admin@core.collectionspace.org">
-            <method>GET</method>
-            <uri>/cspace-services/vocabularies/</uri>
-        </test>
-        
-        <test ID="GetVocabularyItems" auth="admin@core.collectionspace.org">
-            <method>GET</method>
-            <uri>/cspace-services/vocabularies/${Vocabulary1.CSID}/items/</uri>
-            <response>
-                <expected level="ADDOK" />
-                <filename>vocabulary/res/GetVocabularyItems.res.xml</filename>
-                <vars>
+			<method>GET</method>
+			<uri>/cspace-services/vocabularies/</uri>
+		</test>
+
+		<test ID="GetVocabularyItems" auth="admin@core.collectionspace.org">
+			<method>GET</method>
+			<uri>/cspace-services/vocabularies/${Vocabulary1.CSID}/items/</uri>
+			<response>
+				<expected level="ADDOK"/>
+				<filename>vocabulary/res/GetVocabularyItems.res.xml</filename>
+				<vars>
 					<var ID="I3displayName">${Item3DupeOrder.displayName}</var>
 				</vars>
-                <!--<startElement>//vocabulary-list-item[./exitNumber='checkList-1234']</startElement>-->
-             </response>
-        </test>
-		
+				<!--<startElement>//vocabulary-list-item[./exitNumber='checkList-1234']</startElement>-->
+			</response>
+		</test>
+
+		<test ID="GetVocabularyItem" auth="admin@core.collectionspace.org">
+			<method>GET</method>
+			<uri>/cspace-services/vocabularies/${Vocabulary1.CSID}/items/${Item1.CSID}</uri>
+		</test>
+
+		<test ID="GetVocabularyItemRefObjs" auth="admin@core.collectionspace.org">
+			<method>GET</method>
+			<uri>/cspace-services/vocabularies/${Vocabulary1.CSID}/items/${Item1.CSID}/refObjs</uri>
+		</test>
+
 	</testGroup>
 </xmlReplay>
-
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 96d887e65..2764731c5 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
@@ -87,6 +87,18 @@ import java.util.List;
 /**
  * The Class AuthorityResource.
  */
+/**
+ * @author pschmitz
+ *
+ * @param <AuthCommon>
+ * @param <AuthItemHandler>
+ */
+/**
+ * @author pschmitz
+ *
+ * @param <AuthCommon>
+ * @param <AuthItemHandler>
+ */
 @Consumes("application/xml")
 @Produces("application/xml")
 public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
@@ -677,6 +689,15 @@ public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
         }
     }
 
+    /**
+     * @return the name of the property used to specify references for items in this type of
+     * authority. For most authorities, it is ServiceBindingUtils.AUTH_REF_PROP ("authRef").
+     * Some types (like Vocabulary) use a separate property.
+     */
+    protected String getRefPropName() {
+    	return ServiceBindingUtils.AUTH_REF_PROP;
+    }
+    
     /**
      * Gets the entities referencing this Authority item instance. The service type
      * can be passed as a query param "type", and must match a configured type
@@ -723,6 +744,7 @@ public abstract class AuthorityResource<AuthCommon, AuthItemHandler>
                     repoClient,
                     serviceType,
                     refName,
+                    getRefPropName(),
                     myFilter.getPageSize(), myFilter.getStartPage(), true /*computeTotal*/);
         } catch (Exception e) {
             throw bigReThrow(e, ServiceMessages.GET_FAILED);
diff --git a/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/RefNameServiceUtils.java b/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/RefNameServiceUtils.java
index 0731d476b..56fb51779 100644
--- a/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/RefNameServiceUtils.java
+++ b/services/authority/service/src/main/java/org/collectionspace/services/common/vocabulary/RefNameServiceUtils.java
@@ -65,6 +65,7 @@ public class RefNameServiceUtils {
             RepositoryClient repoClient,
             String serviceType,
             String refName,
+            String refPropName,
             int pageSize, int pageNum, boolean computeTotal) throws DocumentException, DocumentNotFoundException {
         AuthorityRefDocList wrapperList = new AuthorityRefDocList();
         AbstractCommonList commonList = (AbstractCommonList) wrapperList;
@@ -89,7 +90,7 @@ public class RefNameServiceUtils {
         Map<String, ServiceBindingType> queriedServiceBindings = new HashMap<String, ServiceBindingType>();
         Map<String, Map<String, String>> authRefFieldsByService = new HashMap<String, Map<String, String>>();
         
-        String query = computeWhereClauseForAuthorityRefDocs(escapedRefName, docTypes, servicebindings, 
+        String query = computeWhereClauseForAuthorityRefDocs(escapedRefName, refPropName, docTypes, servicebindings, 
         											queriedServiceBindings, authRefFieldsByService );
         if (query == null) { // found no authRef fields - nothing to query
             return wrapperList;
@@ -112,6 +113,7 @@ public class RefNameServiceUtils {
     
     private static String computeWhereClauseForAuthorityRefDocs(
     		String escapedRefName,
+    		String refPropName,
     		ArrayList<String> docTypes,
     		List<ServiceBindingType> servicebindings,
     		Map<String, ServiceBindingType> queriedServiceBindings,
@@ -124,7 +126,7 @@ public class RefNameServiceUtils {
         	// is also the table name, the way that the repository works).
             authRefFieldPaths =
                     ServiceBindingUtils.getAllPartsPropertyValues(sb,
-                    ServiceBindingUtils.AUTH_REF_PROP, ServiceBindingUtils.QUALIFIED_PROP_NAMES);
+                    		refPropName, ServiceBindingUtils.QUALIFIED_PROP_NAMES);
             if (authRefFieldPaths.isEmpty()) {
                 continue;
             }
diff --git a/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml b/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml
index e45cb6845..3f3e15214 100644
--- a/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml
+++ b/services/common/src/main/cspace/config/services/tenants/tenant-bindings-proto.xml
@@ -205,7 +205,6 @@
               <types:value>fieldCollectors|fieldCollector</types:value>
             </types:item>
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>responsibleDepartment|responsibleDepartments</types:value>
@@ -218,7 +217,6 @@
               <types:key>termRef</types:key>
               <types:value>recordStatus</types:value>
             </types:item>
-            -->
             <!-- Commented out for now, as searching within a field in a complexType breaks searches -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -431,7 +429,6 @@
             </types:item>
             -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>entryMethods|entryMethod</types:value>
@@ -452,7 +449,6 @@
               <types:key>termRef</types:key>
               <types:value>conditionCheckReasons|conditionCheckReason</types:value>
             </types:item>
-            -->
             <!-- Commented out for now, as searching within a field in a complexType breaks searches -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -673,12 +669,10 @@
               <types:value>lendersContact</types:value>
             </types:item>
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>loanPurpose</types:value>
             </types:item>
-            -->
             <!-- The following term reference is within a nested complexType / multivalued group of fields -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -749,7 +743,6 @@
               <types:value>depositor</types:value>
             </types:item>
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>exitMethods|exitMethod</types:value>
@@ -758,7 +751,6 @@
               <types:key>termRef</types:key>
               <types:value>exitReason</types:value>
             </types:item>
-            -->
           </service:properties>
           <service:content contentType="application/xml">
             <service:xmlContent namespaceURI="http://collectionspace.org/services/objectexit" schemaLocation="http://collectionspace.org/services/objectexit http://services.collectionspace.org/objectexit/objectexit_common.xsd" />
@@ -843,12 +835,10 @@
               <types:value>owner</types:value>
             </types:item>
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>responsibleDepartment</types:value>
             </types:item>
-            -->
           </service:properties>
           <service:content contentType="application/xml">
             <service:xmlContent namespaceURI="http://collectionspace.org/services/group" schemaLocation="http://collectionspace.org/services/group http://services.collectionspace.org/group/groups_common.xsd" />
@@ -983,16 +973,14 @@
             </types:item>
             -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
-              <types:value>languages|language</types:value>
+              <types:value>languageList|language</types:value>
             </types:item>
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>typeList|type</types:value>
             </types:item>
-            -->
             <!-- The following term references all fall within a nested complexType / multivalued group of fields -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -1070,7 +1058,6 @@
               <types:value>movementContact</types:value>
             </types:item>
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>currentLocationFitness</types:value>
@@ -1083,7 +1070,6 @@
               <types:key>termRef</types:key>
               <types:value>movementMethods|movementMethod</types:value>
             </types:item>
-            -->
           </service:properties>
           <service:content contentType="application/xml">
             <service:xmlContent namespaceURI="http://collectionspace.org/services/movement" schemaLocation="http://collectionspace.org/services/movement http://services.collectionspace.org/movement/movements_common.xsd" />
@@ -1454,12 +1440,10 @@
             </types:item>
             -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>termStatus</types:value>
             </types:item>
-            -->
             <!-- To be added per CSPACE-3939. -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -1834,7 +1818,6 @@
           <service:properties xmlns:service="http://collectionspace.org/services/common/service">
           -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>termStatus</types:value>
@@ -1843,7 +1826,6 @@
               <types:key>termRef</types:key>
               <types:value>locationType</types:value>
             </types:item>
-          -->
           <service:content contentType="application/xml">
             <service:xmlContent namespaceURI="http://collectionspace.org/services/location" schemaLocation="http://collectionspace.org/services/location http://services.collectionspace.org/location/locations_common.xsd" />
           </service:content>
@@ -1980,7 +1962,6 @@
             </types:item>
             -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>termStatus</types:value>
@@ -2001,7 +1982,6 @@
               <types:key>termRef</types:key>
               <types:value>taxonNameSource</types:value>
             </types:item>
-            -->
             <!-- The following term reference falls within a nested complexType / multivalued group of fields -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
@@ -2091,7 +2071,6 @@
             </types:item>
             -->
             <!-- CSPACE-4457: Identification of term list / controlled vocabulary fields -->
-            <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
               <types:key>termRef</types:key>
               <types:value>acquisitionMethod</types:value>
@@ -2116,7 +2095,6 @@
               <types:key>termRef</types:key>
               <types:value>groupPurchasePriceCurrency</types:value>
             </types:item>
-            -->
             <!-- The following term reference falls within a nested complexType / multivalued group of fields -->
             <!--
             <types:item xmlns:types="http://collectionspace.org/services/common/types">
diff --git a/services/common/src/main/java/org/collectionspace/services/common/context/ServiceBindingUtils.java b/services/common/src/main/java/org/collectionspace/services/common/context/ServiceBindingUtils.java
index 051321370..d4b4f0ea2 100644
--- a/services/common/src/main/java/org/collectionspace/services/common/context/ServiceBindingUtils.java
+++ b/services/common/src/main/java/org/collectionspace/services/common/context/ServiceBindingUtils.java
@@ -18,6 +18,7 @@ public class ServiceBindingUtils {
 	public static final boolean QUALIFIED_PROP_NAMES = true;
 	public static final boolean UNQUALIFIED_PROP_NAMES = false;
 	public static final String AUTH_REF_PROP = "authRef";
+	public static final String TERM_REF_PROP = "termRef";
 	public static final String OBJ_NUMBER_PROP = "objectNumberProperty";
 	public static final String OBJ_NAME_PROP = "objectNameProperty";
 	public static final String SERVICE_TYPE_PROP = "type";
diff --git a/services/vocabulary/service/src/main/java/org/collectionspace/services/vocabulary/VocabularyResource.java b/services/vocabulary/service/src/main/java/org/collectionspace/services/vocabulary/VocabularyResource.java
index 91fdbaef3..81f16cf70 100644
--- a/services/vocabulary/service/src/main/java/org/collectionspace/services/vocabulary/VocabularyResource.java
+++ b/services/vocabulary/service/src/main/java/org/collectionspace/services/vocabulary/VocabularyResource.java
@@ -24,6 +24,7 @@
 package org.collectionspace.services.vocabulary;
 
 import org.collectionspace.services.client.VocabularyClient;
+import org.collectionspace.services.common.context.ServiceBindingUtils;
 import org.collectionspace.services.common.vocabulary.AuthorityResource;
 import org.collectionspace.services.vocabulary.nuxeo.VocabularyItemDocumentModelHandler;
 import org.slf4j.Logger;
@@ -64,4 +65,14 @@ public class VocabularyResource extends
 		return VocabulariesCommon.class;
 	}
 
+    /**
+     * @return the name of the property used to specify references for items in this type of
+     * authority. For most authorities, it is ServiceBindingUtils.AUTH_REF_PROP ("authRef").
+     * Some types (like Vocabulary) use a separate property.
+     */
+	@Override
+    protected String getRefPropName() {
+    	return ServiceBindingUtils.TERM_REF_PROP;
+    }
+    
 }