feat: Add ability to use secure WebSocket to listen Logcat messages

Author: valfirst

src/main/java/io/appium/java_client/android/ListensToLogcatMessages.java

@@ -20,9 +20,9 @@
 import io.appium.java_client.ExecutesMethod;
 import io.appium.java_client.ws.StringWebSocketClient;
 import org.openqa.selenium.remote.RemoteWebDriver;
+import org.openqa.selenium.remote.SessionId;
 
 import java.net.URI;
-import java.net.URISyntaxException;
 import java.util.function.Consumer;
 
 import static io.appium.java_client.service.local.AppiumServiceBuilder.DEFAULT_APPIUM_PORT;
@@ -36,7 +36,7 @@ public interface ListensToLogcatMessages extends ExecutesMethod {
      * is assigned to the default port (4723).
      */
     default void startLogcatBroadcast() {
-        startLogcatBroadcast("127.0.0.1", DEFAULT_APPIUM_PORT);
+        startLogcatBroadcast("127.0.0.1");
     }
 
     /**
@@ -49,21 +49,42 @@ default void startLogcatBroadcast(String host) {
         startLogcatBroadcast(host, DEFAULT_APPIUM_PORT);
     }
 
+    /**
+     * Start logcat messages broadcast via web socket.
+     * This method assumes that Appium server is assigned to the default port (4723).
+     *
+     * @param host                the name of the host where Appium server is running
+     * @param useSecureConnection If true, secure WebSocket specification is used ('wss' scheme), otherwise - plain
+     *                            WebSocket ('ws' scheme)
+     */
+    default void startLogcatBroadcast(String host, boolean useSecureConnection) {
+        startLogcatBroadcast(host, DEFAULT_APPIUM_PORT, useSecureConnection);
+    }
+
     /**
      * Start logcat messages broadcast via web socket.
      *
      * @param host the name of the host where Appium server is running
      * @param port the port of the host where Appium server is running
      */
     default void startLogcatBroadcast(String host, int port) {
+        startLogcatBroadcast(host, port, false);
+    }
+
+    /**
+     * Start logcat messages broadcast via web socket.
+     *
+     * @param host                the name of the host where Appium server is running
+     * @param port                the port of the host where Appium server is running
+     * @param useSecureConnection If true, secure WebSocket specification is used ('wss' scheme), otherwise - plain
+     *                            WebSocket ('ws' scheme)
+     */
+    default void startLogcatBroadcast(String host, int port, boolean useSecureConnection) {
         CommandExecutionHelper.executeScript(this, "mobile: startLogsBroadcast");
-        final URI endpointUri;
-        try {
-            endpointUri = new URI(String.format("ws://%s:%s/ws/session/%s/appium/device/logcat",
-                    host, port, ((RemoteWebDriver) this).getSessionId()));
-        } catch (URISyntaxException e) {
-            throw new IllegalArgumentException(e);
-        }
+        String scheme = useSecureConnection ? "wss" : "ws";
+        SessionId sessionId = ((RemoteWebDriver) this).getSessionId();
+        URI endpointUri = URI.create(String.format("%s://%s:%s/ws/session/%s/appium/device/logcat", scheme, host,
+                port, sessionId));
         getLogcatClient().connect(endpointUri);
     }