BXC-3191 - Refactor/reorganize solr modules (#1283)

* Some initial splitting out of interfaces

* Split up model, request, facet objects. Rename BriefObjectMetadata

* Reorganize rest of solr-search classes, update references

* Rename solr-search and solr-ingest modules

* Update packages in indexing-solr

* Fix name

* Move context file

* Expand cut off facet descriptions

Author: bbpennel

.github/workflows/build.yml

@@ -35,7 +35,7 @@ jobs:
     - name: Build with Maven
       run: mvn -B -U clean install -DskipTests
     - name: Verify DCR modules
-      run: mvn verify -pl common-utils,access,access-common,admin,deposit,fcrepo-clients,metadata,model-api,model-fcrepo,persistence,auth-api,auth-fcrepo,services,services-camel,solr-ingest,solr-search,sword-server,integration
+      run: mvn verify -pl common-utils,access,access-common,admin,deposit,fcrepo-clients,metadata,model-api,model-fcrepo,persistence,auth-api,auth-fcrepo,services,services-camel,search-api,search-solr,indexing-solr,sword-server,integration
 
     - name: Set up nodejs
       uses: actions/setup-node@v2

Makefile

@@ -124,10 +124,10 @@ endif
 SUSPEND = "n"
 
 build-bxc:
-	mvn clean install -DskipTests -pl access,access-common,admin,deposit,fcrepo-clients,metadata,persistence,security,services,services-camel,solr-ingest,solr-search,sword-server,migration-util
+	mvn clean install -DskipTests -pl common-utils,access,access-common,admin,deposit,fcrepo-clients,metadata,model-api,model-fcrepo,persistence,auth-api,auth-fcrepo,services,services-camel,indexing-solr,solr-search,sword-server,integration
 
 verify-bxc:
-	mvn verify -pl access,access-common,admin,deposit,fcrepo-clients,metadata,persistence,security,services,services-camel,solr-ingest,solr-search,sword-server,migration-util
+	mvn verify -pl common-utils,access,access-common,admin,deposit,fcrepo-clients,metadata,model-api,model-fcrepo,persistence,auth-api,auth-fcrepo,services,services-camel,indexing-solr,solr-search,sword-server,integration
 
 ifneq ($(VERSION), "")
 	for i in static/js/public/*.js; do \

access-common/pom.xml

@@ -120,12 +120,12 @@
         </dependency>
         <dependency>
             <groupId>edu.unc.lib.cdr</groupId>
-            <artifactId>solr-ingest</artifactId>
+            <artifactId>indexing-solr</artifactId>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>edu.unc.lib.cdr</groupId>
-            <artifactId>solr-ingest</artifactId>
+            <artifactId>indexing-solr</artifactId>
             <scope>test</scope>
             <type>test-jar</type>
         </dependency>
@@ -191,7 +191,7 @@
         <!-- DCR -->
         <dependency>
             <groupId>edu.unc.lib.cdr</groupId>
-            <artifactId>solr-search</artifactId>
+            <artifactId>search-solr</artifactId>
         </dependency>
         <dependency>
             <groupId>edu.unc.lib.cdr</groupId>

solr-search/src/main/java/edu/unc/lib/dl/search/solr/service/SearchActionService.java renamed to access-common/src/main/java/edu/unc/lib/boxc/web/common/search/SearchActionService.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package edu.unc.lib.dl.search.solr.service;
+package edu.unc.lib.boxc.web.common.search;
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
@@ -25,9 +25,10 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
-import edu.unc.lib.dl.search.solr.model.SearchState;
-import edu.unc.lib.dl.search.solr.util.FacetFieldUtil;
-import edu.unc.lib.dl.search.solr.util.SearchSettings;
+import edu.unc.lib.boxc.search.api.requests.SearchState;
+import edu.unc.lib.boxc.search.solr.config.SearchSettings;
+import edu.unc.lib.boxc.search.solr.services.SolrSearchService;
+import edu.unc.lib.boxc.search.solr.utils.FacetFieldUtil;
 
 /**
  * Service class which parses and performs any number of actions on a provided SearchState object.

access-common/src/main/java/edu/unc/lib/dl/ui/controller/AbstractSolrSearchController.java

@@ -30,16 +30,16 @@
 
 import edu.unc.lib.boxc.auth.api.models.AccessGroupSet;
 import edu.unc.lib.boxc.auth.fcrepo.services.GroupsThreadStore;
-import edu.unc.lib.dl.search.solr.exception.InvalidHierarchicalFacetException;
-import edu.unc.lib.dl.search.solr.model.HierarchicalBrowseRequest;
-import edu.unc.lib.dl.search.solr.model.SearchRequest;
-import edu.unc.lib.dl.search.solr.model.SearchResultResponse;
-import edu.unc.lib.dl.search.solr.model.SearchState;
-import edu.unc.lib.dl.search.solr.service.ChildrenCountService;
-import edu.unc.lib.dl.search.solr.service.SearchActionService;
-import edu.unc.lib.dl.search.solr.service.SearchStateFactory;
-import edu.unc.lib.dl.search.solr.util.SearchSettings;
-import edu.unc.lib.dl.search.solr.util.SearchStateUtil;
+import edu.unc.lib.boxc.search.api.exceptions.InvalidHierarchicalFacetException;
+import edu.unc.lib.boxc.search.api.requests.HierarchicalBrowseRequest;
+import edu.unc.lib.boxc.search.api.requests.SearchRequest;
+import edu.unc.lib.boxc.search.api.requests.SearchState;
+import edu.unc.lib.boxc.search.solr.config.SearchSettings;
+import edu.unc.lib.boxc.search.solr.responses.SearchResultResponse;
+import edu.unc.lib.boxc.search.solr.services.ChildrenCountService;
+import edu.unc.lib.boxc.search.solr.services.SearchStateFactory;
+import edu.unc.lib.boxc.search.solr.utils.SearchStateUtil;
+import edu.unc.lib.boxc.web.common.search.SearchActionService;
 import edu.unc.lib.dl.ui.service.SolrQueryLayerService;
 import edu.unc.lib.dl.ui.util.SerializationUtil;
 
@@ -52,8 +52,6 @@ public abstract class AbstractSolrSearchController {
 
     @Autowired(required = true)
     protected SolrQueryLayerService queryLayer;
-    //@Autowired(required=true)
-    //protected SearchStateValidator briefSearchRequestValidator;
     @Autowired(required = true)
     protected SearchActionService searchActionService;
     @Autowired

access-common/src/main/java/edu/unc/lib/dl/ui/controller/AbstractStructureResultsController.java

@@ -26,12 +26,13 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 
-import edu.unc.lib.dl.search.solr.exception.InvalidHierarchicalFacetException;
-import edu.unc.lib.dl.search.solr.model.HierarchicalBrowseRequest;
-import edu.unc.lib.dl.search.solr.model.HierarchicalBrowseResultResponse;
-import edu.unc.lib.dl.search.solr.model.SearchState;
-import edu.unc.lib.dl.search.solr.service.StructureQueryService;
-import edu.unc.lib.dl.search.solr.util.SearchFieldKeys;
+import edu.unc.lib.boxc.model.fcrepo.ids.PIDs;
+import edu.unc.lib.boxc.search.api.SearchFieldKey;
+import edu.unc.lib.boxc.search.api.exceptions.InvalidHierarchicalFacetException;
+import edu.unc.lib.boxc.search.api.requests.HierarchicalBrowseRequest;
+import edu.unc.lib.boxc.search.api.requests.SearchState;
+import edu.unc.lib.boxc.search.solr.responses.HierarchicalBrowseResultResponse;
+import edu.unc.lib.boxc.search.solr.services.StructureQueryService;
 
 /**
  * Base structure browse controller.
@@ -78,7 +79,7 @@ protected HierarchicalBrowseResultResponse getStructureResult(String pid, boolea
                     .getParameterMap()));
         }
         if (pid != null) {
-            browseRequest.setRootPid(pid);
+            browseRequest.setRootPid(PIDs.get(pid));
         }
         browseRequest.setIncludeFiles(includeFiles);
 
@@ -90,7 +91,7 @@ protected HierarchicalBrowseResultResponse getStructureResult(String pid, boolea
             LOG.debug("An invalid facet was provided: " + request.getQueryString(), e);
         }
 
-        if (pid == null && !searchState.getFacets().containsKey(SearchFieldKeys.ANCESTOR_PATH.name())) {
+        if (pid == null && !searchState.getFacets().containsKey(SearchFieldKey.ANCESTOR_PATH.name())) {
             browseRequest.setRetrievalDepth(1);
         }
 

access-common/src/main/java/edu/unc/lib/dl/ui/controller/LorisContentController.java

@@ -43,9 +43,8 @@
 import edu.unc.lib.boxc.auth.fcrepo.services.GroupsThreadStore;
 import edu.unc.lib.boxc.model.api.ids.PID;
 import edu.unc.lib.boxc.model.fcrepo.ids.PIDs;
-import edu.unc.lib.dl.search.solr.model.BriefObjectMetadata;
-import edu.unc.lib.dl.search.solr.model.BriefObjectMetadataBean;
-import edu.unc.lib.dl.search.solr.model.SimpleIdRequest;
+import edu.unc.lib.boxc.search.api.models.ContentObjectRecord;
+import edu.unc.lib.boxc.search.api.requests.SimpleIdRequest;
 import edu.unc.lib.dl.ui.service.AccessCopiesService;
 import edu.unc.lib.dl.ui.service.LorisContentService;
 
@@ -164,9 +163,9 @@ public String getCanvas(@PathVariable("id") String id, @PathVariable("datastream
         PID pid = PIDs.get(id);
         // Check if the user is allowed to view this object's manifest
         if (this.hasAccess(pid, datastream)) {
-            SimpleIdRequest idRequest = new SimpleIdRequest(id, GroupsThreadStore
+            SimpleIdRequest idRequest = new SimpleIdRequest(pid, GroupsThreadStore
                     .getAgentPrincipals().getPrincipals());
-            BriefObjectMetadataBean briefObj = queryLayer.getObjectById(idRequest);
+            ContentObjectRecord briefObj = queryLayer.getObjectById(idRequest);
             response.addHeader("Access-Control-Allow-Origin", "*");
             return lorisContentService.getCanvas(request, briefObj);
         } else {
@@ -191,7 +190,7 @@ public String getSequence(@PathVariable("id") String id, @PathVariable("datastre
         PID pid = PIDs.get(id);
         // Check if the user is allowed to view this object's manifest
         if (this.hasAccess(pid, datastream)) {
-            List<BriefObjectMetadata> briefObjs = getDatastreams(pid);
+            List<ContentObjectRecord> briefObjs = getDatastreams(pid);
             response.addHeader("Access-Control-Allow-Origin", "*");
             return lorisContentService.getSequence(request, briefObjs);
         } else {
@@ -217,7 +216,7 @@ public String getManifest(@PathVariable("id") String id, @PathVariable("datastre
         // Check if the user is allowed to view this object's manifest
         if (this.hasAccess(pid, datastream)) {
             try {
-                List<BriefObjectMetadata> briefObjs = getDatastreams(pid);
+                List<ContentObjectRecord> briefObjs = getDatastreams(pid);
                 if (briefObjs.size() == 0) {
                     response.setStatus(HttpStatus.NOT_FOUND.value());
                 } else {
@@ -235,7 +234,7 @@ public String getManifest(@PathVariable("id") String id, @PathVariable("datastre
         return "";
     }
 
-    private List<BriefObjectMetadata> getDatastreams(PID pid) {
+    private List<ContentObjectRecord> getDatastreams(PID pid) {
         AgentPrincipals agent = AgentPrincipalsImpl.createFromThread();
         return accessCopiesService.listViewableFiles(pid, agent.getPrincipals());
     }

access-common/src/main/java/edu/unc/lib/dl/ui/controller/structure/StructureResultsController.java

@@ -30,9 +30,10 @@
 
 import edu.unc.lib.boxc.auth.api.models.AccessGroupSet;
 import edu.unc.lib.boxc.auth.fcrepo.services.GroupsThreadStore;
-import edu.unc.lib.dl.search.solr.model.BriefObjectMetadataBean;
-import edu.unc.lib.dl.search.solr.model.HierarchicalBrowseResultResponse;
-import edu.unc.lib.dl.search.solr.model.SimpleIdRequest;
+import edu.unc.lib.boxc.model.fcrepo.ids.PIDs;
+import edu.unc.lib.boxc.search.api.models.ContentObjectRecord;
+import edu.unc.lib.boxc.search.api.requests.SimpleIdRequest;
+import edu.unc.lib.boxc.search.solr.responses.HierarchicalBrowseResultResponse;
 import edu.unc.lib.dl.ui.controller.AbstractStructureResultsController;
 import edu.unc.lib.dl.ui.exception.ResourceNotFoundException;
 import edu.unc.lib.dl.ui.util.SerializationUtil;
@@ -99,8 +100,8 @@ String getStructureJSON(@PathVariable("pid") String pid,
 
         AccessGroupSet principals = getAgentPrincipals().getPrincipals();
         // Get the parent pid for the selected object and get its structure view
-        BriefObjectMetadataBean selectedContainer = queryLayer.getObjectById(
-                new SimpleIdRequest(pid, tierResultFieldsList, principals));
+        ContentObjectRecord selectedContainer = queryLayer.getObjectById(
+                new SimpleIdRequest(PIDs.get(pid), tierResultFieldsList, principals));
         if (selectedContainer == null) {
             throw new ResourceNotFoundException("Object " + pid + " was not found.");
         }

access-common/src/main/java/edu/unc/lib/dl/ui/service/AccessCopiesService.java

@@ -28,16 +28,16 @@
 import edu.unc.lib.boxc.auth.api.services.GlobalPermissionEvaluator;
 import edu.unc.lib.boxc.model.api.DatastreamType;
 import edu.unc.lib.boxc.model.api.ids.PID;
-import edu.unc.lib.dl.search.solr.exception.SolrRuntimeException;
-import edu.unc.lib.dl.search.solr.model.BriefObjectMetadata;
-import edu.unc.lib.dl.search.solr.model.BriefObjectMetadataBean;
-import edu.unc.lib.dl.search.solr.model.CutoffFacet;
-import edu.unc.lib.dl.search.solr.model.Datastream;
-import edu.unc.lib.dl.search.solr.model.SearchRequest;
-import edu.unc.lib.dl.search.solr.model.SearchState;
-import edu.unc.lib.dl.search.solr.model.SimpleIdRequest;
-import edu.unc.lib.dl.search.solr.service.SolrSearchService;
-import edu.unc.lib.dl.search.solr.util.SearchFieldKeys;
+import edu.unc.lib.boxc.search.api.SearchFieldKey;
+import edu.unc.lib.boxc.search.api.exceptions.SolrRuntimeException;
+import edu.unc.lib.boxc.search.api.facets.CutoffFacet;
+import edu.unc.lib.boxc.search.api.models.ContentObjectRecord;
+import edu.unc.lib.boxc.search.api.models.Datastream;
+import edu.unc.lib.boxc.search.api.requests.SearchRequest;
+import edu.unc.lib.boxc.search.api.requests.SearchState;
+import edu.unc.lib.boxc.search.api.requests.SimpleIdRequest;
+import edu.unc.lib.boxc.search.solr.models.ContentObjectSolrRecord;
+import edu.unc.lib.boxc.search.solr.services.SolrSearchService;
 
 /**
  * Service to check for or list resources with access copies
@@ -55,8 +55,8 @@ public class AccessCopiesService extends SolrSearchService {
      * @return
      */
     @SuppressWarnings("unchecked")
-    public List<BriefObjectMetadata> listViewableFiles(PID pid, AccessGroupSet principals) {
-        BriefObjectMetadata briefObj = getObjectById(new SimpleIdRequest(pid, principals));
+    public List<ContentObjectRecord> listViewableFiles(PID pid, AccessGroupSet principals) {
+        ContentObjectRecord briefObj = getObjectById(new SimpleIdRequest(pid, principals));
         String resourceType = briefObj.getResourceType();
         if (searchSettings.resourceTypeFile.equals(resourceType)) {
             if (briefObj.getDatastreamObject(DatastreamType.JP2_ACCESS_COPY.getId()) != null) {
@@ -70,8 +70,8 @@ public List<BriefObjectMetadata> listViewableFiles(PID pid, AccessGroupSet princ
         }
 
         QueryResponse resp = performQuery(briefObj, principals, MAX_FILES);
-        List<?> results = resp.getBeans(BriefObjectMetadataBean.class);
-        List<BriefObjectMetadata> mdObjs = (List<BriefObjectMetadata>) results;
+        List<?> results = resp.getBeans(ContentObjectSolrRecord.class);
+        List<ContentObjectRecord> mdObjs = (List<ContentObjectRecord>) results;
         mdObjs.add(0, briefObj);
         return mdObjs;
     }
@@ -83,7 +83,7 @@ public List<BriefObjectMetadata> listViewableFiles(PID pid, AccessGroupSet princ
      * @param principals
      * @return
      */
-    public boolean hasViewableFiles(BriefObjectMetadata briefObj, AccessGroupSet principals) {
+    public boolean hasViewableFiles(ContentObjectRecord briefObj, AccessGroupSet principals) {
         String resourceType = briefObj.getResourceType();
         if (searchSettings.resourceTypeFile.equals(resourceType)) {
             Datastream datastream = briefObj.getDatastreamObject(DatastreamType.JP2_ACCESS_COPY.getId());
@@ -97,7 +97,7 @@ public boolean hasViewableFiles(BriefObjectMetadata briefObj, AccessGroupSet pri
         return resp.getResults().getNumFound() > 0;
     }
 
-    private QueryResponse performQuery(BriefObjectMetadata briefObj, AccessGroupSet principals, int rows) {
+    private QueryResponse performQuery(ContentObjectRecord briefObj, AccessGroupSet principals, int rows) {
         // Search for child objects with jp2 datastreams with user can access
         SearchState searchState = new SearchState();
         if (!globalPermissionEvaluator.hasGlobalPrincipal(principals)) {
@@ -111,7 +111,7 @@ private QueryResponse performQuery(BriefObjectMetadata briefObj, AccessGroupSet
 
         SearchRequest searchRequest = new SearchRequest(searchState, principals);
         SolrQuery query = generateSearch(searchRequest);
-        query.addFilterQuery(solrSettings.getFieldName(SearchFieldKeys.DATASTREAM.name()) + ":"
+        query.addFilterQuery(solrSettings.getFieldName(SearchFieldKey.DATASTREAM.name()) + ":"
                 + DatastreamType.JP2_ACCESS_COPY.getId() + "|*");
 
         try {