Add ID param to list ldapConf API & delete ldapConf API

Pearl1594 · Pearl1594 · commit 5558fe0e2343 · 2025-09-29T21:54:36.000-04:00
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/command/LdapDeleteConfigurationCmd.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/command/LdapDeleteConfigurationCmd.java
@@ -40,8 +40,10 @@ public class LdapDeleteConfigurationCmd extends BaseCmd {
     @Inject
     private LdapManager _ldapManager;
 
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = false, entityType = LdapConfigurationResponse.class, description = "ID of the LDAP configuration")
+    private Long id;
 
-    @Parameter(name = ApiConstants.HOST_NAME, type = CommandType.STRING, required = true, description = "Hostname")
+    @Parameter(name = ApiConstants.HOST_NAME, type = CommandType.STRING, description = "Hostname")
     private String hostname;
 
     @Parameter(name = ApiConstants.PORT, type = CommandType.INTEGER, required = false, description = "port")
@@ -71,6 +73,10 @@ public Long getDomainId() {
         return domainId;
     }
 
+    public Long getId() {
+        return id;
+    }
+
     @Override
     public void execute() throws ServerApiException {
         try {
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/command/LdapListConfigurationCmd.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/command/LdapListConfigurationCmd.java
@@ -53,6 +53,9 @@ public class LdapListConfigurationCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, required = false, entityType = DomainResponse.class, description = "linked domain")
     private Long domainId;
 
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LdapConfigurationResponse.class, description = "list ldap configuration by ID")
+    private Long id;
+
     @Parameter(name = ApiConstants.LIST_ALL, type = CommandType.BOOLEAN, description = "If set to true, "
     + " and no domainid specified, list all LDAP configurations irrespective of the linked domain", since = "4.13.2")
     private Boolean listAll;
@@ -120,6 +123,10 @@ public void setDomainId(final Long domainId) {
         this.domainId = domainId;
     }
 
+    public Long getId() {
+        return id;
+    }
+
     public boolean listAll() {
         return listAll != null && listAll;
     }
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/response/LdapConfigurationResponse.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/api/response/LdapConfigurationResponse.java
@@ -23,9 +23,9 @@
 
 import com.cloud.serializer.Param;
 import org.apache.cloudstack.api.EntityReference;
-import org.apache.cloudstack.ldap.LdapConfiguration;
+import org.apache.cloudstack.ldap.LdapConfigurationVO;
 
-@EntityReference(value = LdapConfiguration.class)
+@EntityReference(value = LdapConfigurationVO.class)
 public class LdapConfigurationResponse extends BaseResponse {
     @SerializedName("id")
     @Param(description = "the ID of the LDAP configuration")
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/LdapConfigurationVO.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/LdapConfigurationVO.java
@@ -23,21 +23,22 @@
 import javax.persistence.Id;
 import javax.persistence.Table;
 
+import org.apache.cloudstack.api.Identity;
 import org.apache.cloudstack.api.InternalIdentity;
 
 import java.util.UUID;
 
 @Entity
 @Table(name = "ldap_configuration")
-public class LdapConfigurationVO implements InternalIdentity {
-    @Column(name = "hostname")
-    private String hostname;
-
+public class LdapConfigurationVO implements Identity, InternalIdentity {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "id")
     private Long id;
 
+    @Column(name = "hostname")
+    private String hostname;
+
     @Column(name = "uuid")
     private String uuid;
 
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/LdapManagerImpl.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/LdapManagerImpl.java
@@ -52,6 +52,7 @@
 import org.apache.cloudstack.ldap.dao.LdapConfigurationDao;
 import org.apache.cloudstack.ldap.dao.LdapTrustMapDao;
 import org.apache.commons.lang.Validate;
+import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Component;
 
 import com.cloud.domain.DomainVO;
@@ -257,6 +258,19 @@ public LdapUserResponse createLdapUserResponse(final LdapUser user) {
 
     @Override
     public LdapConfigurationResponse deleteConfiguration(final LdapDeleteConfigurationCmd cmd) throws InvalidParameterValueException {
+        Long id = cmd.getId();
+        String hostname = cmd.getHostname();
+        if (id == null && StringUtils.isEmpty(hostname)) {
+            throw new InvalidParameterValueException("Either id or hostname must be specified");
+        }
+        if (id != null) {
+            final LdapConfigurationVO config = _ldapConfigurationDao.findById(cmd.getId());
+            if (config != null) {
+                _ldapConfigurationDao.remove(config.getId());
+                return createLdapConfigurationResponse(config);
+            }
+            throw new InvalidParameterValueException("Cannot find configuration with id " + id);
+        }
         return deleteConfigurationInternal(cmd.getHostname(), cmd.getPort(), cmd.getDomainId());
     }
 
@@ -377,7 +391,8 @@ public Pair<List<? extends LdapConfigurationVO>, Integer> listConfigurations(fin
         final int port = cmd.getPort();
         final Long domainId = cmd.getDomainId();
         final boolean listAll = cmd.listAll();
-        final Pair<List<LdapConfigurationVO>, Integer> result = _ldapConfigurationDao.searchConfigurations(hostname, port, domainId, listAll);
+        final Long id = cmd.getId();
+        final Pair<List<LdapConfigurationVO>, Integer> result = _ldapConfigurationDao.searchConfigurations(id, hostname, port, domainId, listAll);
         return new Pair<List<? extends LdapConfigurationVO>, Integer>(result.first(), result.second());
     }
 
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/dao/LdapConfigurationDao.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/dao/LdapConfigurationDao.java
@@ -41,5 +41,5 @@ public interface LdapConfigurationDao extends GenericDao<LdapConfigurationVO, Lo
 
     Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(String hostname, int port, Long domainId);
 
-    Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(String hostname, int port, Long domainId, boolean listAll);
+    Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(Long id, String hostname, int port, Long domainId, boolean listAll);
 }
diff --git a/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/dao/LdapConfigurationDaoImpl.java b/plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/dao/LdapConfigurationDaoImpl.java
@@ -48,6 +48,7 @@ public LdapConfigurationDaoImpl() {
         listGlobalConfigurationsSearch.done();
 
         listDomainConfigurationsSearch = createSearchBuilder();
+        listDomainConfigurationsSearch.and("id", listDomainConfigurationsSearch.entity().getId(), SearchCriteria.Op.EQ);
         listDomainConfigurationsSearch.and("hostname", listDomainConfigurationsSearch.entity().getHostname(), Op.EQ);
         listDomainConfigurationsSearch.and("port", listDomainConfigurationsSearch.entity().getPort(), Op.EQ);
         listDomainConfigurationsSearch.and("domain_id", listDomainConfigurationsSearch.entity().getDomainId(), Op.EQ);
@@ -63,31 +64,35 @@ public LdapConfigurationVO findByHostname(final String hostname) {
 
     @Override
     public LdapConfigurationVO find(String hostname, int port, Long domainId) {
-        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(hostname, port, domainId, false);
+        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(null, hostname, port, domainId, false);
         return findOneBy(sc);
     }
 
     @Override
     public LdapConfigurationVO find(String hostname, int port, Long domainId, boolean listAll) {
-        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(hostname, port, domainId, listAll);
+        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(null, hostname, port, domainId, listAll);
         return findOneBy(sc);
     }
 
     @Override
     public Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(final String hostname, final int port, final Long domainId) {
-        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(hostname, port, domainId, false);
+        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(null, hostname, port, domainId, false);
         return searchAndCount(sc, null);
     }
 
     @Override
-    public Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(final String hostname, final int port, final Long domainId, final boolean listAll) {
-        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(hostname, port, domainId, listAll);
+    public Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(final Long id, final String hostname, final int port, final Long domainId, final boolean listAll) {
+        SearchCriteria<LdapConfigurationVO> sc = getSearchCriteria(id, hostname, port, domainId, listAll);
         return searchAndCount(sc, null);
     }
 
-    private SearchCriteria<LdapConfigurationVO> getSearchCriteria(String hostname, int port, Long domainId,boolean listAll) {
+    private SearchCriteria<LdapConfigurationVO> getSearchCriteria(Long id, String hostname, int port, Long domainId,boolean listAll) {
         SearchCriteria<LdapConfigurationVO> sc;
-        if (domainId != null) {
+        if (id != null) {
+            // If id is present, ignore all other parameters
+            sc = listDomainConfigurationsSearch.create();
+            sc.setParameters("id", id);
+        } else if (domainId != null) {
             // If domainid is present, ignore listall
             sc = listDomainConfigurationsSearch.create();
             sc.setParameters("domain_id", domainId);
diff --git a/ui/src/config/section/config.js b/ui/src/config/section/config.js
@@ -41,7 +41,7 @@ export default {
       permission: ['listLdapConfigurations'],
       searchFilters: ['domainid', 'hostname', 'port'],
       columns: ['hostname', 'port', 'domainid'],
-      details: ['hostname', 'port', 'domainid'],
+      details: ['id', 'hostname', 'port', 'domainid'],
       actions: [
         {
           api: 'addLdapConfiguration',
diff --git a/ui/src/views/AutogenView.vue b/ui/src/views/AutogenView.vue
@@ -1078,8 +1078,6 @@ export default {
         }
         if (this.$route.path.startsWith('/vmsnapshot/')) {
           params.vmsnapshotid = this.$route.params.id
-        } else if (this.$route.path.startsWith('/ldapsetting/')) {
-          params.hostname = this.$route.params.id
         }
         if (this.$route.path.startsWith('/tungstenpolicy/')) {
           params.policyuuid = this.$route.params.id
@@ -1192,9 +1190,6 @@ export default {
               this.items[idx][key] = func(this.items[idx])
             }
           }
-          if (this.$route.path.startsWith('/ldapsetting')) {
-            this.items[idx].id = this.items[idx].hostname
-          }
         }
         if (this.items.length > 0) {
           if (!this.showAction || this.dataView) {

Original file line number	Diff line number	Diff line change
`@@ -41,5 +41,5 @@ public interface LdapConfigurationDao extends GenericDao<LdapConfigurationVO, Lo`
`41`	`41`
`42`	`42`	`Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(String hostname, int port, Long domainId);`
`43`	`43`
`44`		`- Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(String hostname, int port, Long domainId, boolean listAll);`
	`44`	`+ Pair<List<LdapConfigurationVO>, Integer> searchConfigurations(Long id, String hostname, int port, Long domainId, boolean listAll);`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export default {`
`41`	`41`	`permission: ['listLdapConfigurations'],`
`42`	`42`	`searchFilters: ['domainid', 'hostname', 'port'],`
`43`	`43`	`columns: ['hostname', 'port', 'domainid'],`
`44`		`- details: ['hostname', 'port', 'domainid'],`
	`44`	`+ details: ['id', 'hostname', 'port', 'domainid'],`
`45`	`45`	`actions: [`
`46`	`46`	`{`
`47`	`47`	`api: 'addLdapConfiguration',`
Original file line number	Diff line number	Diff line change
`@@ -1078,8 +1078,6 @@ export default {`
`1078`	`1078`	`}`
`1079`	`1079`	`if (this.$route.path.startsWith('/vmsnapshot/')) {`
`1080`	`1080`	`params.vmsnapshotid = this.$route.params.id`
`1081`		`- } else if (this.$route.path.startsWith('/ldapsetting/')) {`
`1082`		`- params.hostname = this.$route.params.id`
`1083`	`1081`	`}`
`1084`	`1082`	`if (this.$route.path.startsWith('/tungstenpolicy/')) {`
`1085`	`1083`	`params.policyuuid = this.$route.params.id`
`@@ -1192,9 +1190,6 @@ export default {`
`1192`	`1190`	`this.items[idx][key] = func(this.items[idx])`
`1193`	`1191`	`}`
`1194`	`1192`	`}`
`1195`		`- if (this.$route.path.startsWith('/ldapsetting')) {`
`1196`		`- this.items[idx].id = this.items[idx].hostname`
`1197`		`- }`
`1198`	`1193`	`}`
`1199`	`1194`	`if (this.items.length > 0) {`
`1200`	`1195`	`if (!this.showAction \|\| this.dataView) {`