Changeset 16825 in josm for trunk/src

Timestamp:

2020-08-02T22:16:18+02:00 (4 years ago)

Author:

simon04

Message:

fix #19400 - Remote control: generate OpenAPI specification

Location:

trunk/src/org/openstreetmap/josm/io/remotecontrol

Files:

• RemoteControl.java (modified) (2 diffs)
• RequestProcessor.java (modified) (10 diffs)
• handler/FeaturesHandler.java (modified) (2 diffs)
• handler/OpenApiHandler.java (added)
• handler/RequestHandler.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/io/remotecontrol/RemoteControl.java

@@ -32 +32 @@
      */
     static final int protocolMajorVersion = 1;
-    static final int protocolMinorVersion = 10;
+    static final int protocolMinorVersion = 12;
 
     /**
@@ -99 +99 @@
         throw new UnknownHostException();
     }
+
+    /**
+     * Returns the RemoteControl HTTP protocol version
+     * @return the RemoteControl HTTP protocol version
+     */
+    public static String getVersion() {
+        return protocolMajorVersion + "." + protocolMinorVersion;
+    }
 }

trunk/src/org/openstreetmap/josm/io/remotecontrol/RequestProcessor.java

@@ -11 +11 @@
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Date;
@@ -24 +23 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import javax.json.Json;
-import javax.json.JsonArray;
-import javax.json.JsonArrayBuilder;
-import javax.json.JsonObject;
-import javax.json.JsonObjectBuilder;
 
 import org.openstreetmap.josm.data.Version;
@@ -42 +37 @@
 import org.openstreetmap.josm.io.remotecontrol.handler.LoadDataHandler;
 import org.openstreetmap.josm.io.remotecontrol.handler.LoadObjectHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.OpenApiHandler;
 import org.openstreetmap.josm.io.remotecontrol.handler.OpenFileHandler;
 import org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler;
@@ -62 +58 @@
 
     /**
+     * The string "JOSM RemoteControl"
+     */
+    public static final String JOSM_REMOTE_CONTROL = "JOSM RemoteControl";
+
+    /**
      * RemoteControl protocol version. Change minor number for compatible
      * interface extensions. Change major number in case of incompatible
@@ -70 +71 @@
                     .add("major", RemoteControl.protocolMajorVersion)
                     .add("minor", RemoteControl.protocolMinorVersion))
-            .add("application", "JOSM RemoteControl")
+            .add("application", JOSM_REMOTE_CONTROL)
             .add("version", Version.getInstance().getVersion())
             .build().toString();
@@ -168 +169 @@
             addRequestHandlerClass(VersionHandler.command, VersionHandler.class, true);
             addRequestHandlerClass(FeaturesHandler.command, FeaturesHandler.class, true);
+            addRequestHandlerClass(OpenApiHandler.command, OpenApiHandler.class, true);
         }
     }
@@ -393 +395 @@
         out.write("HTTP/1.1 " + status + "\r\n");
         out.write("Date: " + new Date() + "\r\n");
-        out.write("Server: JOSM RemoteControl\r\n");
+        out.write("Server: " + JOSM_REMOTE_CONTROL + "\r\n");
         out.write("Content-type: " + contentType + "; charset=" + RESPONSE_CHARSET.name().toLowerCase(Locale.ENGLISH) + "\r\n");
         out.write("Access-Control-Allow-Origin: *\r\n");
@@ -401 +403 @@
 
     /**
-     * Returns the JSON information for the given (if null: all) handlers.
+     * Returns the information for the given (if null: all) handlers.
      * @param handlers the handlers
-     * @return the JSON information for the given (if null: all) handlers
-     */
-    public static JsonArray getHandlersInfoAsJSON(Collection<String> handlers) {
-        JsonArrayBuilder json = Json.createArrayBuilder();
-        for (String s : Utils.firstNonNull(handlers, RequestProcessor.handlers.keySet())) {
-            JsonObject infoAsJson = getHandlerInfoAsJSON(s);
-            if (infoAsJson != null) {
-                json.add(infoAsJson);
-            }
-        }
-        return json.build();
-    }
-
-    /**
-     * Returns the JSON information for a given handler.
+     * @return the information for the given (if null: all) handlers
+     */
+    public static Stream<RequestHandler> getHandlersInfo(Collection<String> handlers) {
+        return Utils.firstNonNull(handlers, RequestProcessor.handlers.keySet()).stream()
+                .map(RequestProcessor::getHandlerInfo)
+                .filter(Objects::nonNull);
+    }
+
+    /**
+     * Returns the information for a given handler.
      * @param cmd handler key
-     * @return JSON information for the given handler
-     */
-    public static JsonObject getHandlerInfoAsJSON(String cmd) {
-        RequestHandler handler;
+     * @return the information for the given handler
+     */
+    public static RequestHandler getHandlerInfo(String cmd) {
         if (cmd == null) {
             return null;
@@ -432 +428 @@
             Class<?> c = handlers.get(cmd);
             if (c == null) return null;
-            handler = handlers.get(cmd).getConstructor().newInstance();
+            RequestHandler handler = handlers.get(cmd).getConstructor().newInstance();
+            handler.setCommand(cmd);
+            return handler;
         } catch (ReflectiveOperationException ex) {
             Logging.warn("Unknown handler " + cmd);
@@ -438 +436 @@
             return null;
         }
-        return getHandlerInfoAsJSON(cmd, handler);
-    }
-
-    private static JsonObject getHandlerInfoAsJSON(String cmd, RequestHandler handler) {
-        JsonObjectBuilder json = Json.createObjectBuilder();
-        json.add("request", cmd);
-        if (handler.getUsage() != null) {
-            json.add("usage", handler.getUsage());
-        }
-        json.add("parameters", toJsonArray(handler.getMandatoryParams()));
-        json.add("optional", toJsonArray(handler.getOptionalParams()));
-        json.add("examples", toJsonArray(handler.getUsageExamples(cmd.substring(1))));
-        return json.build();
-    }
-
-    private static JsonArray toJsonArray(String[] strings) {
-        return Arrays.stream(strings)
-                .collect(Collectors.collectingAndThen(Collectors.toList(), Json::createArrayBuilder))
-                .build();
     }
 

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/FeaturesHandler.java

@@ -6 +6 @@
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.stream.Collectors;
+
+import javax.json.Json;
+import javax.json.JsonArray;
+import javax.json.JsonArrayBuilder;
+import javax.json.JsonObject;
+import javax.json.JsonObjectBuilder;
 
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
@@ -25 +32 @@
         String q = args.get("q");
         Collection<String> handlers = q == null ? null : Arrays.asList(q.split("[,\\s]+", -1));
-        content = RequestProcessor.getHandlersInfoAsJSON(handlers).toString();
+        content = getHandlersInfoAsJSON(handlers).toString();
         contentType = "application/json";
         if (args.containsKey("jsonp")) {
             content = args.get("jsonp") + " && " + args.get("jsonp") + '(' + content + ')';
         }
+    }
+
+    private static JsonArray getHandlersInfoAsJSON(Collection<String> handlers) {
+        JsonArrayBuilder json = Json.createArrayBuilder();
+        RequestProcessor.getHandlersInfo(handlers)
+                .map(FeaturesHandler::getHandlerInfoAsJSON)
+                .forEach(json::add);
+        return json.build();
+    }
+
+    private static JsonObject getHandlerInfoAsJSON(RequestHandler handler) {
+        JsonObjectBuilder json = Json.createObjectBuilder();
+        json.add("request", handler.getCommand());
+        if (handler.getUsage() != null) {
+            json.add("usage", handler.getUsage());
+        }
+        json.add("parameters", toJsonArray(handler.getMandatoryParams()));
+        json.add("optional", toJsonArray(handler.getOptionalParams()));
+        json.add("examples", toJsonArray(handler.getUsageExamples(handler.getCommand())));
+        return json.build();
+    }
+
+    private static JsonArray toJsonArray(String[] strings) {
+        return Arrays.stream(strings)
+                .collect(Collectors.collectingAndThen(Collectors.toList(), Json::createArrayBuilder))
+                .build();
     }
 

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java

@@ -310 +310 @@
         }
         myCommand = command;
+    }
+
+    /**
+     * Returns the command associated with this handler.
+     * @return the command associated with this handler.
+     */
+    public String getCommand() {
+        return myCommand;
     }