introduce CommandTimeoutType

fixes #3146

Author: Vladimir Kotal

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/CommandTimeoutType.java

@@ -0,0 +1,31 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ */
+
+package org.opengrok.indexer.configuration;
+
+public enum CommandTimeoutType {
+    INTERACTIVE,
+    INDEXER,
+    RESTFUL,
+    WEBAPP_START;
+}

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java

@@ -210,8 +210,10 @@ public final class Configuration {
     private boolean chattyStatusPage;
     private final Map<String, String> cmds;  // repository type -> command
     private int tabSize;
-    private int commandTimeout; // in seconds
+    private int indexerCommandTimeout; // in seconds
     private int interactiveCommandTimeout; // in seconds
+    private int webappStartCommandTimeout; // in seconds
+    private int restfulCommandTimeout; // in seconds
     private long ctagsTimeout; // in seconds
     private boolean scopesEnabled;
     private boolean projectsEnabled;
@@ -373,22 +375,58 @@ public void setNestingMaximum(int nestingMaximum) throws IllegalArgumentExceptio
         this.nestingMaximum = nestingMaximum;
     }
 
-    public int getCommandTimeout() {
-        return commandTimeout;
+    public int getIndexerCommandTimeout() {
+        return indexerCommandTimeout;
     }
 
     /**
      * Set the command timeout to a new value.
      *
-     * @param commandTimeout the new value
+     * @param timeout the new value
+     * @throws IllegalArgumentException when the timeout is negative
+     */
+    public void setIndexerCommandTimeout(int timeout) throws IllegalArgumentException {
+        if (timeout < 0) {
+            throw new IllegalArgumentException(
+                    String.format(NEGATIVE_NUMBER_ERROR, "commandTimeout", timeout));
+        }
+        this.indexerCommandTimeout = timeout;
+    }
+
+    public int getRestfulCommandTimeout() {
+        return restfulCommandTimeout;
+    }
+
+    /**
+     * Set the command timeout to a new value.
+     *
+     * @param timeout the new value
      * @throws IllegalArgumentException when the timeout is negative
      */
-    public void setCommandTimeout(int commandTimeout) throws IllegalArgumentException {
-        if (commandTimeout < 0) {
+    public void setRestfulCommandTimeout(int timeout) throws IllegalArgumentException {
+        if (timeout < 0) {
             throw new IllegalArgumentException(
-                    String.format(NEGATIVE_NUMBER_ERROR, "commandTimeout", commandTimeout));
+                    String.format(NEGATIVE_NUMBER_ERROR, "restfulCommandTimeout", timeout));
         }
-        this.commandTimeout = commandTimeout;
+        this.restfulCommandTimeout = timeout;
+    }
+
+    public int getWebappStartCommandTimeout() {
+        return webappStartCommandTimeout;
+    }
+
+    /**
+     * Set the command timeout to a new value.
+     *
+     * @param timeout the new value
+     * @throws IllegalArgumentException when the timeout is negative
+     */
+    public void setWebappStartCommandTimeout(int timeout) throws IllegalArgumentException {
+        if (timeout < 0) {
+            throw new IllegalArgumentException(
+                    String.format(NEGATIVE_NUMBER_ERROR, "webappStartCommandTimeout", timeout));
+        }
+        this.webappStartCommandTimeout = timeout;
     }
 
     public int getInteractiveCommandTimeout() {
@@ -398,15 +436,15 @@ public int getInteractiveCommandTimeout() {
     /**
      * Set the interactive command timeout to a new value.
      *
-     * @param commandTimeout the new value
+     * @param timeout the new value
      * @throws IllegalArgumentException when the timeout is negative
      */
-    public void setInteractiveCommandTimeout(int commandTimeout) throws IllegalArgumentException {
-        if (commandTimeout < 0) {
+    public void setInteractiveCommandTimeout(int timeout) throws IllegalArgumentException {
+        if (timeout < 0) {
             throw new IllegalArgumentException(
-                    String.format(NEGATIVE_NUMBER_ERROR, "interactiveCommandTimeout", commandTimeout));
+                    String.format(NEGATIVE_NUMBER_ERROR, "interactiveCommandTimeout", timeout));
         }
-        this.interactiveCommandTimeout = commandTimeout;
+        this.interactiveCommandTimeout = timeout;
     }
 
     public long getCtagsTimeout() {
@@ -420,7 +458,7 @@ public long getCtagsTimeout() {
      * @throws IllegalArgumentException when the timeout is negative
      */
     public void setCtagsTimeout(long timeout) throws IllegalArgumentException {
-        if (commandTimeout < 0) {
+        if (timeout < 0) {
             throw new IllegalArgumentException(
                     String.format(NEGATIVE_NUMBER_ERROR, "ctagsTimeout", timeout));
         }
@@ -466,8 +504,10 @@ public Configuration() {
         setBugPattern("\\b([12456789][0-9]{6})\\b");
         setCachePages(5);
         setCanonicalRoots(new HashSet<>());
-        setCommandTimeout(600); // 10 minutes
+        setIndexerCommandTimeout(600); // 10 minutes
+        setRestfulCommandTimeout(60);
         setInteractiveCommandTimeout(30);
+        setWebappStartCommandTimeout(5);
         setCompressXref(true);
         setContextLimit((short) 10);
         //contextSurround is default(short)

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java

@@ -29,6 +29,7 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.security.InvalidParameterException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -170,7 +171,7 @@ private ExecutorService newRevisionExecutor() {
 
     public void shutdownRevisionExecutor() throws InterruptedException {
         getRevisionExecutor().shutdownNow();
-        getRevisionExecutor().awaitTermination(getCommandTimeout(), TimeUnit.SECONDS);
+        getRevisionExecutor().awaitTermination(getIndexerCommandTimeout(), TimeUnit.SECONDS);
     }
 
     /**
@@ -225,29 +226,59 @@ public void setNestingMaximum(int nestingMaximum) {
         syncWriteConfiguration(nestingMaximum, Configuration::setNestingMaximum);
     }
 
-    public int getCommandTimeout() {
-        return syncReadConfiguration(Configuration::getCommandTimeout);
+    public int getCommandTimeout(CommandTimeoutType cmdType) {
+        switch (cmdType) {
+            case INDEXER:
+                return getIndexerCommandTimeout();
+            case INTERACTIVE:
+                return getInteractiveCommandTimeout();
+            case WEBAPP_START:
+                return getWebappStartCommandTimeout();
+            case RESTFUL:
+                return getRestfulCommandTimeout();
+        }
+
+        throw new InvalidParameterException("invalid command timeout type");
+    }
+
+    public int getRestfulCommandTimeout() {
+        return syncReadConfiguration(Configuration::getRestfulCommandTimeout);
+    }
+
+    public void setRestfulCommandTimeout(int timeout) {
+        syncWriteConfiguration(timeout, Configuration::setWebappStartCommandTimeout);
+    }
+
+    public int getWebappStartCommandTimeout() {
+        return syncReadConfiguration(Configuration::getWebappStartCommandTimeout);
+    }
+
+    public void setWebappStartCommandTimeout(int timeout) {
+        syncWriteConfiguration(timeout, Configuration::setWebappStartCommandTimeout);
+    }
+
+    public int getIndexerCommandTimeout() {
+        return syncReadConfiguration(Configuration::getIndexerCommandTimeout);
     }
 
-    public void setCommandTimeout(int commandTimeout) {
-        syncWriteConfiguration(commandTimeout, Configuration::setCommandTimeout);
+    public void setIndexerCommandTimeout(int timeout) {
+        syncWriteConfiguration(timeout, Configuration::setIndexerCommandTimeout);
     }
 
     public int getInteractiveCommandTimeout() {
         return syncReadConfiguration(Configuration::getInteractiveCommandTimeout);
     }
 
-    public void setInteractiveCommandTimeout(int interactiveCommandTimeout) {
-        syncWriteConfiguration(interactiveCommandTimeout,
-                Configuration::setInteractiveCommandTimeout);
+    public void setInteractiveCommandTimeout(int timeout) {
+        syncWriteConfiguration(timeout, Configuration::setInteractiveCommandTimeout);
     }
 
     public long getCtagsTimeout() {
         return syncReadConfiguration(Configuration::getCtagsTimeout);
     }
 
-    public void setCtagsTimeout(long ctagsTimeout) {
-        syncWriteConfiguration(ctagsTimeout, Configuration::setCtagsTimeout);
+    public void setCtagsTimeout(long timeout) {
+        syncWriteConfiguration(timeout, Configuration::setCtagsTimeout);
     }
 
     public void setLastEditedDisplayMode(boolean lastEditedDisplayMode) {
@@ -1326,12 +1357,12 @@ public void readConfiguration(File file) throws IOException {
     /**
      * Read configuration from a file and put it into effect.
      * @param file the file to read
-     * @param interactive true if run in interactive mode
+     * @param cmdType command timeout type
      * @throws IOException I/O
      */
-    public void readConfiguration(File file, boolean interactive) throws IOException {
+    public void readConfiguration(File file, CommandTimeoutType cmdType) throws IOException {
         // The following method handles the locking.
-        setConfiguration(Configuration.read(file), null, interactive);
+        setConfiguration(Configuration.read(file), null, cmdType);
     }
 
     /**
@@ -1478,26 +1509,26 @@ public void populateGroups(Set<Group> groups, Set<Project> projects) {
      * @param configuration what configuration to use
      */
     public void setConfiguration(Configuration configuration) {
-        setConfiguration(configuration, null, false);
+        setConfiguration(configuration, null, CommandTimeoutType.INDEXER);
     }
 
     /**
      * Sets the configuration and performs necessary actions.
      * @param configuration new configuration
-     * @param interactive true if in interactive mode
+     * @param cmdType command timeout type
      */
-    public void setConfiguration(Configuration configuration, boolean interactive) {
-        setConfiguration(configuration, null, interactive);
+    public void setConfiguration(Configuration configuration, CommandTimeoutType cmdType) {
+        setConfiguration(configuration, null, cmdType);
     }
 
     /**
      * Sets the configuration and performs necessary actions.
      *
      * @param configuration new configuration
      * @param subFileList   list of repositories
-     * @param interactive   true if in interactive mode
+     * @param cmdType       command timeout type
      */
-    public synchronized void setConfiguration(Configuration configuration, List<String> subFileList, boolean interactive) {
+    public synchronized void setConfiguration(Configuration configuration, List<String> subFileList, CommandTimeoutType cmdType) {
         try (ResourceLock resourceLock = configLock.writeLockAsResource()) {
             //noinspection ConstantConditions to avoid warning of no reference to auto-closeable
             assert resourceLock != null;
@@ -1509,11 +1540,9 @@ public synchronized void setConfiguration(Configuration configuration, List<Stri
 
         // Set the working repositories in HistoryGuru.
         if (subFileList != null) {
-            histGuru.invalidateRepositories(
-                    getRepositories(), subFileList, interactive);
+            histGuru.invalidateRepositories(getRepositories(), subFileList, cmdType);
         } else {
-            histGuru.invalidateRepositories(getRepositories(),
-                    interactive);
+            histGuru.invalidateRepositories(getRepositories(), cmdType);
         }
 
         // The invalidation of repositories above might have excluded some
@@ -1569,10 +1598,10 @@ public void setAuthorizationFramework(AuthorizationFramework fw) {
     /**
      * Re-apply the configuration.
      * @param reindex is the message result of reindex
-     * @param interactive true if in interactive mode
+     * @param cmdType command timeout type
      */
-    public void applyConfig(boolean reindex, boolean interactive) {
-        applyConfig(configuration, reindex, interactive);
+    public void applyConfig(boolean reindex, CommandTimeoutType cmdType) {
+        applyConfig(configuration, reindex, cmdType);
     }
 
     /**
@@ -1582,11 +1611,11 @@ public void applyConfig(boolean reindex, boolean interactive) {
      *
      * @param configuration XML configuration
      * @param reindex is the message result of reindex
-     * @param interactive true if in interactive mode
+     * @param cmdType command timeout type
      * @see #applyConfig(org.opengrok.indexer.configuration.Configuration,
-     * boolean, boolean) applyConfig(config, reindex, interactive)
+     * boolean, CommandTimeoutType) applyConfig(config, reindex, cmdType)
      */
-    public void applyConfig(String configuration, boolean reindex, boolean interactive) {
+    public void applyConfig(String configuration, boolean reindex, CommandTimeoutType cmdType) {
         Configuration config;
         try {
             config = makeXMLStringAsConfiguration(configuration);
@@ -1595,7 +1624,7 @@ public void applyConfig(String configuration, boolean reindex, boolean interacti
             return;
         }
 
-        applyConfig(config, reindex, interactive);
+        applyConfig(config, reindex, cmdType);
     }
 
     /**
@@ -1605,10 +1634,10 @@ public void applyConfig(String configuration, boolean reindex, boolean interacti
      *
      * @param config the incoming configuration
      * @param reindex is the message result of reindex
-     * @param interactive true if in interactive mode
+     * @param cmdType command timeout type
      */
-    public void applyConfig(Configuration config, boolean reindex, boolean interactive) {
-        setConfiguration(config, interactive);
+    public void applyConfig(Configuration config, boolean reindex, CommandTimeoutType cmdType) {
+        setConfiguration(config, cmdType);
         LOGGER.log(Level.INFO, "Configuration updated");
 
         if (reindex) {