Switch to using SearchFieldKey.getSolrName instead of using properties file lookups. Switch to using constants for a few other things that came from solr.properties (#1344)

Author: bbpennel

indexing-solr/src/main/java/edu/unc/lib/boxc/indexing/solr/action/DeleteSolrTreeAction.java

@@ -56,12 +56,12 @@ public void performAction(SolrUpdateRequest updateRequest) throws IndexingExcept
 
             // Delete the container itself
             solrUpdateDriver.deleteByQuery(
-                    solrSettings.getFieldName(SearchFieldKey.ID.name()) + ":"
+                    SearchFieldKey.ID.getSolrField() + ":"
                             + SolrSettings.sanitize(updateRequest.getTargetID()));
 
             // Delete the containers contents
             solrUpdateDriver.deleteByQuery(
-                    solrSettings.getFieldName(SearchFieldKey.ANCESTOR_PATH.name())
+                    SearchFieldKey.ANCESTOR_PATH.getSolrField()
                             + ":" + SolrSettings.sanitize(ancestorPathBean.getPath().getSearchValue()));
         } else {
             // Targeting an individual file, just delete it.

indexing-solr/src/main/java/edu/unc/lib/boxc/indexing/solr/action/DeleteStaleChildren.java

@@ -64,12 +64,12 @@ public void performAction(SolrUpdateRequest updateRequest) throws IndexingExcept
                 ContentObjectRecord ancestorPathBean = getRootAncestorPath(updateRequest);
 
                 // Limit cleanup scope to root pid
-                query.append(solrSettings.getFieldName(SearchFieldKey.ANCESTOR_PATH.name())).append(':')
+                query.append(SearchFieldKey.ANCESTOR_PATH.getSolrField()).append(':')
                         .append(SolrSettings.sanitize(ancestorPathBean.getPath().getSearchValue()));
             }
 
             // Target any children with timestamp older than start time.
-            query.append(" AND ").append(solrSettings.getFieldName(SearchFieldKey.TIMESTAMP.name()))
+            query.append(" AND ").append(SearchFieldKey.TIMESTAMP.getSolrField())
                     .append(":{* TO ").append(staleTimestamp).append("}");
 
             solrUpdateDriver.deleteByQuery(query.toString());

indexing-solr/src/test/resources/solr.properties

@@ -3,50 +3,4 @@ solr.socketTimeout=10000
 solr.connectionTimeout=10000
 solr.defaultMaxConnectionsPerHost=100
 solr.maxConnections=100
-solr.maxRetries=3
-solr.requiredFields=adminGroup,id,readGroup,resourceType,roleGroup,rollup,title
-#Solr field names
-solr.field.SCORE=score
-solr.field.ID=id
-solr.field.ANCESTOR_PATH=ancestorPath
-solr.field.ANCESTOR_NAMES=ancestorNames
-solr.field.ROLE_GROUP=roleGroup
-solr.field.READ_GROUP=readGroup
-solr.field.ADMIN_GROUP=adminGroup
-solr.field.STATUS=status
-solr.field.RESOURCE_TYPE=resourceType
-solr.field.RESOURCE_TYPE_SORT=resourceTypeSort
-solr.field.DISPLAY_ORDER=displayOrder
-solr.field.CONTENT_TYPE=contentType
-solr.field.DATASTREAM=datastream
-solr.field.PARENT_COLLECTION=parentCollection
-solr.field.TITLE=title
-solr.field.TITLE_LC=title_lc
-solr.field.ABSTRACT=abstract
-solr.field.COLLECTION_ID=collectionId
-solr.field.LABEL=label
-solr.field.KEYWORD=keyword
-solr.field.SUBJECT=subject
-solr.field.LANGUAGE=language
-solr.field.CREATOR=creator
-solr.field.CREATOR_SORT=creatorSort
-solr.field.CONTRIBUTOR=contributor
-solr.field.DEPARTMENT=department
-solr.field.CITATION=citation
-solr.field.DATE_CREATED=dateCreated
-solr.field.DATE_ADDED=dateAdded
-solr.field.DATE_UPDATED=dateUpdated
-solr.field.FULL_TEXT=fullText
-solr.field.ROLLUP_ID=rollup
-solr.field.SCOPE=scope
-solr.field.RELATIONS=relations
-solr.field.CONTENT_MODEL=contentModel
-solr.field.TIMESTAMP=timestamp
-solr.field.LAST_INDEXED=lastIndexed
-solr.field.FILESIZE=filesizeSort
-solr.field.FILESIZE_TOTAL=filesizeTotal
-solr.field.DEFAULT_INDEX=text
-solr.field.TITLE_INDEX=titleIndex
-solr.field.CONTRIBUTOR_INDEX=contributorIndex
-solr.field.SUBJECT_INDEX=subjectIndex
-solr.field.VERSION=_version_
+solr.maxRetries=3

integration/src/test/resources/solr.properties

@@ -1,60 +1,9 @@
-solr.reservedCharacters=+-!(){}[]^"~*?:\\
 solr.core=access
 solr.socketTimeout=40000
 solr.connectionTimeout=20000
 solr.defaultMaxConnectionsPerHost=100
 solr.maxConnections=100
 solr.maxRetries=1
-solr.requiredFields=adminGroup,id,readGroup,resourceType,roleGroup,rollup,title
-#Solr field names
-solr.field.SCORE=score
-solr.field.ID=id
-solr.field.ANCESTOR_PATH=ancestorPath
-solr.field.ANCESTOR_IDS=ancestorIds
-solr.field.ROLE_GROUP=roleGroup
-solr.field.READ_GROUP=readGroup
-solr.field.ADMIN_GROUP=adminGroup
-solr.field.STATUS=status
-solr.field.CONTENT_STATUS=contentStatus
-solr.field.RESOURCE_TYPE=resourceType
-solr.field.RESOURCE_TYPE_SORT=resourceTypeSort
-solr.field.DISPLAY_ORDER=displayOrder
-solr.field.CONTENT_TYPE=contentType
-solr.field.DATASTREAM=datastream
-solr.field.PARENT_COLLECTION=parentCollection
-solr.field.TITLE=title
-solr.field.TITLE_LC=title_lc
-solr.field.LABEL=label
-solr.field.ABSTRACT=abstract
-solr.field.COLLECTION_ID=collectionId
-solr.field.KEYWORD=keyword
-solr.field.SUBJECT=subject
-solr.field.LANGUAGE=language
-solr.field.CREATOR=creator
-solr.field.CREATOR_SORT=creatorSort
-solr.field.NAME=name
-solr.field.CONTRIBUTOR=contributor
-solr.field.DEPARTMENT=department
-solr.field.DEPARTMENT_LC=department_lc
-solr.field.IDENTIFIER=identifier
-solr.field.IDENTIFIER_SORT=identifierSort
-solr.field.CITATION=citation
-solr.field.DATE_CREATED=dateCreated
-solr.field.DATE_ADDED=dateAdded
-solr.field.DATE_UPDATED=dateUpdated
-solr.field.FULL_TEXT=fullText
-solr.field.ROLLUP_ID=rollup
-solr.field.SCOPE=scope
-solr.field.RELATIONS=relations
-solr.field.CONTENT_MODEL=contentModel
-solr.field.TIMESTAMP=timestamp
-solr.field.LAST_INDEXED=lastIndexed
-solr.field.FILESIZE=filesizeSort
-solr.field.FILESIZE_TOTAL=filesizeTotal
-solr.field.DEFAULT_INDEX=text
-solr.field.TITLE_INDEX=titleIndex
-solr.field.CONTRIBUTOR_INDEX=contributorIndex
-solr.field.SUBJECT_INDEX=subjectIndex
 #Dynamic fields
 solr.field.RLA_SITE_CODE=rla_site_code_d
 solr.field.RLA_CATALOG_NUMBER=rla_catalog_number_d

search-api/src/main/java/edu/unc/lib/boxc/search/api/SearchFieldKey.java

@@ -15,6 +15,11 @@
  */
 package edu.unc.lib.boxc.search.api;
 
+import java.util.Arrays;
+import java.util.Map;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
 /**
  *
  * @author bbpennel
@@ -63,6 +68,8 @@ public enum SearchFieldKey {
     RESOURCE_TYPE_SORT("resourceTypeSort"),
     ROLE_GROUP("roleGroup"),
     ROLLUP_ID("rollup"),
+    SCOPE("scope"),
+    SCORE("score"),
     STATUS("status"),
     SUBJECT("subject"),
     SUBJECT_INDEX("subjectIndex"),
@@ -74,6 +81,9 @@ public enum SearchFieldKey {
 
     private final String solrField;
 
+    private static Map<String, SearchFieldKey> nameToKey = Arrays.stream(SearchFieldKey.values())
+            .collect(Collectors.toMap(SearchFieldKey::getSolrField, Function.identity()));
+
     private SearchFieldKey(String solrField) {
         this.solrField = solrField;
     }
@@ -85,4 +95,12 @@ private SearchFieldKey(String solrField) {
     public String getSolrField() {
         return solrField;
     }
+
+    /**
+     * @param name
+     * @return the SearchFieldKey which has a solr field name matching the provided value
+     */
+    public static SearchFieldKey getByName(String name) {
+        return nameToKey.get(name);
+    }
 }

search-solr/src/main/java/edu/unc/lib/boxc/search/solr/config/SolrSettings.java

@@ -15,18 +15,20 @@
  */
 package edu.unc.lib.boxc.search.solr.config;
 
+import edu.unc.lib.boxc.search.api.SearchFieldKey;
+import org.apache.solr.client.solrj.SolrClient;
+import org.apache.solr.client.solrj.impl.HttpSolrClient;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.apache.solr.client.solrj.SolrClient;
-import org.apache.solr.client.solrj.impl.HttpSolrClient;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * Utility class which stores Solr index addressing and instantiation settings from a properties file.
  *
@@ -43,10 +45,13 @@ public class SolrSettings extends AbstractSettings {
     private int maxConnections;
     private int maxRetries;
     // Mapping of field keys to internal solr field names
-    private HashMap<String, String> fieldNames;
+    private Map<String, String> fieldNames;
     // Reverse of fieldName, for translating from the internal solr field name to the general field identification key
-    private HashMap<String, String> fieldNameToKey;
-    private String[] requiredFields;
+    private Map<String, String> fieldNameToKey;
+    private String[] requiredFields = new String[] {
+            SearchFieldKey.ADMIN_GROUP.getSolrField(), SearchFieldKey.ID.getSolrField(),
+            SearchFieldKey.RESOURCE_TYPE.getSolrField(), SearchFieldKey.ROLE_GROUP.getSolrField(),
+            SearchFieldKey.ROLLUP_ID.getSolrField(), SearchFieldKey.TITLE.getSolrField() };
 
     public SolrSettings() {
         fieldNames = new HashMap<>();
@@ -62,7 +67,6 @@ public void setProperties(Properties properties) {
         LOG.debug("Setting properties.");
         this.setPath(properties.getProperty("solr.path", ""));
         this.setCore(properties.getProperty("solr.core", ""));
-        this.setRequiredFields(properties.getProperty("solr.requiredFields", ""));
         this.setSocketTimeout(Integer.parseInt(properties.getProperty("solr.socketTimeout", "1000")));
         this.setConnectionTimeout(Integer.parseInt(properties.getProperty("solr.connectionTimeout", "100")));
         this.setDefaultMaxConnectionsPerHost(Integer.parseInt(properties.getProperty(
@@ -175,10 +179,6 @@ public String[] getRequiredFields() {
         return requiredFields;
     }
 
-    public void setRequiredFields(String requiredFields) {
-        this.requiredFields = requiredFields.split(",");
-    }
-
     public int getSocketTimeout() {
         return socketTimeout;
     }
@@ -232,38 +232,15 @@ public String toStringStatic() {
     }
 
     /**
-     * Returns the field identification key for the internal solr field name given
+     * Returns the dynamic field identification key for the internal solr field name given
      *
      * @param name
      * @return
      */
-    public String getFieldKey(String name) {
+    public String getDynamicFieldKey(String name) {
         return fieldNameToKey.get(name);
     }
 
-    public HashMap<String, String> getFieldNameToKey() {
-        return this.fieldNameToKey;
-    }
-
-    /**
-     * Returns the internal solr field name for the field identified by key
-     *
-     * @param key
-     * @return
-     */
-    public String getFieldName(String key) {
-        return fieldNames.get(key);
-    }
-
-    public HashMap<String, String> getFieldNames() {
-        return fieldNames;
-    }
-
-    public void setFieldNames(HashMap<String, String> fieldNames) {
-        this.fieldNames = fieldNames;
-        fieldNameToKey = getInvertedHashMap(fieldNames);
-    }
-
     public int getMaxRetries() {
         return maxRetries;
     }

search-solr/src/main/java/edu/unc/lib/boxc/search/solr/services/AbstractQueryService.java

@@ -153,7 +153,7 @@ protected void addSort(SolrQuery solrQuery, String sortType, boolean normalOrder
                 if (!normalOrder) {
                     sortOrder = sortOrder.reverse();
                 }
-                solrQuery.addSort(solrSettings.getFieldName(sortField.getFieldName()), sortOrder);
+                solrQuery.addSort(SearchFieldKey.valueOf(sortField.getFieldName()).getSolrField(), sortOrder);
             }
         }
     }
@@ -169,9 +169,9 @@ protected void addResultFields(List<String> resultFields, SolrQuery solrQuery) {
             resultFields = DEFAULT_RESULT_FIELDS;
         }
         for (String field : resultFields) {
-            String solrFieldName = solrSettings.getFieldName(field);
-            if (solrFieldName != null) {
-                solrQuery.addField(solrFieldName);
+            var solrField = SearchFieldKey.valueOf(field);
+            if (solrField != null) {
+                solrQuery.addField(solrField.getSolrField());
             }
         }
     }
@@ -183,7 +183,7 @@ protected void addResultFields(List<String> resultFields, SolrQuery solrQuery) {
      * @return
      */
     public String solrField(SearchFieldKey fieldKey) {
-        return solrSettings.getFieldName(fieldKey.name());
+        return fieldKey.getSolrField();
     }
 
     /**

search-solr/src/main/java/edu/unc/lib/boxc/search/solr/services/FacetFieldFactory.java

@@ -20,8 +20,8 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
-import java.util.Map;
 
+import edu.unc.lib.boxc.search.api.SearchFieldKey;
 import org.apache.solr.client.solrj.response.FacetField;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -89,11 +89,9 @@ public FacetFieldList createFacetFieldList(List<FacetField> facetFields) {
         if (facetFields == null) {
             return null;
         }
-        Map<String, String> fieldNameMappings = solrSettings.getFieldNameToKey();
-
         FacetFieldList facetFieldList = new FacetFieldList();
         for (FacetField facetField : facetFields) {
-            String fieldName = fieldNameMappings.get(facetField.getName());
+            String fieldName = SearchFieldKey.getByName(facetField.getName()).name();
             if (facetField.getValueCount() > 0) {
                 facetFieldList.add(createFacetFieldObject(fieldName, facetField));
             }

search-solr/src/main/java/edu/unc/lib/boxc/search/solr/services/GetCollectionIdService.java

@@ -72,8 +72,8 @@ private String findFirstCollectionId(ContentObjectRecord mdObj) {
         List<String> ancestors = mdObj.getAncestorPath();
         int index = ancestors.size();
 
-        String idFieldName = solrSettings.getFieldName(SearchFieldKey.ID.name());
-        String collectionIdName = solrSettings.getFieldName(SearchFieldKey.COLLECTION_ID.name());
+        String idFieldName = SearchFieldKey.ID.getSolrField();
+        String collectionIdName = SearchFieldKey.COLLECTION_ID.getSolrField();
 
         while (--index >= ContentPathConstants.COLLECTION_DEPTH) {
             String nextId = StringUtils.substringAfter(ancestors.get(index), ",");

search-solr/src/main/java/edu/unc/lib/boxc/search/solr/services/ObjectPathFactory.java

@@ -72,9 +72,9 @@ public void init() {
         mapBuilder.maximumWeightedCapacity(cacheSize);
         this.pathCache = mapBuilder.build();
 
-        titleFieldName = solrSettings.getFieldName(SearchFieldKey.TITLE.name());
-        typeFieldName = solrSettings.getFieldName(SearchFieldKey.RESOURCE_TYPE.name());
-        collectionId = solrSettings.getFieldName(SearchFieldKey.COLLECTION_ID.name());
+        titleFieldName = SearchFieldKey.TITLE.getSolrField();
+        typeFieldName = SearchFieldKey.RESOURCE_TYPE.getSolrField();
+        collectionId = SearchFieldKey.COLLECTION_ID.getSolrField();
         pathFields = Arrays.asList(titleFieldName, typeFieldName);
         startObjectFields = Arrays.asList(SearchFieldKey.ID.name(),
                 SearchFieldKey.TITLE.name(), SearchFieldKey.RESOURCE_TYPE.name(),