GH-4037: Rename packagings and cmd names in Fuseki

Author: afs

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/FusekiServer.java

@@ -117,7 +117,7 @@ public class FusekiServer {
     /**
      * Construct a Fuseki server from command line arguments.
      * The return server has not been started.
-     * @deprecated Use {@link FusekiMain#construct} or {@link FusekiRunner#basic()}
+     * @deprecated Use {@link FusekiMain#construct} or {@link FusekiRunner#serverBasic()}
      */
     @Deprecated
     static public FusekiServer construct(String... args) {
@@ -127,7 +127,7 @@ static public FusekiServer construct(String... args) {
     /**
      * Run a Fuseki server using the command line arguments for setup
      * The returned server has been started.
-     * @deprecated Use {@link FusekiMain#run} or {@link FusekiRunner#basic()}
+     * @deprecated Use {@link FusekiMain#run} or {@link FusekiRunner#serverBasic()}
      */
     @Deprecated
     static public FusekiServer run(String...args) {

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/cmds/FusekiBasicCmd.java

@@ -21,22 +21,12 @@
 
 package org.apache.jena.fuseki.main.cmds;
 
-import org.apache.jena.fuseki.main.FusekiMain;
-import org.apache.jena.fuseki.main.runner.FusekiRunner;
-
-/** Fuseki command that runs a minimal Fuseki server. No addition modules, no UI.
- * <p>
- * Use {@code --conf=} for multiple datasets and specific service names.
- * <p>
- * The command line dataset setup only supports a single dataset.
+/**
+ * @deprecated Use {@link FusekiServerBasicCmd}
  */
+@Deprecated(forRemoval = true)
 public class FusekiBasicCmd {
-    /**
-     * Build and run, a server based on command line syntax. This operation does not
-     * return. See {@link FusekiMain#build} to build a server using command line
-     * syntax but not start it.
-     */
-    static public void main(String... args) {
-        RunFuseki.run(args, FusekiRunner::execBasic);
+    public static void main(String[] args) {
+        FusekiServerBasicCmd.main(args);
     }
 }

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/cmds/FusekiCmd.java

@@ -21,7 +21,12 @@
 
 package org.apache.jena.fuseki.main.cmds;
 
-/** Reserved. Entry point used by the combined jar and "--jar" (from v6.0.0) */
+/**
+ * Reserved. Entry point used by the combined jar and "--jar" (from v6.0.0)
+ * @deprecated Do not use. Equivalent to {@link FusekiServerUICmd}
+ */
+
+@Deprecated(forRemoval = true)
 public class FusekiCmd {
     static public void main(String... args) {
         FusekiServerUICmd.main(args);

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/cmds/FusekiServerBasicCmd.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *   SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.apache.jena.fuseki.main.cmds;
+
+import org.apache.jena.fuseki.main.FusekiMain;
+import org.apache.jena.fuseki.main.runner.FusekiRunner;
+
+/** Fuseki command that runs a minimal Fuseki server. No addition modules, no UI.
+ * <p>
+ * Use {@code --conf=} for multiple datasets and specific service names.
+ * <p>
+ * The command line dataset setup only supports a single dataset.
+ */
+public class FusekiServerBasicCmd {
+    /**
+     * Build and run, a server based on command line syntax. This operation does not
+     * return. See {@link FusekiMain#build} to build a server using command line
+     * syntax but not start it.
+     */
+    static public void main(String... args) {
+        RunFuseki.run(args, FusekiRunner::execBasic);
+    }
+}

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/cmds/FusekiServerCmd.java

@@ -21,9 +21,11 @@
 
 package org.apache.jena.fuseki.main.cmds;
 
-/** 
+/**
  * Old name used in the fuseki-server script up to v5.6.0
+ * @deprecated Do not use. Equivalent to {@link FusekiServerUICmd}
  */
+@Deprecated(forRemoval = true)
 public class FusekiServerCmd {
     static public void main(String... args) {
         FusekiServerUICmd.main(args);

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/cmds/FusekiServerPlainCmd.java

@@ -26,7 +26,7 @@
 
 /**
  * Fuseki command that runs a Fuseki server with all function except with UI.
- * Shiro must be configured using the command line {@code --shiro=...}
+ * Shiro is configured using the command line {@code --shiro=...}
  * or using environment {@code FUSEKI_SHIRO}.
  * <p>
  * Use {@code --conf=} for multiple datasets and specific service names.
@@ -44,4 +44,3 @@ static public void main(String... args) {
         RunFuseki.run(args, FusekiRunner::execServerPlain);
     }
 }
-

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/runner/FusekiArgs.java

@@ -211,7 +211,7 @@ protected String getCommandName() {
     }
 
     private void argumentsSetup() {
-        modVersion.addClass("Fuseki", Fuseki.class);
+        //modVersion.addClass("Fuseki", Fuseki.class);
 
         getUsage().startCategory("Fuseki");
         add(argConfig, "--config=FILE",

jena-fuseki2/jena-fuseki-main/src/main/java/org/apache/jena/fuseki/main/runner/FusekiRunner.java

@@ -72,20 +72,20 @@ public class FusekiRunner {
      */
 
     enum FusekiForm {
-        BASIC("basic"), MAIN("main"), SERVER_PLAIN("server/plain"), SERVER("server/ui");
+        SERVER_BASIC("server/basic"), SERVER_MAIN("server/main"), SERVER_PLAIN("server/plain"), SERVER_UI("server/ui");
         final String fusekiFormName;
         FusekiForm(String string) { this.fusekiFormName = string; }
     }
 
     /** Minimal server - e.g. embedded use and testing. */
     public static void execBasic(String...args) {
-        announcementExec(FusekiForm.BASIC);
+        announcementExec(FusekiForm.SERVER_BASIC);
         runnerBasic().exec(args);
     }
 
     /** Basic server */
     public static void execMain(String...args) {
-        announcementExec(FusekiForm.MAIN);
+        announcementExec(FusekiForm.SERVER_MAIN);
         runnerMain().exec(args);
     }
 
@@ -97,19 +97,22 @@ public static void execServerPlain(String...args) {
 
     /** General server, with UI */
     public static void execServerUI(String...args) {
-        announcementExec(FusekiForm.SERVER);
+        announcementExec(FusekiForm.SERVER_UI);
         runnerServerUI().exec(args);
     }
 
     /** Minimal server - e.g. embedded use and testing */
     public static FusekiServer runAsyncBasic(String...args) {
-        announcementAsync(FusekiForm.BASIC);
+        announcementAsync(FusekiForm.SERVER_BASIC);
         return runnerBasic().runAsync(args);
     }
 
-    /** Basic server */
+    /**
+     * Server with ping, Shiro and Prometheus.
+     * See {@link FusekiRunner#serverMain()}.
+     */
     public static FusekiServer runAsyncMain(String...args) {
-        announcementAsync(FusekiForm.MAIN);
+        announcementAsync(FusekiForm.SERVER_MAIN);
         return runnerMain().runAsync(args);
     }
 
@@ -121,19 +124,24 @@ public static FusekiServer runAsyncServerPlain(String...args) {
 
     /** General server, with UI */
     public static FusekiServer runAsyncServerUI(String...args) {
-        announcementAsync(FusekiForm.SERVER);
+        announcementAsync(FusekiForm.SERVER_UI);
         return runnerServerUI().runAsync(args);
     }
 
     // @formatter:off
+
     /** Minimal server - e.g. embedded use and testing */
-    public static Runner basic()       { return runnerBasic(); }
+    public static Runner serverBasic() { return runnerBasic(); }
+
     /** Basic server */
-    public static Runner main()        { return runnerMain(); }
+    public static Runner serverMain()  { return runnerMain(); }
+
     /** All available server functionality, except admin functionality; no UI; Shiro configuration by command line or environment variable. */
     public static Runner serverPlain() { return runnerServerPlain(); }
+
     /** General server, with UI */
     public static Runner serverUI()    { return runnerServerUI(); }
+
     // @formatter:on
 
     // Banners

jena-fuseki2/jena-fuseki-main/src/test/java/org/apache/jena/fuseki/main/TestFusekiStart.java

@@ -75,12 +75,12 @@ public class TestFusekiStart {
     }
 
     @Test public void runner_01() {
-        FusekiServer server = FusekiRunner.basic().runAsync("--port=0", "--empty");
+        FusekiServer server = FusekiRunner.serverBasic().runAsync("--port=0", "--empty");
         server.stop();
     }
 
     @Test public void runner_02() {
-        FusekiServer server = FusekiRunner.main().runAsync("--port=0", "--empty");
+        FusekiServer server = FusekiRunner.serverMain().runAsync("--port=0", "--empty");
         server.stop();
     }
 

jena-fuseki2/jena-fuseki-main/src/test/java/org/apache/jena/fuseki/server/TestFusekiServer.java

@@ -58,7 +58,7 @@ public void runCmdLine() {
         String runBase = serverBase+"1";
         setup(runBase);
         // Build-run command line
-        FusekiServer server = FusekiRunner.basic().runAsync("--port=0", "--empty");
+        FusekiServer server = FusekiRunner.serverBasic().runAsync("--port=0", "--empty");
         try {
             int port = server.getPort();
             assertNotEquals(0, port, "Port is zero after async start");