Add policy search functionality to API

Co-authored-by: Oshani Silva <oshani@entgra.io>
Co-committed-by: Oshani Silva <oshani@entgra.io>

components/device-mgt/io.entgra.device.mgt.core.device.mgt.api/src/main/java/io/entgra/device/mgt/core/device/mgt/api/jaxrs/service/api/PolicyManagementService.java

@@ -916,6 +916,24 @@ public interface PolicyManagementService {
                             response = ErrorResponse.class)
             })
     Response getPolicyList(
+            @ApiParam(
+                    name = "name",
+                    value = "The name of the policy that needs filtering.",
+                    required = false)
+            @QueryParam("name")
+                    String name,
+            @ApiParam(
+                    name = "type",
+                    value = "The type of the policy that needs filtering.",
+                    required = false)
+            @QueryParam("type")
+                    String type,
+            @ApiParam(
+                    name = "status",
+                    value = "The status of the policy that needs filtering.",
+                    required = false)
+            @QueryParam("status")
+                    String status,
             @ApiParam(
                     name = "If-Modified-Since",
                     value = "Checks if the requested variant was modified, since the specified date-time. \n" +

components/device-mgt/io.entgra.device.mgt.core.device.mgt.api/src/main/java/io/entgra/device/mgt/core/device/mgt/api/jaxrs/service/impl/PolicyManagementServiceImpl.java

@@ -17,6 +17,7 @@
  */
 package io.entgra.device.mgt.core.device.mgt.api.jaxrs.service.impl;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -481,6 +482,9 @@ public class PolicyManagementServiceImpl implements PolicyManagementService {
     @Path("/list")
     @Override
     public Response getPolicyList(
+            @QueryParam("name") String name,
+            @QueryParam("type") String type,
+            @QueryParam("status") String status,
             @HeaderParam("If-Modified-Since") String ifModifiedSince,
             @QueryParam("offset") int offset,
             @QueryParam("limit") int limit) {
@@ -488,7 +492,16 @@ public class PolicyManagementServiceImpl implements PolicyManagementService {
         PolicyManagerService policyManagementService = DeviceMgtAPIUtils.getPolicyManagementService();
         List<Policy> policies;
         PolicyList targetPolicies = new PolicyList();
-        PaginationRequest request = new PaginationRequest(offset, limit);
+        PolicyPaginationRequest request = new PolicyPaginationRequest(offset, limit);
+        if (name != null){
+            request.setName(name);
+        }
+        if (type != null){
+            request.setType(type);
+        }
+        if (status != null){
+            request.setStatus(status);
+        }
         try {
             PolicyAdministratorPoint policyAdministratorPoint = policyManagementService.getPAP();
             policies = policyAdministratorPoint.getPolicyList(request);

components/device-mgt/io.entgra.device.mgt.core.device.mgt.common/src/main/java/io/entgra/device/mgt/core/device/mgt/common/PolicyPaginationRequest.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2018 - 2023, Entgra (pvt) Ltd. (https://entgra.io) All Rights Reserved.
+ *
+ * Entgra (Pvt) Ltd. 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 io.entgra.device.mgt.core.device.mgt.common;
+
+public class PolicyPaginationRequest {
+    private int startIndex;
+    private int rowCount;
+    private String name;
+    private String type;
+    private String status;
+
+    public PolicyPaginationRequest(int start, int rowCount) {
+        this.startIndex = start;
+        this.rowCount = rowCount;
+    }
+
+    public int getStartIndex() {
+        return startIndex;
+    }
+
+    public void setStartIndex(int startIndex) {
+        this.startIndex = startIndex;
+    }
+
+    public int getRowCount() {
+        return rowCount;
+    }
+
+    public void setRowCount(int rowCount) {
+        this.rowCount = rowCount;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
+
+    public String getStatus() {
+        return status;
+    }
+
+    public void setStatus(String status) {
+        this.status = status;
+    }
+
+    @Override
+    public String toString() {
+        return "Group Name '" + this.name + "' num of rows: " + this.rowCount + " start index: " + this.startIndex;
+    }
+}

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.common/src/main/java/io/entgra/device/mgt/core/policy/mgt/common/PolicyAdministratorPoint.java

@@ -20,6 +20,7 @@ package io.entgra.device.mgt.core.policy.mgt.common;
 import io.entgra.device.mgt.core.device.mgt.common.DeviceIdentifier;
 import io.entgra.device.mgt.core.device.mgt.common.DynamicTaskContext;
 import io.entgra.device.mgt.core.device.mgt.common.PaginationRequest;
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import io.entgra.device.mgt.core.device.mgt.common.policy.mgt.Policy;
 import io.entgra.device.mgt.core.device.mgt.common.policy.mgt.Profile;
 
@@ -167,10 +168,10 @@ public interface PolicyAdministratorPoint {
 
     /**
      * Returns a list of policies filtered by offset and limit
-     * @param request {@link PaginationRequest} contains offset and limit
+     * @param request {@link PolicyPaginationRequest} contains offset and limit and filters
      * @return {@link List<Policy>} - list of policies for current tenant
      * @throws PolicyManagementException when there is an error while retrieving the policies from database or
      * while retrieving device groups
      */
-    List<Policy> getPolicyList(PaginationRequest request) throws PolicyManagementException;
+    List<Policy> getPolicyList(PolicyPaginationRequest request) throws PolicyManagementException;
 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/dao/PolicyDAO.java

@@ -20,6 +20,7 @@ package io.entgra.device.mgt.core.policy.mgt.core.dao;
 
 import io.entgra.device.mgt.core.device.mgt.common.Device;
 import io.entgra.device.mgt.core.device.mgt.common.PaginationRequest;
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import io.entgra.device.mgt.core.device.mgt.common.policy.mgt.CorrectiveAction;
 import io.entgra.device.mgt.core.policy.mgt.common.Criterion;
 import io.entgra.device.mgt.core.device.mgt.common.policy.mgt.DeviceGroupWrapper;
@@ -202,9 +203,9 @@ public interface PolicyDAO {
     /**
      * This method is used to retrieve policies from the database based on the offset and limit
      * sent through the PaginationRequest
-     * @param request {@link PaginationRequest} contains offset and limit
+     * @param request {@link PolicyPaginationRequest} contains offset and limit and filters
      * @return {@link List<Policy>} - list of policies for current tenant
      * @throws PolicyManagerDAOException when there is an error while retrieving the policies from database
      */
-    List<Policy> getAllPolicies(PaginationRequest request) throws PolicyManagerDAOException;
+    List<Policy> getAllPolicies(PolicyPaginationRequest request) throws PolicyManagerDAOException;
 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/dao/impl/policy/GenericPolicyDAOImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.dao.impl.policy;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -41,21 +42,57 @@ public class GenericPolicyDAOImpl extends AbstractPolicyDAOImpl {
     }
 
     @Override
-    public List<Policy> getAllPolicies(PaginationRequest request) throws PolicyManagerDAOException {
+    public List<Policy> getAllPolicies(PolicyPaginationRequest request) throws PolicyManagerDAOException {
         Connection conn;
         int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId();
+        String name = request.getName();
+        String type = request.getType();
+        String status = request.getStatus();
+        int statusValue = 0;
+        boolean isPolicyNameProvided = false;
+        boolean isPolicyTypeProvided = false;
+        boolean isPolicyStatusProvided = false;
 
         try {
             conn = this.getConnection();
             String query = "SELECT * " +
                     "FROM DM_POLICY " +
-                    "WHERE TENANT_ID = ? " +
-                    "ORDER BY ID LIMIT ?,?";
+                    "WHERE TENANT_ID = ? ";
+
+            if (name != null && !name.isEmpty()) {
+                query += "AND NAME LIKE ? " ;
+                isPolicyNameProvided = true;
+            }
+
+            if (type != null && !type.isEmpty()) {
+                query += "AND POLICY_TYPE = ? " ;
+                isPolicyTypeProvided = true;
+            }
+
+            if (status != null && !status.isEmpty()) {
+                if (status.equals("ACTIVE")) {
+                    statusValue = 1;
+                }
+                query += "AND ACTIVE = ? " ;
+                isPolicyStatusProvided = true;
+            }
+
+            query += "ORDER BY ID LIMIT ?,?";
 
             try (PreparedStatement stmt = conn.prepareStatement(query)) {
-                stmt.setInt(1, tenantId);
-                stmt.setInt(2, request.getStartIndex());
-                stmt.setInt(3, request.getRowCount());
+                int paramIdx = 1;
+                stmt.setInt(paramIdx++, tenantId);
+                if (isPolicyNameProvided) {
+                    stmt.setString(paramIdx++, "%" + name + "%");
+                }
+                if (isPolicyTypeProvided) {
+                    stmt.setString(paramIdx++, type);
+                }
+                if (isPolicyStatusProvided) {
+                    stmt.setInt(paramIdx++, statusValue);
+                }
+                stmt.setInt(paramIdx++, request.getStartIndex());
+                stmt.setInt(paramIdx++, request.getRowCount());
                 try (ResultSet resultSet = stmt.executeQuery()) {
                     return this.extractPolicyListFromDbResult(resultSet, tenantId);
                 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/dao/impl/policy/OraclePolicyDAOImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.dao.impl.policy;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -40,21 +41,57 @@ public class OraclePolicyDAOImpl extends AbstractPolicyDAOImpl {
     }
 
     @Override
-    public List<Policy> getAllPolicies(PaginationRequest request) throws PolicyManagerDAOException {
+    public List<Policy> getAllPolicies(PolicyPaginationRequest request) throws PolicyManagerDAOException {
         Connection conn;
         int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId();
+        String name = request.getName();
+        String type = request.getType();
+        String status = request.getStatus();
+        int statusValue = 0;
+        boolean isPolicyNameProvided = false;
+        boolean isPolicyTypeProvided = false;
+        boolean isPolicyStatusProvided = false;
 
         try {
             conn = this.getConnection();
             String query = "SELECT * " +
                     "FROM DM_POLICY " +
-                    "WHERE TENANT_ID = ? " +
-                    "ORDER BY ID OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
+                    "WHERE TENANT_ID = ? ";
+
+            if (name != null && !name.isEmpty()) {
+                query += "AND NAME LIKE ? " ;
+                isPolicyNameProvided = true;
+            }
+
+            if (type != null && !type.isEmpty()) {
+                query += "AND POLICY_TYPE = ? " ;
+                isPolicyTypeProvided = true;
+            }
+
+            if (status != null && !status.isEmpty()) {
+                if (status.equals("ACTIVE")) {
+                    statusValue = 1;
+                }
+                query += "AND ACTIVE = ? " ;
+                isPolicyStatusProvided = true;
+            }
+
+            query += "ORDER BY ID OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
 
             try (PreparedStatement stmt = conn.prepareStatement(query)) {
-                stmt.setInt(1, tenantId);
-                stmt.setInt(2, request.getStartIndex());
-                stmt.setInt(3, request.getRowCount());
+                int paramIdx = 1;
+                stmt.setInt(paramIdx++, tenantId);
+                if (isPolicyNameProvided) {
+                    stmt.setString(paramIdx++, "%" + name + "%");
+                }
+                if (isPolicyTypeProvided) {
+                    stmt.setString(paramIdx++, type);
+                }
+                if (isPolicyStatusProvided) {
+                    stmt.setInt(paramIdx++, statusValue);
+                }
+                stmt.setInt(paramIdx++, request.getStartIndex());
+                stmt.setInt(paramIdx++, request.getRowCount());
                 try (ResultSet resultSet = stmt.executeQuery()) {
                     return this.extractPolicyListFromDbResult(resultSet, tenantId);
                 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/dao/impl/policy/PostgreSQLPolicyDAOImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.dao.impl.policy;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -40,21 +41,57 @@ public class PostgreSQLPolicyDAOImpl extends AbstractPolicyDAOImpl {
     }
 
     @Override
-    public List<Policy> getAllPolicies(PaginationRequest request) throws PolicyManagerDAOException {
+    public List<Policy> getAllPolicies(PolicyPaginationRequest request) throws PolicyManagerDAOException {
         Connection conn;
         int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId();
+        String name = request.getName();
+        String type = request.getType();
+        String status = request.getStatus();
+        int statusValue = 0;
+        boolean isPolicyNameProvided = false;
+        boolean isPolicyTypeProvided = false;
+        boolean isPolicyStatusProvided = false;
 
         try {
             conn = this.getConnection();
             String query = "SELECT * " +
                     "FROM DM_POLICY " +
-                    "WHERE TENANT_ID = ? " +
-                    "ORDER BY ID LIMIT ? OFFSET ?";
+                    "WHERE TENANT_ID = ? ";
+
+            if (name != null && !name.isEmpty()) {
+                query += "AND NAME LIKE ? " ;
+                isPolicyNameProvided = true;
+            }
+
+            if (type != null && !type.isEmpty()) {
+                query += "AND POLICY_TYPE = ? " ;
+                isPolicyTypeProvided = true;
+            }
+
+            if (status != null && !status.isEmpty()) {
+                if (status.equals("ACTIVE")) {
+                    statusValue = 1;
+                }
+                query += "AND ACTIVE = ? " ;
+                isPolicyStatusProvided = true;
+            }
+
+            query += "ORDER BY ID LIMIT ? OFFSET ?";
 
             try (PreparedStatement stmt = conn.prepareStatement(query)) {
-                stmt.setInt(1, tenantId);
-                stmt.setInt(2, request.getRowCount());
-                stmt.setInt(3, request.getStartIndex());
+                int paramIdx = 1;
+                stmt.setInt(paramIdx++, tenantId);
+                if (isPolicyNameProvided) {
+                    stmt.setString(paramIdx++, "%" + name + "%");
+                }
+                if (isPolicyTypeProvided) {
+                    stmt.setString(paramIdx++, type);
+                }
+                if (isPolicyStatusProvided) {
+                    stmt.setInt(paramIdx++, statusValue);
+                }
+                stmt.setInt(paramIdx++, request.getStartIndex());
+                stmt.setInt(paramIdx++, request.getRowCount());
                 try (ResultSet resultSet = stmt.executeQuery()) {
                     return this.extractPolicyListFromDbResult(resultSet, tenantId);
                 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/dao/impl/policy/SQLServerPolicyDAOImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.dao.impl.policy;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -40,20 +41,57 @@ public class SQLServerPolicyDAOImpl extends AbstractPolicyDAOImpl {
     }
 
     @Override
-    public List<Policy> getAllPolicies(PaginationRequest request) throws PolicyManagerDAOException {
+    public List<Policy> getAllPolicies(PolicyPaginationRequest request) throws PolicyManagerDAOException {
         Connection conn;
         int tenantId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getTenantId();
+        String name = request.getName();
+        String type = request.getType();
+        String status = request.getStatus();
+        int statusValue = 0;
+        boolean isPolicyNameProvided = false;
+        boolean isPolicyTypeProvided = false;
+        boolean isPolicyStatusProvided = false;
 
         try {
             conn = this.getConnection();
             String query = "SELECT * " +
                     "FROM DM_POLICY " +
-                    "WHERE TENANT_ID = ? " +
-                    "ORDER BY ID OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
+                    "WHERE TENANT_ID = ? ";
+
+            if (name != null && !name.isEmpty()) {
+                query += "AND NAME LIKE ? " ;
+                isPolicyNameProvided = true;
+            }
+
+            if (type != null && !type.isEmpty()) {
+                query += "AND POLICY_TYPE = ? " ;
+                isPolicyTypeProvided = true;
+            }
+
+            if (status != null && !status.isEmpty()) {
+                if (status.equals("ACTIVE")) {
+                    statusValue = 1;
+                }
+                query += "AND ACTIVE = ? " ;
+                isPolicyStatusProvided = true;
+            }
+
+            query += "ORDER BY ID OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
+
             try (PreparedStatement stmt = conn.prepareStatement(query)) {
-                stmt.setInt(1, tenantId);
-                stmt.setInt(2, request.getStartIndex());
-                stmt.setInt(3, request.getRowCount());
+                int paramIdx = 1;
+                stmt.setInt(paramIdx++, tenantId);
+                if (isPolicyNameProvided) {
+                    stmt.setString(paramIdx++, "%" + name + "%");
+                }
+                if (isPolicyTypeProvided) {
+                    stmt.setString(paramIdx++, type);
+                }
+                if (isPolicyStatusProvided) {
+                    stmt.setInt(paramIdx++, statusValue);
+                }
+                stmt.setInt(paramIdx++, request.getStartIndex());
+                stmt.setInt(paramIdx++, request.getRowCount());
                 try (ResultSet resultSet = stmt.executeQuery()) {
                     return this.extractPolicyListFromDbResult(resultSet, tenantId);
                 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/impl/PolicyAdministratorPointImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.impl;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.wso2.carbon.context.PrivilegedCarbonContext;
@@ -335,7 +336,7 @@ public class PolicyAdministratorPointImpl implements PolicyAdministratorPoint {
     }
 
     @Override
-    public List<Policy> getPolicyList(PaginationRequest request) throws PolicyManagementException {
+    public List<Policy> getPolicyList(PolicyPaginationRequest request) throws PolicyManagementException {
         return policyManager.getPolicyList(request);
     }
 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/mgt/PolicyManager.java

@@ -21,6 +21,7 @@ import io.entgra.device.mgt.core.device.mgt.common.Device;
 import io.entgra.device.mgt.core.device.mgt.common.DeviceIdentifier;
 import io.entgra.device.mgt.core.device.mgt.common.DynamicTaskContext;
 import io.entgra.device.mgt.core.device.mgt.common.PaginationRequest;
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import io.entgra.device.mgt.core.device.mgt.common.policy.mgt.Policy;
 import io.entgra.device.mgt.core.policy.mgt.common.PolicyManagementException;
 import io.entgra.device.mgt.core.policy.mgt.core.mgt.bean.UpdatedPolicyDeviceListBean;
@@ -93,10 +94,10 @@ public interface PolicyManager {
 
     /**
      * Returns list of policies with users, roles and groups attached to that policy
-     * @param request {@link PaginationRequest} contains offset and limit
+     * @param request {@link PolicyPaginationRequest} contains offset and limit and filters
      * @return {@link List<Policy>} - list of policies for current tenant
      * @throws PolicyManagementException when there is an error while retrieving the policies from database or
      * while retrieving device groups
      */
-    List<Policy> getPolicyList(PaginationRequest request) throws PolicyManagementException;
+    List<Policy> getPolicyList(PolicyPaginationRequest request) throws PolicyManagementException;
 }

components/policy-mgt/io.entgra.device.mgt.core.policy.mgt.core/src/main/java/io/entgra/device/mgt/core/policy/mgt/core/mgt/impl/PolicyManagerImpl.java

@@ -18,6 +18,7 @@
 
 package io.entgra.device.mgt.core.policy.mgt.core.mgt.impl;
 
+import io.entgra.device.mgt.core.device.mgt.common.PolicyPaginationRequest;
 import org.apache.commons.lang.StringUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -1488,7 +1489,7 @@ public class PolicyManagerImpl implements PolicyManager {
     }
 
     @Override
-    public List<Policy> getPolicyList(PaginationRequest request) throws PolicyManagementException {
+    public List<Policy> getPolicyList(PolicyPaginationRequest request) throws PolicyManagementException {
         List<Policy> policyList;
         try {
             PolicyManagementDAOFactory.openConnection();