add acquired param

Author: bernardodemarco

api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/ListConsoleSessionsCmd.java

@@ -89,6 +89,11 @@ public class ListConsoleSessionsCmd extends BaseListCmd {
             description = "Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.")
     private boolean activeOnly = true;
 
+    @Parameter(name = ApiConstants.ACQUIRED, type = CommandType.BOOLEAN,
+        description = "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. " +
+                "The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.")
+    private boolean acquired = false;
+
     @Parameter(name = ApiConstants.IS_RECURSIVE, type = CommandType.BOOLEAN,
             description = "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.")
     private boolean recursive = false;
@@ -137,6 +142,10 @@ public boolean isActiveOnly() {
         return activeOnly;
     }
 
+    public boolean getAcquired() {
+        return acquired;
+    }
+
     public boolean isRecursive() {
         return recursive;
     }

engine/schema/src/main/java/com/cloud/vm/dao/ConsoleSessionDao.java

@@ -41,5 +41,5 @@ public interface ConsoleSessionDao extends GenericDao<ConsoleSessionVO, Long> {
     Pair<List<ConsoleSessionVO>, Integer> listConsoleSessions(Long id, List<Long> domainIds, Long accountId, Long userId, Long hostId,
                                                               Date startDate, Date endDate, Long instanceId,
                                                               String consoleEndpointCreatorAddress, String clientAddress,
-                                                              boolean activeOnly, Long pageSizeVal, Long startIndex);
+                                                              boolean activeOnly, boolean acquired, Long pageSizeVal, Long startIndex);
 }

engine/schema/src/main/java/com/cloud/vm/dao/ConsoleSessionDaoImpl.java

@@ -102,19 +102,19 @@ public int expungeByVmList(List<Long> vmIds, Long batchSize) {
     public Pair<List<ConsoleSessionVO>, Integer> listConsoleSessions(Long id, List<Long> domainIds, Long accountId, Long userId, Long hostId,
                                                                      Date startDate, Date endDate, Long instanceId,
                                                                      String consoleEndpointCreatorAddress, String clientAddress,
-                                                                     boolean activeOnly, Long pageSizeVal, Long startIndex) {
+                                                                     boolean activeOnly, boolean acquired, Long pageSizeVal, Long startIndex) {
         Filter filter = new Filter(ConsoleSessionVO.class, CREATED, false, startIndex, pageSizeVal);
         SearchCriteria<ConsoleSessionVO> searchCriteria = createListConsoleSessionsSearchCriteria(id, domainIds, accountId, userId, hostId,
-                startDate, endDate, instanceId, consoleEndpointCreatorAddress, clientAddress, activeOnly);
+                startDate, endDate, instanceId, consoleEndpointCreatorAddress, clientAddress, activeOnly, acquired);
 
         return searchAndCount(searchCriteria, filter, true);
     }
 
     private SearchCriteria<ConsoleSessionVO> createListConsoleSessionsSearchCriteria(Long id, List<Long> domainIds, Long accountId, Long userId, Long hostId,
                                                                                      Date startDate, Date endDate, Long instanceId,
                                                                                      String consoleEndpointCreatorAddress, String clientAddress,
-                                                                                     boolean activeOnly) {
-        SearchCriteria<ConsoleSessionVO> searchCriteria = createListConsoleSessionsSearchBuilder(activeOnly).create();
+                                                                                     boolean activeOnly, boolean acquired) {
+        SearchCriteria<ConsoleSessionVO> searchCriteria = createListConsoleSessionsSearchBuilder(activeOnly, acquired).create();
 
         searchCriteria.setParametersIfNotNull(ID, id);
         searchCriteria.setParametersIfNotNull(DOMAIN_IDS, domainIds.toArray());
@@ -130,7 +130,7 @@ private SearchCriteria<ConsoleSessionVO> createListConsoleSessionsSearchCriteria
         return searchCriteria;
     }
 
-    private SearchBuilder<ConsoleSessionVO> createListConsoleSessionsSearchBuilder(boolean activeOnly) {
+    private SearchBuilder<ConsoleSessionVO> createListConsoleSessionsSearchBuilder(boolean activeOnly, boolean acquired) {
         SearchBuilder<ConsoleSessionVO> searchBuilder = createSearchBuilder();
 
         searchBuilder.and(ID, searchBuilder.entity().getId(), SearchCriteria.Op.EQ);
@@ -147,6 +147,8 @@ private SearchBuilder<ConsoleSessionVO> createListConsoleSessionsSearchBuilder(b
         if (activeOnly) {
             searchBuilder.and(ACQUIRED, searchBuilder.entity().getAcquired(), SearchCriteria.Op.NNULL);
             searchBuilder.and(REMOVED, searchBuilder.entity().getRemoved(), SearchCriteria.Op.NULL);
+        } else if (acquired) {
+            searchBuilder.and(ACQUIRED, searchBuilder.entity().getAcquired(), SearchCriteria.Op.NNULL);
         }
 
         searchBuilder.done();

server/src/main/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImpl.java

@@ -233,7 +233,7 @@ protected Pair<List<ConsoleSessionVO>, Integer> listConsoleSessionsInternal(List
         return consoleSessionDao.listConsoleSessions(cmd.getId(), domainIds, accountId, userId,
                 cmd.getHostId(), cmd.getStartDate(), cmd.getEndDate(), cmd.getInstanceId(),
                 cmd.getConsoleEndpointCreatorAddress(), cmd.getClientAddress(), cmd.isActiveOnly(),
-                cmd.getPageSizeVal(), cmd.getStartIndex());
+                cmd.getAcquired(), cmd.getPageSizeVal(), cmd.getStartIndex());
     }
 
     /**

server/src/test/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImplTest.java

@@ -158,7 +158,7 @@ public void listConsoleSessionsInternalTestNormalUsersShouldOnlyBeAllowedToListT
         Mockito.verify(consoleSessionDaoMock).listConsoleSessions(
                 Mockito.any(), Mockito.eq(List.of(callerDomainId)), Mockito.eq(callerAccountId),
                 Mockito.eq(callerUserId), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
-                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
+                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
         );
     }
 
@@ -185,7 +185,7 @@ public void listConsoleSessionsInternalTestAdminsShouldBeAllowedToRetrieveOtherA
         Mockito.verify(consoleSessionDaoMock).listConsoleSessions(
                 Mockito.any(), Mockito.eq(List.of(callerDomainId)), Mockito.eq(callerAccountId),
                 Mockito.eq(callerUserId), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
-                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
+                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
         );
     }
 
@@ -213,7 +213,7 @@ public void listConsoleSessionsInternalTestShouldNotFetchConsoleSessionsRecursiv
         Mockito.verify(consoleSessionDaoMock).listConsoleSessions(
                 Mockito.any(), Mockito.eq(List.of(callerDomainId)), Mockito.eq(callerAccountId),
                 Mockito.eq(callerUserId), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
-                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
+                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
         );
     }
 
@@ -242,7 +242,7 @@ public void listConsoleSessionsInternalTestShouldFetchConsoleSessionsRecursively
         Mockito.verify(consoleSessionDaoMock).listConsoleSessions(
                 Mockito.any(), Mockito.eq(domainIdsCallerHasAccessTo), Mockito.eq(callerAccountId),
                 Mockito.eq(callerUserId), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(),
-                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
+                Mockito.any(), Mockito.any(), Mockito.anyBoolean(), Mockito.anyBoolean(), Mockito.any(), Mockito.any()
         );
     }