Merge pull request DSpace#9243 from atmire/atmire-index-discovery-by-…

…type Alteration to index-discovery script to only (re-)index specific type of IndexableObject
TexasDigitalLibrary · Jan 31, 2024 · 9cbfad4 · 9cbfad4
2 parents 02f4095 + 95714fb
commit 9cbfad4
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java
@@ -7,14 +7,20 @@
  */
 package org.dspace.discovery;
 
+import static org.dspace.discovery.IndexClientOptions.TYPE_OPTION;
+
 import java.io.IOException;
 import java.sql.SQLException;
+import java.util.Arrays;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
+import java.util.stream.Collectors;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.ParseException;
+import org.apache.commons.lang3.StringUtils;
 import org.dspace.content.Collection;
 import org.dspace.content.Community;
 import org.dspace.content.DSpaceObject;
@@ -51,6 +57,17 @@ public void internalRun() throws Exception {
             return;
         }
 
+        String type = null;
+        if (commandLine.hasOption(TYPE_OPTION)) {
+            List<String> indexableObjectTypes = IndexObjectFactoryFactory.getInstance().getIndexFactories().stream()
+                    .map((indexFactory -> indexFactory.getType())).collect(Collectors.toList());
+            type = commandLine.getOptionValue(TYPE_OPTION);
+            if (!indexableObjectTypes.contains(type)) {
+                handler.handleException(String.format("%s is not a valid indexable object type, options: %s",
+                        type, Arrays.toString(indexableObjectTypes.toArray())));
+            }
+        }
+
         /** Acquire from dspace-services in future */
         /**
          * new DSpace.getServiceManager().getServiceByName("org.dspace.discovery.SolrIndexer");
@@ -113,6 +130,10 @@ public void internalRun() throws Exception {
         } else if (indexClientOptions == IndexClientOptions.BUILD ||
             indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
             handler.logInfo("(Re)building index from scratch.");
+            if (StringUtils.isNotBlank(type)) {
+                handler.logWarning(String.format("Type option, %s, not applicable for entire index rebuild option, b" +
+                        ", type will be ignored", TYPE_OPTION));
+            }
             indexer.deleteIndex();
             indexer.createIndex(context);
             if (indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
@@ -133,14 +154,14 @@ public void internalRun() throws Exception {
         } else if (indexClientOptions == IndexClientOptions.UPDATE ||
             indexClientOptions == IndexClientOptions.UPDATEANDSPELLCHECK) {
             handler.logInfo("Updating Index");
-            indexer.updateIndex(context, false);
+            indexer.updateIndex(context, false, type);
             if (indexClientOptions == IndexClientOptions.UPDATEANDSPELLCHECK) {
                 checkRebuildSpellCheck(commandLine, indexer);
             }
         } else if (indexClientOptions == IndexClientOptions.FORCEUPDATE ||
             indexClientOptions == IndexClientOptions.FORCEUPDATEANDSPELLCHECK) {
             handler.logInfo("Updating Index");
-            indexer.updateIndex(context, true);
+            indexer.updateIndex(context, true, type);
             if (indexClientOptions == IndexClientOptions.FORCEUPDATEANDSPELLCHECK) {
                 checkRebuildSpellCheck(commandLine, indexer);
             }

diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClientOptions.java
@@ -8,8 +8,13 @@
 
 package org.dspace.discovery;
 
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Options;
+import org.dspace.discovery.indexobject.factory.IndexObjectFactoryFactory;
 
 /**
  * This Enum holds all the possible options and combinations for the Index discovery script
@@ -29,6 +34,8 @@ public enum IndexClientOptions {
     FORCEUPDATEANDSPELLCHECK,
     HELP;
 
+    public static final String TYPE_OPTION = "t";
+
     /**
      * This method resolves the CommandLine parameters to figure out which action the index-discovery script should
      * perform
@@ -71,11 +78,15 @@ protected static IndexClientOptions getIndexClientOption(CommandLine commandLine
 
     protected static Options constructOptions() {
         Options options = new Options();
+        List<String> indexableObjectTypes = IndexObjectFactoryFactory.getInstance().getIndexFactories().stream()
+                .map((indexFactory -> indexFactory.getType())).collect(Collectors.toList());
 
         options
             .addOption("r", "remove", true, "remove an Item, Collection or Community from index based on its handle");
         options.addOption("i", "index", true,
                           "add or update an Item, Collection or Community based on its handle or uuid");
+        options.addOption(TYPE_OPTION, "type", true, "reindex only specific type of " +
+                "(re)indexable objects; options: " + Arrays.toString(indexableObjectTypes.toArray()));
         options.addOption("c", "clean", false,
                           "clean existing index removing any documents that no longer exist in the db");
         options.addOption("d", "delete", false,