Skip to content

Commit 29f39f6

Browse files
ustcweizhouustcweizhou
committed
listprojects/listaccounts: Add option 'details' to listProjects and listAccounts
1 parent 61ebc6a commit 29f39f6

17 files changed

Lines changed: 331 additions & 35 deletions

File tree

‎api/src/main/java/org/apache/cloudstack/api/command/user/account/ListAccountsCmd.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,22 @@
1616
// under the License.
1717
package org.apache.cloudstack.api.command.user.account;
1818

19+
import java.util.ArrayList;
20+
import java.util.EnumSet;
21+
import java.util.List;
22+
1923
import org.apache.log4j.Logger;
2024

2125
import org.apache.cloudstack.api.APICommand;
2226
import org.apache.cloudstack.api.ApiConstants;
27+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
2328
import org.apache.cloudstack.api.BaseListDomainResourcesCmd;
2429
import org.apache.cloudstack.api.Parameter;
2530
import org.apache.cloudstack.api.ResponseObject.ResponseView;
2631
import org.apache.cloudstack.api.response.AccountResponse;
2732
import org.apache.cloudstack.api.response.ListResponse;
2833

34+
import com.cloud.exception.InvalidParameterValueException;
2935
import com.cloud.user.Account;
3036

3137
@APICommand(name = "listAccounts", description = "Lists accounts and provides detailed account information for listed accounts", responseObject = AccountResponse.class, responseView = ResponseView.Restricted, entityType = {Account.class},
@@ -55,6 +61,12 @@ public class ListAccountsCmd extends BaseListDomainResourcesCmd {
5561
@Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list accounts by state. Valid states are enabled, disabled, and locked.")
5662
private String state;
5763

64+
@Parameter(name = ApiConstants.DETAILS,
65+
type = CommandType.LIST,
66+
collectionType = CommandType.STRING,
67+
description = "comma separated list of account details requested, value can be a list of [ all, resource, min]")
68+
private List<String> viewDetails;
69+
5870
/////////////////////////////////////////////////////
5971
/////////////////// Accessors ///////////////////////
6072
/////////////////////////////////////////////////////
@@ -79,6 +91,25 @@ public String getState() {
7991
return state;
8092
}
8193

94+
public EnumSet<DomainDetails> getDetails() throws InvalidParameterValueException {
95+
EnumSet<DomainDetails> dv;
96+
if (viewDetails == null || viewDetails.size() <= 0) {
97+
dv = EnumSet.of(DomainDetails.all);
98+
} else {
99+
try {
100+
ArrayList<DomainDetails> dc = new ArrayList<DomainDetails>();
101+
for (String detail : viewDetails) {
102+
dc.add(DomainDetails.valueOf(detail));
103+
}
104+
dv = EnumSet.copyOf(dc);
105+
} catch (IllegalArgumentException e) {
106+
throw new InvalidParameterValueException("The details parameter contains a non permitted value. The allowed values are " +
107+
EnumSet.allOf(DomainDetails.class));
108+
}
109+
}
110+
return dv;
111+
}
112+
82113
/////////////////////////////////////////////////////
83114
/////////////// API Implementation///////////////////
84115
/////////////////////////////////////////////////////

‎api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectsCmd.java‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@
1616
// under the License.
1717
package org.apache.cloudstack.api.command.user.project;
1818

19+
import java.util.ArrayList;
1920
import java.util.Collection;
21+
import java.util.EnumSet;
2022
import java.util.HashMap;
2123
import java.util.Iterator;
24+
import java.util.List;
2225
import java.util.Map;
2326

2427
import org.apache.log4j.Logger;
2528

2629
import org.apache.cloudstack.api.APICommand;
2730
import org.apache.cloudstack.api.ApiConstants;
31+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
2832
import org.apache.cloudstack.api.BaseListAccountResourcesCmd;
2933
import org.apache.cloudstack.api.Parameter;
3034
import org.apache.cloudstack.api.response.ListResponse;
@@ -61,6 +65,12 @@ public class ListProjectsCmd extends BaseListAccountResourcesCmd {
6165
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "List projects by tags (key/value pairs)")
6266
private Map tags;
6367

68+
@Parameter(name = ApiConstants.DETAILS,
69+
type = CommandType.LIST,
70+
collectionType = CommandType.STRING,
71+
description = "comma separated list of project details requested, value can be a list of [ all, resource, min]")
72+
private List<String> viewDetails;
73+
6474
/////////////////////////////////////////////////////
6575
/////////////////// Accessors ///////////////////////
6676
/////////////////////////////////////////////////////
@@ -105,6 +115,25 @@ public Map<String, String> getTags() {
105115
return tagsMap;
106116
}
107117

118+
public EnumSet<DomainDetails> getDetails() throws InvalidParameterValueException {
119+
EnumSet<DomainDetails> dv;
120+
if (viewDetails == null || viewDetails.size() <= 0) {
121+
dv = EnumSet.of(DomainDetails.all);
122+
} else {
123+
try {
124+
ArrayList<DomainDetails> dc = new ArrayList<DomainDetails>();
125+
for (String detail : viewDetails) {
126+
dc.add(DomainDetails.valueOf(detail));
127+
}
128+
dv = EnumSet.copyOf(dc);
129+
} catch (IllegalArgumentException e) {
130+
throw new InvalidParameterValueException("The details parameter contains a non permitted value. The allowed values are " +
131+
EnumSet.allOf(DomainDetails.class));
132+
}
133+
}
134+
return dv;
135+
}
136+
108137
/////////////////////////////////////////////////////
109138
/////////////// API Implementation///////////////////
110139
/////////////////////////////////////////////////////

‎server/src/main/java/com/cloud/api/ApiDBUtils.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1766,8 +1766,8 @@ public static UserAccountJoinVO newUserView(UserAccount usr) {
17661766
return s_userAccountJoinDao.newUserView(usr);
17671767
}
17681768

1769-
public static ProjectResponse newProjectResponse(ProjectJoinVO proj) {
1770-
return s_projectJoinDao.newProjectResponse(proj);
1769+
public static ProjectResponse newProjectResponse(EnumSet<DomainDetails> details, ProjectJoinVO proj) {
1770+
return s_projectJoinDao.newProjectResponse(details, proj);
17711771
}
17721772

17731773
public static ProjectResponse fillProjectDetails(ProjectResponse rsp, ProjectJoinVO proj) {
@@ -1875,8 +1875,8 @@ public static DomainResponse newDomainResponse(ResponseView view, EnumSet<Domain
18751875
return s_domainJoinDao.newDomainResponse(view, details, ve);
18761876
}
18771877

1878-
public static AccountResponse newAccountResponse(ResponseView view, AccountJoinVO ve) {
1879-
AccountResponse response = s_accountJoinDao.newAccountResponse(view, ve);
1878+
public static AccountResponse newAccountResponse(ResponseView view, EnumSet<DomainDetails> details, AccountJoinVO ve) {
1879+
AccountResponse response = s_accountJoinDao.newAccountResponse(view, details, ve);
18801880
// Populate account role information
18811881
if (ve.getRoleId() != null) {
18821882
Role role = s_roleService.findRole(ve.getRoleId());

‎server/src/main/java/com/cloud/api/ApiResponseHelper.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import org.apache.cloudstack.acl.ControlledEntity.ACLType;
3636
import org.apache.cloudstack.affinity.AffinityGroup;
3737
import org.apache.cloudstack.affinity.AffinityGroupResponse;
38+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
3839
import org.apache.cloudstack.api.ApiConstants.HostDetails;
3940
import org.apache.cloudstack.api.ApiConstants.VMDetails;
4041
import org.apache.cloudstack.api.ResponseGenerator;
@@ -380,13 +381,13 @@ public UserResponse createUserResponse(User user) {
380381
// creates an account + user)
381382
@Override
382383
public AccountResponse createUserAccountResponse(ResponseView view, UserAccount user) {
383-
return ApiDBUtils.newAccountResponse(view, ApiDBUtils.findAccountViewById(user.getAccountId()));
384+
return ApiDBUtils.newAccountResponse(view, EnumSet.of(DomainDetails.all), ApiDBUtils.findAccountViewById(user.getAccountId()));
384385
}
385386

386387
@Override
387388
public AccountResponse createAccountResponse(ResponseView view, Account account) {
388389
AccountJoinVO vUser = ApiDBUtils.newAccountView(account);
389-
return ApiDBUtils.newAccountResponse(view, vUser);
390+
return ApiDBUtils.newAccountResponse(view, EnumSet.of(DomainDetails.all), vUser);
390391
}
391392

392393
@Override
@@ -2284,7 +2285,7 @@ public Long getSecurityGroupId(String groupName, long accountId) {
22842285
@Override
22852286
public ProjectResponse createProjectResponse(Project project) {
22862287
List<ProjectJoinVO> viewPrjs = ApiDBUtils.newProjectView(project);
2287-
List<ProjectResponse> listPrjs = ViewResponseHelper.createProjectResponse(viewPrjs.toArray(new ProjectJoinVO[viewPrjs.size()]));
2288+
List<ProjectResponse> listPrjs = ViewResponseHelper.createProjectResponse(EnumSet.of(DomainDetails.all), viewPrjs.toArray(new ProjectJoinVO[viewPrjs.size()]));
22882289
assert listPrjs != null && listPrjs.size() == 1 : "There should be one project returned";
22892290
return listPrjs.get(0);
22902291
}

‎server/src/main/java/com/cloud/api/query/QueryManagerImpl.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1261,7 +1261,7 @@ private Pair<List<DomainRouterJoinVO>, Integer> searchForRoutersInternal(BaseLis
12611261
public ListResponse<ProjectResponse> listProjects(ListProjectsCmd cmd) {
12621262
Pair<List<ProjectJoinVO>, Integer> projects = listProjectsInternal(cmd);
12631263
ListResponse<ProjectResponse> response = new ListResponse<ProjectResponse>();
1264-
List<ProjectResponse> projectResponses = ViewResponseHelper.createProjectResponse(projects.first().toArray(new ProjectJoinVO[projects.first().size()]));
1264+
List<ProjectResponse> projectResponses = ViewResponseHelper.createProjectResponse(cmd.getDetails(), projects.first().toArray(new ProjectJoinVO[projects.first().size()]));
12651265
response.setResponses(projectResponses, projects.second());
12661266
return response;
12671267
}
@@ -1921,7 +1921,7 @@ public ListResponse<AccountResponse> searchForAccounts(ListAccountsCmd cmd) {
19211921
respView = ResponseView.Full;
19221922
}
19231923

1924-
List<AccountResponse> accountResponses = ViewResponseHelper.createAccountResponse(respView, result.first().toArray(new AccountJoinVO[result.first().size()]));
1924+
List<AccountResponse> accountResponses = ViewResponseHelper.createAccountResponse(respView, cmd.getDetails(), result.first().toArray(new AccountJoinVO[result.first().size()]));
19251925
response.setResponses(accountResponses, result.second());
19261926
return response;
19271927
}

‎server/src/main/java/com/cloud/api/query/ViewResponseHelper.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,14 +195,14 @@ public static List<SecurityGroupResponse> createSecurityGroupResponses(List<Secu
195195
return new ArrayList<SecurityGroupResponse>(vrDataList.values());
196196
}
197197

198-
public static List<ProjectResponse> createProjectResponse(ProjectJoinVO... projects) {
198+
public static List<ProjectResponse> createProjectResponse(EnumSet<DomainDetails> details, ProjectJoinVO... projects) {
199199
Hashtable<Long, ProjectResponse> prjDataList = new Hashtable<Long, ProjectResponse>();
200200
// Initialise the prjdatalist with the input data
201201
for (ProjectJoinVO p : projects) {
202202
ProjectResponse pData = prjDataList.get(p.getId());
203203
if (pData == null) {
204204
// first time encountering this vm
205-
pData = ApiDBUtils.newProjectResponse(p);
205+
pData = ApiDBUtils.newProjectResponse(details, p);
206206
} else {
207207
// update those 1 to many mapping fields
208208
pData = ApiDBUtils.fillProjectDetails(pData, p);
@@ -541,10 +541,10 @@ private static void setParentResourceLimitIfNeeded(Map<Resource.ResourceType, Lo
541541
}
542542
}
543543

544-
public static List<AccountResponse> createAccountResponse(ResponseView view, AccountJoinVO... accounts) {
544+
public static List<AccountResponse> createAccountResponse(ResponseView view, EnumSet<DomainDetails> details, AccountJoinVO... accounts) {
545545
List<AccountResponse> respList = new ArrayList<AccountResponse>();
546546
for (AccountJoinVO vt : accounts){
547-
respList.add(ApiDBUtils.newAccountResponse(view, vt));
547+
respList.add(ApiDBUtils.newAccountResponse(view, details, vt));
548548
}
549549
return respList;
550550
}

‎server/src/main/java/com/cloud/api/query/dao/AccountJoinDao.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
// under the License.
1717
package com.cloud.api.query.dao;
1818

19+
import java.util.EnumSet;
20+
21+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
1922
import org.apache.cloudstack.api.ResponseObject.ResponseView;
2023
import org.apache.cloudstack.api.response.AccountResponse;
2124
import org.apache.cloudstack.api.response.ResourceLimitAndCountResponse;
@@ -26,7 +29,7 @@
2629

2730
public interface AccountJoinDao extends GenericDao<AccountJoinVO, Long> {
2831

29-
AccountResponse newAccountResponse(ResponseView view, AccountJoinVO vol);
32+
AccountResponse newAccountResponse(ResponseView view, EnumSet<DomainDetails> details, AccountJoinVO vol);
3033

3134
AccountJoinVO newAccountView(Account vol);
3235

‎server/src/main/java/com/cloud/api/query/dao/AccountJoinDaoImpl.java‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@
1616
// under the License.
1717
package com.cloud.api.query.dao;
1818

19+
import java.util.EnumSet;
1920
import java.util.List;
2021

2122
import javax.inject.Inject;
2223

2324
import org.apache.log4j.Logger;
2425
import org.springframework.stereotype.Component;
2526

27+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
2628
import org.apache.cloudstack.api.ResponseObject.ResponseView;
2729
import org.apache.cloudstack.api.response.AccountResponse;
2830
import org.apache.cloudstack.api.response.ResourceLimitAndCountResponse;
@@ -57,7 +59,7 @@ protected AccountJoinDaoImpl() {
5759
}
5860

5961
@Override
60-
public AccountResponse newAccountResponse(ResponseView view, AccountJoinVO account) {
62+
public AccountResponse newAccountResponse(ResponseView view, EnumSet<DomainDetails> details, AccountJoinVO account) {
6163
AccountResponse accountResponse = new AccountResponse();
6264
accountResponse.setId(account.getUuid());
6365
accountResponse.setName(account.getAccountName());
@@ -76,17 +78,19 @@ public AccountResponse newAccountResponse(ResponseView view, AccountJoinVO accou
7678
accountResponse.setBytesReceived(account.getBytesReceived());
7779
accountResponse.setBytesSent(account.getBytesSent());
7880

79-
boolean fullView = (view == ResponseView.Full && _acctMgr.isRootAdmin(account.getId()));
80-
setResourceLimits(account, fullView, accountResponse);
81-
82-
//get resource limits for projects
83-
long projectLimit = ApiDBUtils.findCorrectResourceLimit(account.getProjectLimit(), account.getId(), ResourceType.project);
84-
String projectLimitDisplay = (fullView || projectLimit == -1) ? "Unlimited" : String.valueOf(projectLimit);
85-
long projectTotal = (account.getProjectTotal() == null) ? 0 : account.getProjectTotal();
86-
String projectAvail = (fullView || projectLimit == -1) ? "Unlimited" : String.valueOf(projectLimit - projectTotal);
87-
accountResponse.setProjectLimit(projectLimitDisplay);
88-
accountResponse.setProjectTotal(projectTotal);
89-
accountResponse.setProjectAvailable(projectAvail);
81+
if (details.contains(DomainDetails.all) || details.contains(DomainDetails.resource)) {
82+
boolean fullView = (view == ResponseView.Full && _acctMgr.isRootAdmin(account.getId()));
83+
setResourceLimits(account, fullView, accountResponse);
84+
85+
//get resource limits for projects
86+
long projectLimit = ApiDBUtils.findCorrectResourceLimit(account.getProjectLimit(), account.getId(), ResourceType.project);
87+
String projectLimitDisplay = (fullView || projectLimit == -1) ? "Unlimited" : String.valueOf(projectLimit);
88+
long projectTotal = (account.getProjectTotal() == null) ? 0 : account.getProjectTotal();
89+
String projectAvail = (fullView || projectLimit == -1) ? "Unlimited" : String.valueOf(projectLimit - projectTotal);
90+
accountResponse.setProjectLimit(projectLimitDisplay);
91+
accountResponse.setProjectTotal(projectTotal);
92+
accountResponse.setProjectAvailable(projectAvail);
93+
}
9094

9195
// set async job
9296
if (account.getJobId() != null) {

‎server/src/main/java/com/cloud/api/query/dao/ProjectJoinDao.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@
1616
// under the License.
1717
package com.cloud.api.query.dao;
1818

19+
import java.util.EnumSet;
1920
import java.util.List;
2021

22+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
2123
import org.apache.cloudstack.api.response.ProjectResponse;
2224

2325
import com.cloud.api.query.vo.ProjectJoinVO;
@@ -26,7 +28,7 @@
2628

2729
public interface ProjectJoinDao extends GenericDao<ProjectJoinVO, Long> {
2830

29-
ProjectResponse newProjectResponse(ProjectJoinVO proj);
31+
ProjectResponse newProjectResponse(EnumSet<DomainDetails> details, ProjectJoinVO proj);
3032

3133
ProjectResponse setProjectResponse(ProjectResponse rsp, ProjectJoinVO proj);
3234

‎server/src/main/java/com/cloud/api/query/dao/ProjectJoinDaoImpl.java‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@
1717
package com.cloud.api.query.dao;
1818

1919
import java.util.ArrayList;
20+
import java.util.EnumSet;
2021
import java.util.List;
2122

23+
2224
import javax.inject.Inject;
2325

2426
import org.apache.log4j.Logger;
2527
import org.springframework.stereotype.Component;
2628

29+
import org.apache.cloudstack.api.ApiConstants.DomainDetails;
2730
import org.apache.cloudstack.api.response.ProjectResponse;
2831
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
2932

@@ -67,7 +70,7 @@ protected ProjectJoinDaoImpl() {
6770
}
6871

6972
@Override
70-
public ProjectResponse newProjectResponse(ProjectJoinVO proj) {
73+
public ProjectResponse newProjectResponse(EnumSet<DomainDetails> details, ProjectJoinVO proj) {
7174
ProjectResponse response = new ProjectResponse();
7275
response.setId(proj.getUuid());
7376
response.setName(proj.getName());
@@ -91,9 +94,11 @@ public ProjectResponse newProjectResponse(ProjectJoinVO proj) {
9194

9295
//set resource limit/count information for the project (by getting the info of the project's account)
9396
Account account = _accountDao.findByIdIncludingRemoved(proj.getProjectAccountId());
94-
AccountJoinVO accountJn = ApiDBUtils.newAccountView(account);
95-
_accountJoinDao.setResourceLimits(accountJn, false, response);
96-
response.setProjectAccountName(accountJn.getAccountName());
97+
if (details.contains(DomainDetails.all) || details.contains(DomainDetails.resource)) {
98+
AccountJoinVO accountJn = ApiDBUtils.newAccountView(account);
99+
_accountJoinDao.setResourceLimits(accountJn, false, response);
100+
}
101+
response.setProjectAccountName(account.getAccountName());
97102

98103
response.setObjectName("project");
99104
return response;

0 commit comments

Comments
 (0)