TIKA-4809 stage 5

Author: tballison

docs/modules/ROOT/pages/using-tika/server/index.adoc

@@ -92,11 +92,8 @@ The server starts on `localhost:9998` by default.
 |`-c <file>` or `--config <file>`
 |Path to `tika-config.json`. See <<_configuration,Configuration>> below.
 
-|`-a <file>` or `--pluginsConfig <file>`
-|Path to the Tika Pipes plugins configuration file.
-
 |`-i <id>` or `--id <id>`
-|Server ID, surfaced in the `/status` endpoint and in logs.
+|Server ID, written to the startup log. Defaults to a random UUID.
 
 |`-?` or `--help`
 |Print the usage message.
@@ -171,7 +168,7 @@ curl -T document.pdf http://localhost:9998/meta/Content-Type   # single field
 === Other endpoints
 
 * `/version` — server version
-* `/status` — health/status (includes server ID)
+* `/status` — health/status: state, active task count, files processed
 * `/parsers` and `/parsers/details` — registered parsers
 * `/detectors` — registered detectors
 * `/mime-types` — known MIME types
@@ -311,23 +308,18 @@ Server behavior beyond host/port is controlled by a JSON config file passed via
 |`false`
 |Include parser stack traces in error responses. Useful in dev, dangerous in production (leaks internals).
 
-|`digest`
-|`""` (off)
-|Compute a digest of the parsed bytes. Comma-separated algorithm names: `md5`, `sha1`, `sha256`, `sha384`, `sha512`.
-
-|`digestMarkLimit`
-|`20971520` (20 MiB)
-|Max bytes buffered for digest computation.
-
 |`logLevel`
 |_inherited_
 |`debug` or `info` to override the runtime log level.
 
-|`idBase`
+|`id`
 |random UUID
-|Override the auto-generated server ID (the `-i` CLI flag is the same setting).
+|Override the auto-generated server ID, which is written to the startup log (the `-i` CLI flag is the same setting).
 |===
 
+NOTE: Digests are configured in `parse-context`, not in the `server` section. See
+xref:configuration/digesters.adoc[Digesters].
+
 For the full Pipes-related sections (`pipes`, `fetchers`, `emitters`, `parse-context`)
 that tika-server 4.x requires, see
 xref:migration-to-4x/migrating-tika-server-4x.adoc#_configuration_changes[Configuration Changes].

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerCli.java

@@ -43,8 +43,6 @@ private static Options getOptions() {
                 "listen port (default = 9998)\n");
         options.addOption("?", "help", false, "this help message");
         options.addOption("c", "config", true, "tika-config file");
-        options.addOption("a", "pluginsConfig", true, "tike pipes config");
-
         options.addOption("i", "id", true, "id to use for server in" + " the server status endpoint and logging");
         return options;
     }
@@ -69,7 +67,7 @@ public static void main(String[] args) {
     private static void usage(Options options) throws IOException {
         HelpFormatter helpFormatter = HelpFormatter.builder().get();
         helpFormatter.printHelp("tikaserver", null, options, null, true);
-        System.exit(-1);
+        System.exit(0);
     }
 
 }

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java

@@ -39,9 +39,7 @@ public class TikaServerConfig {
 
     public static final int DEFAULT_PORT = 9998;
     public static final String DEFAULT_HOST = "localhost";
-    public static final Set<String> LOG_LEVELS = new HashSet<>(Arrays.asList("debug", "info"));
     private static final Logger LOG = LoggerFactory.getLogger(TikaServerConfig.class);
-    private static final int DEFAULT_DIGEST_MARK_LIMIT = 20 * 1024 * 1024;
     /**
      * Endpoints that expose the pipes/fetch machinery (process-isolated pipes
      * parsing and async batch processing). Selecting any of these requires
@@ -71,20 +69,15 @@ public class TikaServerConfig {
     private boolean allowPerRequestConfig = false;
     private String cors = "";
     private boolean returnStackTrace = false;
-    private String idBase = UUID
+    private String id = UUID
             .randomUUID()
             .toString();
     private int port = DEFAULT_PORT;
     private String host = DEFAULT_HOST;
-    private int digestMarkLimit = DEFAULT_DIGEST_MARK_LIMIT;
-    private String digest = "";
-    //debug or info only
-    private String logLevel = "";
+    private String requestLogLevel = "";
     private Path configPath;
     private ArrayList<String> endpoints = new ArrayList<>();
 
-    private boolean preventStopMethod = false;
-
     private TlsConfig tlsConfig = new TlsConfig();
 
     /**
@@ -98,7 +91,6 @@ public static TikaServerConfig load(CommandLine commandLine) throws IOException,
 
         TikaServerConfig config = null;
         Set<String> settings = new HashSet<>();
-        Path pluginsConfig = null;
 
         if (commandLine.hasOption("c")) {
             config = load(Paths.get(commandLine.getOptionValue("c")), commandLine, settings);
@@ -144,10 +136,6 @@ public void setPort(int port) {
         this.port = port;
     }
 
-    public String getIdBase() {
-        return idBase;
-    }
-
     /**
      * Whether the pipes/fetch endpoints ({@code pipes}, {@code async}) may be
      * enabled. Off by default; selecting one of those endpoints without this set
@@ -210,15 +198,19 @@ public void setHost(String host) {
         this.host = host;
     }
 
-    public String getLogLevel() {
-        return logLevel;
+    /**
+     * Severity at which each request URI is logged. Empty (the default) disables
+     * request logging entirely; this does not change the log level of anything else.
+     */
+    public String getRequestLogLevel() {
+        return requestLogLevel;
     }
 
-    public void setLogLevel(String level) throws TikaConfigException {
+    public void setRequestLogLevel(String level) throws TikaConfigException {
         if (level.equals("debug") || level.equals("info")) {
-            this.logLevel = level;
+            this.requestLogLevel = level;
         } else {
-            throw new TikaConfigException("log level must be one of: 'debug' or 'info'");
+            throw new TikaConfigException("requestLogLevel must be one of: 'debug' or 'info'");
         }
     }
 
@@ -237,37 +229,17 @@ public boolean hasConfigFile() {
         return configPath != null;
     }
 
+    @com.fasterxml.jackson.annotation.JsonIgnore
     public Path getConfigPath() {
         return configPath;
     }
 
+    /** Set from the -c argument at load time; not a user-settable config key. */
+    @com.fasterxml.jackson.annotation.JsonIgnore
     public void setConfigPath(String path) {
         this.configPath = Paths.get(path);
     }
 
-    public int getDigestMarkLimit() {
-        return digestMarkLimit;
-    }
-
-    public void setDigestMarkLimit(int digestMarkLimit) {
-        this.digestMarkLimit = digestMarkLimit;
-    }
-
-    /**
-     * digest configuration string, e.g. md5 or sha256, alternately w 16 or 32 encoding,
-     * e.g. md5:32,sha256:16 would result in two digests per file
-     *
-     * @return
-     */
-    public String getDigest() {
-        return digest;
-    }
-
-    public void setDigest(String digest) {
-        LOG.info("As of Tika 2.5.0, you can set the digester via the AutoDetectParserConfig in " + "tika-config.xml. We plan to remove this commandline option in 2.8.0");
-        this.digest = digest;
-    }
-
     public boolean isReturnStackTrace() {
         return returnStackTrace;
     }
@@ -292,13 +264,15 @@ public void setEndpoints(ArrayList<String> endpoints) {
         this.endpoints = endpoints;
     }
 
+    /**
+     * Identifier for this server, surfaced in the startup log. Defaults to a random UUID.
+     */
     public String getId() {
-        //TODO fix this
-        return idBase;
+        return id;
     }
 
     public void setId(String id) {
-        this.idBase = id;
+        this.id = id;
     }
 
     private void addEndPoints(List<String> endPoints) {

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerProcess.java

@@ -22,14 +22,11 @@
 import java.nio.file.Path;
 import java.security.GeneralSecurityException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.CommandLineParser;
@@ -100,7 +97,6 @@
 public class TikaServerProcess {
 
 
-    public static final Set<String> LOG_LEVELS = new HashSet<>(Arrays.asList("debug", "info"));
     public static final int BIND_EXCEPTION = 42;
     private static final Logger LOG = LoggerFactory.getLogger(TikaServerProcess.class);
     public static int DO_NOT_RESTART_EXIT_VALUE = -100;
@@ -110,7 +106,6 @@ private static Options getOptions() {
         options.addOption("h", "host", true, "host name, use * for all)");
         options.addOption("p", "port", true, "listen port");
         options.addOption("c", "config", true, "Tika Configuration xml file to override default config with.");
-        options.addOption("a", "pluginsConfig", true, "Tika Configuration json for pluginscomponents");
         options.addOption("i", "id", true, "id to use for server in server status endpoint");
         options.addOption("?", "help", false, "this help message");
         return options;
@@ -232,6 +227,7 @@ private static ServerDetails initServer(TikaServerConfig tikaServerConfig) throw
         ServerDetails details = new ServerDetails();
         details.sf = sf;
         details.url = url;
+        details.serverId = tikaServerConfig.getId();
         details.serverStatus = serverStatus;
         return details;
     }
@@ -315,16 +311,12 @@ private static void loadAllProviders(TikaServerConfig tikaServerConfig, ServerSt
         // Add ConfigEndpointSecurityFilter to gate /config endpoints
         writers.add(new ConfigEndpointSecurityFilter(tikaServerConfig.isAllowPerRequestConfig()));
 
+        // setRequestLogLevel rejects anything but debug/info, so no validation needed here.
         TikaLoggingFilter logFilter = null;
-        if (!StringUtils.isBlank(tikaServerConfig.getLogLevel())) {
-            String logLevel = tikaServerConfig.getLogLevel();
-            if (LOG_LEVELS.contains(logLevel)) {
-                boolean isInfoLevel = "info".equals(logLevel);
-                logFilter = new TikaLoggingFilter(isInfoLevel);
-                writers.add(logFilter);
-            } else {
-                LOG.warn("Unsupported request URI log level: {}", logLevel);
-            }
+        String requestLogLevel = tikaServerConfig.getRequestLogLevel();
+        if (!StringUtils.isBlank(requestLogLevel)) {
+            logFilter = new TikaLoggingFilter("info".equals(requestLogLevel));
+            writers.add(logFilter);
         }
 
         CrossOriginResourceSharingFilter corsFilter = null;