changes for allowing both jetty shared server or standalone netty server

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -377,6 +377,8 @@ public class ApiConstants {
     public static final String LIMIT_CPU_USE = "limitcpuuse";
     public static final String LIST_HOSTS = "listhosts";
     public static final String LOCATION_TYPE = "locationtype";
+    public static final String LOG_IDS = "logids";
+    public static final String LOGS_WEB_SERVER_ENABLED = "logswebserverenabled";
     public static final String LOCK = "lock";
     public static final String LUN = "lun";
     public static final String LBID = "lbruleid";
@@ -1354,8 +1356,6 @@ public class ApiConstants {
     public static final String OBJECT_STORAGE_LIMIT = "objectstoragelimit";
     public static final String OBJECT_STORAGE_TOTAL = "objectstoragetotal";
 
-    public static final String LOGS_WEB_SERVER_ENABLED = "logswebserverenabled";
-
     public static final String PARAMETER_DESCRIPTION_ACTIVATION_RULE = "Quota tariff's activation rule. It can receive a JS script that results in either " +
             "a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the " +
             "numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff " +

api/src/main/java/org/apache/cloudstack/api/BaseResponse.java

@@ -16,6 +16,10 @@
 // under the License.
 package org.apache.cloudstack.api;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
 import com.google.gson.annotations.SerializedName;
 
 import com.cloud.serializer.Param;
@@ -32,9 +36,9 @@ public abstract class BaseResponse implements ResponseObject {
     @Param(description = "The current status of the latest async job acting on this object")
     private Integer jobStatus;
 
-    @SerializedName(ApiConstants.CONTEXT_ID)
-    @Param(description = "the ID of the executing context")
-    private String contextId;
+    @SerializedName(ApiConstants.LOG_IDS)
+    @Param(description = "the IDs of the logs for the request")
+    private List<String> logsIds;
 
     public BaseResponse() {
     }
@@ -89,12 +93,15 @@ public void setJobStatus(Integer jobStatus) {
     }
 
     @Override
-    public String getContextId() {
-        return contextId;
+    public List<String> getLogIds() {
+        return logsIds;
     }
 
     @Override
-    public void setContextId(String contextId) {
-        this.contextId = contextId;
+    public void addLogIds(String... logId) {
+        if (this.logsIds == null) {
+            logsIds = new ArrayList<>();
+        }
+        this.logsIds.addAll(Arrays.asList(logId));
     }
 }

api/src/main/java/org/apache/cloudstack/api/ResponseObject.java

@@ -16,6 +16,8 @@
 // under the License.
 package org.apache.cloudstack.api;
 
+import java.util.List;
+
 public interface ResponseObject {
     /**
      * Get the name of the API response
@@ -76,8 +78,8 @@ public interface ResponseObject {
      */
     void setJobStatus(Integer jobStatus);
 
-    String getContextId();
-    void setContextId(String contextId);
+    List<String> getLogIds();
+    void addLogIds(String... contextId);
 
     public enum ResponseView {
         Full,

api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java

@@ -99,7 +99,6 @@ public class ListCfgsByCmd extends BaseListCmd {
             type = CommandType.UUID,
             entityType = ManagementServerResponse.class,
             description = "the ID of the Management Server to update the parameter value for corresponding management server",
-            validations = ApiArgValidator.PositiveNumber,
             since = "4.21.0")
     private Long managementServerId;
 

api/src/main/java/org/apache/cloudstack/api/command/admin/config/ResetCfgCmd.java

@@ -23,17 +23,16 @@
 import org.apache.cloudstack.api.BaseCmd;
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
-import org.apache.cloudstack.api.response.ImageStoreResponse;
-import org.apache.cloudstack.api.response.ManagementServerResponse;
-import org.apache.cloudstack.framework.config.ConfigKey;
-
 import org.apache.cloudstack.api.response.AccountResponse;
 import org.apache.cloudstack.api.response.ClusterResponse;
 import org.apache.cloudstack.api.response.ConfigurationResponse;
 import org.apache.cloudstack.api.response.DomainResponse;
+import org.apache.cloudstack.api.response.ImageStoreResponse;
+import org.apache.cloudstack.api.response.ManagementServerResponse;
 import org.apache.cloudstack.api.response.StoragePoolResponse;
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.cloudstack.config.Configuration;
+import org.apache.cloudstack.framework.config.ConfigKey;
 
 import com.cloud.user.Account;
 import com.cloud.utils.Pair;
@@ -89,7 +88,6 @@ public class ResetCfgCmd extends BaseCmd {
             type = CommandType.UUID,
             entityType = ManagementServerResponse.class,
             description = "the ID of the Management Server to update the parameter value for corresponding management server",
-            validations = ApiArgValidator.PositiveNumber,
             since = "4.21.0")
     private Long managementServerId;
 

api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java

@@ -164,7 +164,7 @@ public class CapabilitiesResponse extends BaseResponse {
     private Map<String, Object> vpnCustomerGatewayParameters;
 
     @SerializedName(ApiConstants.LOGS_WEB_SERVER_ENABLED)
-    @Param(description = "true if Logs Web Server plugin is enabled, false otherwise", since = "4.21.0")
+    @Param(description = "true if Logs Web Server plugin is enabled, false otherwise", since = "4.23.0")
     private boolean logsWebServerEnabled;
 
     public void setSecurityGroupsEnabled(boolean securityGroupsEnabled) {

api/src/main/java/org/apache/cloudstack/cluster/ClusterCommandProcessor.java

@@ -0,0 +1,25 @@
+// 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
+//
+//   http://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.
+
+package org.apache.cloudstack.cluster;
+
+import com.cloud.agent.api.Command;
+
+public interface ClusterCommandProcessor {
+    boolean supportsCommand(Class<?> clazz);
+    String processCommand(Command cmd);
+}

client/pom.xml

@@ -52,6 +52,14 @@
             <groupId>org.eclipse.jetty</groupId>
             <artifactId>jetty-util</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.jetty.websocket</groupId>
+            <artifactId>websocket-server</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.websocket</groupId>
+            <artifactId>javax.websocket-api</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.mysql</groupId>
             <artifactId>mysql-connector-j</artifactId>
@@ -116,6 +124,11 @@
             <artifactId>cloud-framework-spring-lifecycle</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-framework-websocket-server</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.cloudstack</groupId>
             <artifactId>cloud-plugin-storage-volume-adaptive</artifactId>

client/src/main/java/org/apache/cloudstack/ServerDaemon.java

@@ -26,9 +26,14 @@
 import java.net.URL;
 import java.util.Properties;
 
+import org.apache.cloudstack.framework.websocket.server.common.WebSocketRouter;
+import org.apache.cloudstack.utils.server.ServerPropertiesUtil;
+import org.apache.cloudstack.websocket.JettyWebSocketServlet;
 import org.apache.commons.daemon.Daemon;
 import org.apache.commons.daemon.DaemonContext;
 import org.apache.commons.lang3.StringUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.eclipse.jetty.jmx.MBeanContainer;
 import org.eclipse.jetty.server.HttpConfiguration;
 import org.eclipse.jetty.server.HttpConnectionFactory;
@@ -43,13 +48,12 @@
 import org.eclipse.jetty.server.handler.RequestLogHandler;
 import org.eclipse.jetty.server.handler.gzip.GzipHandler;
 import org.eclipse.jetty.server.session.SessionHandler;
+import org.eclipse.jetty.servlet.ServletHolder;
 import org.eclipse.jetty.util.ssl.KeyStoreScanner;
 import org.eclipse.jetty.util.ssl.SslContextFactory;
 import org.eclipse.jetty.util.thread.QueuedThreadPool;
 import org.eclipse.jetty.util.thread.ScheduledExecutorScheduler;
 import org.eclipse.jetty.webapp.WebAppContext;
-import org.apache.logging.log4j.Logger;
-import org.apache.logging.log4j.LogManager;
 
 import com.cloud.utils.Pair;
 import com.cloud.utils.PropertiesUtil;
@@ -88,8 +92,8 @@ public class ServerDaemon implements Daemon {
     private Server server;
 
     private boolean httpEnable = true;
-    private int httpPort = 8080;
-    private int httpsPort = 8443;
+    private int httpPort = ServerPropertiesUtil.HTTP_PORT;
+    private int httpsPort = ServerPropertiesUtil.HTTPS_PORT;
     private int sessionTimeout = 30;
     private int maxFormContentSize = DEFAULT_REQUEST_CONTENT_SIZE;
     private int maxFormKeys = DEFAULT_REQUEST_MAX_FORM_KEYS;
@@ -132,12 +136,12 @@ public void init(final DaemonContext context) {
             }
             setBindInterface(properties.getProperty(BIND_INTERFACE, null));
             setContextPath(properties.getProperty(CONTEXT_PATH, "/client"));
-            setHttpEnable(Boolean.valueOf(properties.getProperty(ServerProperties.HTTP_ENABLE, "true")));
-            setHttpPort(Integer.valueOf(properties.getProperty(ServerProperties.HTTP_PORT, "8080")));
-            setHttpsEnable(Boolean.valueOf(properties.getProperty(ServerProperties.HTTPS_ENABLE, "false")));
-            setHttpsPort(Integer.valueOf(properties.getProperty(ServerProperties.HTTPS_PORT, "8443")));
-            setKeystoreFile(properties.getProperty(ServerProperties.KEYSTORE_FILE));
-            setKeystorePassword(properties.getProperty(KEYSTORE_PASSWORD));
+            setHttpEnable(Boolean.valueOf(properties.getProperty(ServerPropertiesUtil.KEY_HTTP_ENABLE, "true")));
+            setHttpPort(Integer.valueOf(properties.getProperty(ServerPropertiesUtil.KEY_HTTP_PORT, "8080")));
+            setHttpsEnable(Boolean.valueOf(properties.getProperty(ServerPropertiesUtil.KEY_HTTPS_ENABLE, "false")));
+            setHttpsPort(Integer.valueOf(properties.getProperty(ServerPropertiesUtil.KEY_HTTPS_PORT, "8443")));
+            setKeystoreFile(properties.getProperty(ServerPropertiesUtil.KEY_KEYSTORE_FILE));
+            setKeystorePassword(properties.getProperty(ServerPropertiesUtil.KEY_KEYSTORE_PASSWORD));
             setWebAppLocation(properties.getProperty(WEBAPP_DIR));
             setAccessLogFile(properties.getProperty(ACCESS_LOG, "access.log"));
             setSessionTimeout(Integer.valueOf(properties.getProperty(SESSION_TIMEOUT, "30")));
@@ -190,7 +194,7 @@ public void start() throws Exception {
         createHttpConnector(httpConfig);
 
         // Setup handlers
-        Pair<SessionHandler,HandlerCollection> pair = createHandlers();
+        Pair<SessionHandler, HandlerCollection> pair = createHandlers();
         server.setHandler(pair.second());
 
         // Extra config options
@@ -263,14 +267,45 @@ private void createHttpsConnector(final HttpConfiguration httpConfig) {
             }
         }
     }
+    /**
+     * Adds a Jetty-native WebSocket servlet to the provided WebAppContext when the
+     * server is operating in same-port mode. The method checks the
+     * `websocket.server.port` server property; if that property is set and differs
+     * from this server's HTTP port, registration is skipped because a standalone
+     * WebSocket server is assumed.
+     *
+     * @param webApp the WebAppContext to which the WebSocket servlet will be added
+     */
+    protected void addWebSocketHandler(final WebAppContext webApp) {
+        try {
+            if (!JettyWebSocketServlet.isWebSocketServletEnabled()) {
+                logger.info("WebSocket Server is not enabled, embedded WebSocket Server will not be running");
+                return;
+            }
+            Integer port = JettyWebSocketServlet.getWebSocketServletPort();
+            if (port == null) {
+                logger.info("WebSocket Server port is configured, embedded WebSocket Server will not be running");
+                return;
+            }
+            final ServletHolder ws = new ServletHolder(new JettyWebSocketServlet());
+            webApp.addServlet(ws, WebSocketRouter.WEBSOCKET_PATH_PREFIX + "/*");
+            logger.info("Embedded WebSocket Server initialized at {}/* with port: {}",
+                    WebSocketRouter.WEBSOCKET_PATH_PREFIX, port);
+        } catch (Exception e) {
+            logger.warn("Failed to initialize embedded WebSocket server", e);
+        }
+    }
 
-    private Pair<SessionHandler,HandlerCollection> createHandlers() {
+    private Pair<SessionHandler, HandlerCollection> createHandlers() {
         final WebAppContext webApp = new WebAppContext();
         webApp.setContextPath(contextPath);
         webApp.setInitParameter("org.eclipse.jetty.servlet.Default.dirAllowed", "false");
         webApp.setMaxFormContentSize(maxFormContentSize);
         webApp.setMaxFormKeys(maxFormKeys);
 
+        // Enable WebSockets
+        addWebSocketHandler(webApp);
+
         // GZIP handler
         final GzipHandler gzipHandler = new GzipHandler();
         gzipHandler.addIncludedMimeTypes("text/html", "text/xml", "text/css", "text/plain", "text/javascript", "application/javascript", "application/json", "application/xml");