From: Patrick Schmitz <pschmitz@berkeley.edu>
Date: Fri, 22 Jul 2011 22:34:43 +0000 (+0000)
Subject: CSPACE-3332, CSPACE-3784 Updated Blob, Media, and Group to use shared subclasses... 
X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=b8281c89bd161fc338332494f2160ced26fead88;p=tmp%2Fjakarta-migration.git

CSPACE-3332, CSPACE-3784 Updated Blob, Media, and Group to use shared subclasses for AbstractCommonList support. These were already using AbstractCommonList, but benefited from new base classes to remove some code.
---

diff --git a/services/batch/client/src/main/java/org/collectionspace/services/client/BatchClient.java b/services/batch/client/src/main/java/org/collectionspace/services/client/BatchClient.java
index 48d7b0f20..ee7e28f20 100644
--- a/services/batch/client/src/main/java/org/collectionspace/services/client/BatchClient.java
+++ b/services/batch/client/src/main/java/org/collectionspace/services/client/BatchClient.java
@@ -45,13 +45,4 @@ public class BatchClient extends AbstractCommonListPoxServiceClientImpl<BatchPro
 		return BatchProxy.class;
 	}
 
-	/*
-	 * Proxied service calls.
-	 * 
-	
-    public BatchCommonList readList2(){
-        BatchCommonList list = readList().getEntity(BatchCommonList.class);
-        return list;
-    }
-	 */
 }
diff --git a/services/blob/client/src/main/java/org/collectionspace/services/client/BlobClient.java b/services/blob/client/src/main/java/org/collectionspace/services/client/BlobClient.java
index 1a753ee08..9ab6b1244 100644
--- a/services/blob/client/src/main/java/org/collectionspace/services/client/BlobClient.java
+++ b/services/blob/client/src/main/java/org/collectionspace/services/client/BlobClient.java
@@ -18,7 +18,6 @@ package org.collectionspace.services.client;
 
 import javax.ws.rs.core.Response;
 
-import org.collectionspace.services.jaxb.AbstractCommonList;
 import org.jboss.resteasy.client.ClientResponse;
 import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
 
@@ -29,7 +28,7 @@ import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
  * $LastChangedDate: 2010-05-17 18:25:37 -0700 (Mon, 17 May 2010) $
  *
  */
-public class BlobClient extends AbstractPoxServiceClientImpl<AbstractCommonList, BlobProxy> {
+public class BlobClient extends AbstractCommonListPoxServiceClientImpl<BlobProxy> {
 	public static final String SERVICE_NAME = "blobs";
 	public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME;	
 	public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT;
@@ -59,14 +58,6 @@ public class BlobClient extends AbstractPoxServiceClientImpl<AbstractCommonList,
 	 * Blob proxied service calls
 	 */
 	
-    /**
-     * @return
-     * @see org.collectionspace.services.client.BlobProxy#getBlob()
-     */
-    public ClientResponse<AbstractCommonList> readList() {
-        return getProxy().readList();
-    }
-    
     public ClientResponse<Response> createBlobFromFormData(MultipartFormDataOutput formDataOutput) {
         return getProxy().createBlobFromFormData(formDataOutput);
     }
diff --git a/services/blob/client/src/main/java/org/collectionspace/services/client/BlobProxy.java b/services/blob/client/src/main/java/org/collectionspace/services/client/BlobProxy.java
index 5dc06a0db..7c3e38c55 100644
--- a/services/blob/client/src/main/java/org/collectionspace/services/client/BlobProxy.java
+++ b/services/blob/client/src/main/java/org/collectionspace/services/client/BlobProxy.java
@@ -1,16 +1,12 @@
 package org.collectionspace.services.client;
 
 import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
 
-import org.collectionspace.services.client.workflow.WorkflowClient;
-import org.collectionspace.services.jaxb.AbstractCommonList;
-
 import org.jboss.resteasy.client.ClientResponse;
 import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
 
@@ -21,7 +17,7 @@ import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
 @Path(BlobClient.SERVICE_PATH + "/")
 @Produces("application/xml")
 @Consumes("application/xml")
-public interface BlobProxy extends CollectionSpacePoxProxy<AbstractCommonList> {
+public interface BlobProxy extends CollectionSpaceCommonListPoxProxy {
     //(C)reate
     @POST
     ClientResponse<Response> createBlobFromURI(byte[] xmlPayload, 
@@ -32,21 +28,4 @@ public interface BlobProxy extends CollectionSpacePoxProxy<AbstractCommonList> {
     @Consumes("multipart/form-data")
     ClientResponse<Response> createBlobFromFormData(MultipartFormDataOutput formDataOutput);
         
-    // List
-    @GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> readList();
-    
-    @Override
-	@GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> readIncludeDeleted(
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);    
-
-    @Override
-    @GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> keywordSearchIncludeDeleted(
-    		@QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
 }
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 faccf45bc..6281f22a6 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
@@ -162,14 +162,7 @@
       <service:repositoryDomain xmlns:service="http://collectionspace.org/services/common/service">default-domain</service:repositoryDomain>
       <service:documentHandler xmlns:service="http://collectionspace.org/services/common/service">org.collectionspace.services.blob.nuxeo.BlobDocumentModelHandler</service:documentHandler>
       <service:DocHandlerParams xmlns:service="http://collectionspace.org/services/common/service">
-        <service:classname>org.collectionspace.services.blob.nuxeo.BlobDocumentModelHandler</service:classname>
         <service:params>
-          <service:SchemaName>blobs</service:SchemaName>
-          <service:DublinCoreTitle>blobs</service:DublinCoreTitle>
-          <service:SummaryFields>name|mimeType|encoding|length|uri|csid</service:SummaryFields>
-          <service:AbstractCommonListClassname />
-          <service:CommonListItemClassname />
-          <service:ListResultsItemMethodName>getBlobListItem</service:ListResultsItemMethodName>
           <service:ListResultsFields>
             <service:ListResultField>
               <service:element>name</service:element>
@@ -599,14 +592,7 @@
       <service:repositoryDomain xmlns:service="http://collectionspace.org/services/common/service">default-domain</service:repositoryDomain>
       <service:documentHandler xmlns:service="http://collectionspace.org/services/common/service">org.collectionspace.services.group.nuxeo.GroupDocumentModelHandler</service:documentHandler>
       <service:DocHandlerParams xmlns:service="http://collectionspace.org/services/common/service">
-        <service:classname>org.collectionspace.services.group.nuxeo.GroupDocumentModelHandler</service:classname>
         <service:params>
-          <service:SchemaName>groups</service:SchemaName>
-          <service:DublinCoreTitle>groups</service:DublinCoreTitle>
-          <service:SummaryFields>title|uri|csid</service:SummaryFields>
-          <service:AbstractCommonListClassname />
-          <service:CommonListItemClassname />
-          <service:ListResultsItemMethodName>getGroupListItem</service:ListResultsItemMethodName>
           <service:ListResultsFields>
             <service:ListResultField>
               <service:element>title</service:element>
@@ -695,14 +681,7 @@
       <service:repositoryDomain xmlns:service="http://collectionspace.org/services/common/service">default-domain</service:repositoryDomain>
       <service:documentHandler xmlns:service="http://collectionspace.org/services/common/service">org.collectionspace.services.media.nuxeo.MediaDocumentModelHandler</service:documentHandler>
       <service:DocHandlerParams xmlns:service="http://collectionspace.org/services/common/service">
-        <service:classname>org.collectionspace.services.media.nuxeo.MediaDocumentModelHandler</service:classname>
         <service:params>
-          <service:SchemaName>media</service:SchemaName>
-          <service:DublinCoreTitle>media</service:DublinCoreTitle>
-          <service:SummaryFields>title|source|filename|identificationNumber|blobCsid|uri|csid</service:SummaryFields>
-          <service:AbstractCommonListClassname />
-          <service:CommonListItemClassname />
-          <service:ListResultsItemMethodName>getMediaListItem</service:ListResultsItemMethodName>
           <service:ListResultsFields>
             <service:ListResultField>
               <service:element>title</service:element>
diff --git a/services/group/client/src/main/java/org/collectionspace/services/client/GroupClient.java b/services/group/client/src/main/java/org/collectionspace/services/client/GroupClient.java
index e73ace195..fce1d3404 100644
--- a/services/group/client/src/main/java/org/collectionspace/services/client/GroupClient.java
+++ b/services/group/client/src/main/java/org/collectionspace/services/client/GroupClient.java
@@ -16,9 +16,6 @@
  */
 package org.collectionspace.services.client;
 
-import org.collectionspace.services.jaxb.AbstractCommonList;
-import org.jboss.resteasy.client.ClientResponse;
-
 /**
  * GroupClient.java
  *
@@ -26,7 +23,7 @@ import org.jboss.resteasy.client.ClientResponse;
  * $LastChangedDate: 2010-05-17 18:25:37 -0700 (Mon, 17 May 2010) $
  *
  */
-public class GroupClient extends AbstractPoxServiceClientImpl<AbstractCommonList, GroupProxy> {
+public class GroupClient extends AbstractCommonListPoxServiceClientImpl<GroupProxy> {
 	public static final String SERVICE_NAME = "groups";
 	public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME;	
 	public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT;
@@ -49,12 +46,4 @@ public class GroupClient extends AbstractPoxServiceClientImpl<AbstractCommonList
 		return GroupProxy.class;
 	}
 
-	/*
-	 * Proxied service calls.
-	 * 
-	 */
-	
-    public ClientResponse<AbstractCommonList> readList() {
-        return getProxy().readList();
-    }
 }
diff --git a/services/group/client/src/main/java/org/collectionspace/services/client/GroupProxy.java b/services/group/client/src/main/java/org/collectionspace/services/client/GroupProxy.java
index 610a5a88a..5ec5d71b9 100644
--- a/services/group/client/src/main/java/org/collectionspace/services/client/GroupProxy.java
+++ b/services/group/client/src/main/java/org/collectionspace/services/client/GroupProxy.java
@@ -26,15 +26,9 @@
  */
 package org.collectionspace.services.client;
 
-import org.jboss.resteasy.client.ClientResponse;
 import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
-
-import org.collectionspace.services.client.workflow.WorkflowClient;
-import org.collectionspace.services.jaxb.AbstractCommonList;
 
 /**
  * @version $Revision: 2108 $
@@ -42,21 +36,5 @@ import org.collectionspace.services.jaxb.AbstractCommonList;
 @Path(GroupClient.SERVICE_PATH_PROXY)
 @Produces({"application/xml"})
 @Consumes({"application/xml"})
-public interface GroupProxy extends CollectionSpacePoxProxy<AbstractCommonList> {
-    // List
-    @GET
-    ClientResponse<AbstractCommonList> readList();
-    
-    @Override
-		@GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> readIncludeDeleted(
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
-
-		@Override
-    @GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> keywordSearchIncludeDeleted(
-    		@QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
+public interface GroupProxy extends CollectionSpaceCommonListPoxProxy {
 }
diff --git a/services/group/client/src/test/java/org/collectionspace/services/client/test/GroupServiceTest.java b/services/group/client/src/test/java/org/collectionspace/services/client/test/GroupServiceTest.java
index 97b1abdaf..86b510b5f 100644
--- a/services/group/client/src/test/java/org/collectionspace/services/client/test/GroupServiceTest.java
+++ b/services/group/client/src/test/java/org/collectionspace/services/client/test/GroupServiceTest.java
@@ -32,6 +32,7 @@ import org.collectionspace.services.client.GroupProxy;
 import org.collectionspace.services.client.PayloadOutputPart;
 import org.collectionspace.services.client.PoxPayloadIn;
 import org.collectionspace.services.client.PoxPayloadOut;
+import org.collectionspace.services.common.AbstractCommonListUtils;
 import org.collectionspace.services.jaxb.AbstractCommonList;
 import org.collectionspace.services.group.GroupsCommon;
 
@@ -122,15 +123,8 @@ public class GroupServiceTest extends AbstractServiceTestImpl {
         ClientResponse<AbstractCommonList> res = client.readList();
         AbstractCommonList list = res.getEntity();
         assertStatusCode(res, testName);
-        if (logger.isDebugEnabled()) {
-            List<AbstractCommonList.ListItem> items =
-                list.getListItem();
-            int i = 0;
-            for(AbstractCommonList.ListItem item : items){
-                logger.debug(testName + ": list-item[" + i + "] " +
-                        item.toString());
-                i++;
-            }
+        if(logger.isTraceEnabled()){
+        	AbstractCommonListUtils.ListItemsInAbstractCommonList(list, logger, testName);
         }
     }
 
diff --git a/services/group/jaxb/src/main/resources/groups_common.xsd b/services/group/jaxb/src/main/resources/groups_common.xsd
index 210494178..5e23c3e08 100644
--- a/services/group/jaxb/src/main/resources/groups_common.xsd
+++ b/services/group/jaxb/src/main/resources/groups_common.xsd
@@ -34,14 +34,5 @@
         </xs:complexType>
     </xs:element>
     
-    <!-- This is the base class for paginated lists -->
-    <xs:complexType name="abstractCommonList">
-        <xs:annotation>
-            <xs:appinfo>
-                <jaxb:class ref="org.collectionspace.services.jaxb.AbstractCommonList"/>
-            </xs:appinfo>
-        </xs:annotation>
-    </xs:complexType>
-    
 </xs:schema>
 
diff --git a/services/media/client/src/main/java/org/collectionspace/services/client/MediaClient.java b/services/media/client/src/main/java/org/collectionspace/services/client/MediaClient.java
index 40460cbea..04efdc988 100644
--- a/services/media/client/src/main/java/org/collectionspace/services/client/MediaClient.java
+++ b/services/media/client/src/main/java/org/collectionspace/services/client/MediaClient.java
@@ -20,8 +20,6 @@ import javax.ws.rs.core.Response;
 import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
 import org.jboss.resteasy.client.ClientResponse;
 
-import org.collectionspace.services.jaxb.AbstractCommonList;
-
 /**
  * MediaClient.java
  *
@@ -29,7 +27,7 @@ import org.collectionspace.services.jaxb.AbstractCommonList;
  * $LastChangedDate: 2010-05-17 18:25:37 -0700 (Mon, 17 May 2010) $
  *
  */
-public class MediaClient extends AbstractPoxServiceClientImpl<AbstractCommonList, MediaProxy> {
+public class MediaClient extends AbstractCommonListPoxServiceClientImpl<MediaProxy> {
 	public static final String SERVICE_NAME = "media";
 	public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME;	
 	public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT;
@@ -54,14 +52,6 @@ public class MediaClient extends AbstractPoxServiceClientImpl<AbstractCommonList
 	 * Proxied service calls
 	 */
 
-    /**
-     * @return
-     * @see org.collectionspace.services.client.MediaProxy#getMedia()
-     */
-    public ClientResponse<AbstractCommonList> readList() {
-        return getProxy().readList();
-    }
-        
     /**
      * @param media
      * @return
diff --git a/services/media/client/src/main/java/org/collectionspace/services/client/MediaProxy.java b/services/media/client/src/main/java/org/collectionspace/services/client/MediaProxy.java
index ae38fb098..ea59a91d9 100644
--- a/services/media/client/src/main/java/org/collectionspace/services/client/MediaProxy.java
+++ b/services/media/client/src/main/java/org/collectionspace/services/client/MediaProxy.java
@@ -4,7 +4,6 @@ import org.jboss.resteasy.client.ClientResponse;
 import org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataOutput;
 
 import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
@@ -12,9 +11,7 @@ import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
 
-import org.collectionspace.services.jaxb.AbstractCommonList;
 import org.collectionspace.services.client.BlobClient;
-import org.collectionspace.services.client.workflow.WorkflowClient;
 
 /**
  * @version $Revision: 2108 $
@@ -22,26 +19,8 @@ import org.collectionspace.services.client.workflow.WorkflowClient;
 @Path(MediaClient.SERVICE_PATH + "/")
 @Produces("application/xml")
 @Consumes("application/xml")
-public interface MediaProxy extends CollectionSpacePoxProxy<AbstractCommonList> {
+public interface MediaProxy extends CollectionSpaceCommonListPoxProxy {
 
-    // List
-    @GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> readList();
-    
-    @Override
-	@GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> readIncludeDeleted(
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
-
-    @Override
-    @GET
-    @Produces({"application/xml"})
-    ClientResponse<AbstractCommonList> keywordSearchIncludeDeleted(
-    		@QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
-            @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
-    
     @POST
     @Path("/{csid}")
     @Consumes("multipart/form-data")
diff --git a/services/media/client/src/test/java/org/collectionspace/services/client/test/MediaServiceTest.java b/services/media/client/src/test/java/org/collectionspace/services/client/test/MediaServiceTest.java
index a56d00e74..c9f4c8fdf 100644
--- a/services/media/client/src/test/java/org/collectionspace/services/client/test/MediaServiceTest.java
+++ b/services/media/client/src/test/java/org/collectionspace/services/client/test/MediaServiceTest.java
@@ -34,6 +34,7 @@ import org.collectionspace.services.client.MediaClient;
 import org.collectionspace.services.client.PayloadOutputPart;
 import org.collectionspace.services.client.PoxPayloadIn;
 import org.collectionspace.services.client.PoxPayloadOut;
+import org.collectionspace.services.common.AbstractCommonListUtils;
 import org.collectionspace.services.jaxb.AbstractCommonList;
 import org.collectionspace.services.media.LanguageList;
 import org.collectionspace.services.media.MediaCommon;
@@ -243,15 +244,9 @@ public class MediaServiceTest extends AbstractServiceTestImpl {
         ClientResponse<AbstractCommonList> res = client.readList();
         AbstractCommonList list = res.getEntity();
         assertStatusCode(res, testName);
-        if (logger.isDebugEnabled()) {
-            List<AbstractCommonList.ListItem> items =
-                list.getListItem();
-            int i = 0;
-            for(AbstractCommonList.ListItem item : items){
-                logger.debug(testName + ": list-item[" + i + "] " +
-                        item.toString());
-                i++;
-            }
+        // Optionally output additional data about list members for debugging.
+        if(logger.isTraceEnabled()){
+        	AbstractCommonListUtils.ListItemsInAbstractCommonList(list, logger, testName);
         }
     }
 
diff --git a/services/media/jaxb/src/main/resources/media_common.xsd b/services/media/jaxb/src/main/resources/media_common.xsd
index c804e7131..a0e58ce27 100644
--- a/services/media/jaxb/src/main/resources/media_common.xsd
+++ b/services/media/jaxb/src/main/resources/media_common.xsd
@@ -110,14 +110,5 @@
         </xs:sequence>
     </xs:complexType>
 
-    <!-- This is the base class for paginated lists -->
-    <xs:complexType name="abstractCommonList">
-        <xs:annotation>
-            <xs:appinfo>
-                <jaxb:class ref="org.collectionspace.services.jaxb.AbstractCommonList"/>
-            </xs:appinfo>
-        </xs:annotation>
-    </xs:complexType>
-    
 </xs:schema>