You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2019/03/25 07:41:02 UTC
[cloudstack] branch master updated: api: rename ListUsageRecords
file name to ListUsageRecordsCmd (#3151)
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cloudstack.git
The following commit(s) were added to refs/heads/master by this push:
new 0d21f0c api: rename ListUsageRecords file name to ListUsageRecordsCmd (#3151)
0d21f0c is described below
commit 0d21f0c1e797f89513824c99ee48cdf42e4c6116
Author: Dingane Hlaluku <dr...@gmail.com>
AuthorDate: Mon Mar 25 09:40:53 2019 +0200
api: rename ListUsageRecords file name to ListUsageRecordsCmd (#3151)
* Rename ListUsageRecords API command file name to ListUsageRecordsCmd
* Refactor to use APINAME variable and remove unused s_logger field
* Remove unused import
---
...ageRecordsCmd.java => ListUsageRecordsCmd.java} | 40 +++++++++++-----------
.../org/apache/cloudstack/usage/UsageService.java | 4 +--
.../cloudstack/api/command/test/UsageCmdTest.java | 36 +++++++++----------
.../com/cloud/api/dispatch/ParamProcessWorker.java | 4 +--
.../com/cloud/server/ManagementServerImpl.java | 4 +--
.../java/com/cloud/usage/UsageServiceImpl.java | 4 +--
6 files changed, 46 insertions(+), 46 deletions(-)
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/GetUsageRecordsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListUsageRecordsCmd.java
similarity index 83%
rename from api/src/main/java/org/apache/cloudstack/api/command/admin/usage/GetUsageRecordsCmd.java
rename to api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListUsageRecordsCmd.java
index 90bc4f2..605439f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/GetUsageRecordsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListUsageRecordsCmd.java
@@ -22,28 +22,27 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
-import org.apache.log4j.Logger;
-
+import com.cloud.utils.Pair;
import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseCmd;
import org.apache.cloudstack.api.BaseListCmd;
import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.response.AccountResponse;
import org.apache.cloudstack.api.response.DomainResponse;
import org.apache.cloudstack.api.response.ListResponse;
import org.apache.cloudstack.api.response.ProjectResponse;
-import org.apache.cloudstack.api.response.UsageRecordResponse;
import org.apache.cloudstack.api.response.ResourceTagResponse;
+import org.apache.cloudstack.api.response.UsageRecordResponse;
import org.apache.cloudstack.usage.Usage;
-import com.cloud.utils.Pair;
-
-@APICommand(name = "listUsageRecords", description = "Lists usage records for accounts", responseObject = UsageRecordResponse.class,
- requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
-public class GetUsageRecordsCmd extends BaseListCmd {
- public static final Logger s_logger = Logger.getLogger(GetUsageRecordsCmd.class.getName());
-
- private static final String s_name = "listusagerecordsresponse";
+@APICommand(name = ListUsageRecordsCmd.APINAME,
+ description = "Lists usage records for accounts",
+ responseObject = UsageRecordResponse.class,
+ requestHasSensitiveInfo = false,
+ responseHasSensitiveInfo = false)
+public class ListUsageRecordsCmd extends BaseListCmd {
+ public static final String APINAME = "listUsageRecords";
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
@@ -56,15 +55,15 @@ public class GetUsageRecordsCmd extends BaseListCmd {
private Long domainId;
@Parameter(name = ApiConstants.END_DATE,
- type = CommandType.DATE,
- required = true,
- description = "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).")
+ type = CommandType.DATE,
+ required = true,
+ description = "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).")
private Date endDate;
@Parameter(name = ApiConstants.START_DATE,
- type = CommandType.DATE,
- required = true,
- description = "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).")
+ type = CommandType.DATE,
+ required = true,
+ description = "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).")
private Date startDate;
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "List usage records for the specified account")
@@ -117,6 +116,7 @@ public class GetUsageRecordsCmd extends BaseListCmd {
public String getUsageId() {
return usageId;
}
+
public void setAccountName(String accountName) {
this.accountName = accountName;
}
@@ -152,7 +152,7 @@ public class GetUsageRecordsCmd extends BaseListCmd {
@Override
public String getCommandName() {
- return s_name;
+ return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX;
}
@Override
@@ -163,8 +163,8 @@ public class GetUsageRecordsCmd extends BaseListCmd {
Map<String, Set<ResourceTagResponse>> resourceTagResponseMap = null;
if (usageRecords != null) {
//read the resource tags details for all the resources in usage data and store in Map
- if(null != includeTags && includeTags) {
- resourceTagResponseMap = _responseGenerator.getUsageResourceTags();
+ if (null != includeTags && includeTags) {
+ resourceTagResponseMap = _responseGenerator.getUsageResourceTags();
}
for (Usage usageRecord : usageRecords.first()) {
UsageRecordResponse usageResponse = _responseGenerator.createUsageResponse(usageRecord, resourceTagResponseMap);
diff --git a/api/src/main/java/org/apache/cloudstack/usage/UsageService.java b/api/src/main/java/org/apache/cloudstack/usage/UsageService.java
index 2345e59..73962ba 100644
--- a/api/src/main/java/org/apache/cloudstack/usage/UsageService.java
+++ b/api/src/main/java/org/apache/cloudstack/usage/UsageService.java
@@ -18,7 +18,7 @@ package org.apache.cloudstack.usage;
import com.cloud.utils.Pair;
import org.apache.cloudstack.api.command.admin.usage.GenerateUsageRecordsCmd;
-import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
+import org.apache.cloudstack.api.command.admin.usage.ListUsageRecordsCmd;
import org.apache.cloudstack.api.command.admin.usage.RemoveRawUsageRecordsCmd;
import org.apache.cloudstack.api.response.UsageTypeResponse;
@@ -52,7 +52,7 @@ public interface UsageService {
* the appropriate page number)
* @return a list of usage records
*/
- Pair<List<? extends Usage>, Integer> getUsageRecords(GetUsageRecordsCmd cmd);
+ Pair<List<? extends Usage>, Integer> getUsageRecords(ListUsageRecordsCmd cmd);
/**
* Retrieves the timezone used for usage aggregation. One day is represented as midnight to 11:59:59pm
diff --git a/api/src/test/java/org/apache/cloudstack/api/command/test/UsageCmdTest.java b/api/src/test/java/org/apache/cloudstack/api/command/test/UsageCmdTest.java
index e5f3e27..cc7b0f7 100644
--- a/api/src/test/java/org/apache/cloudstack/api/command/test/UsageCmdTest.java
+++ b/api/src/test/java/org/apache/cloudstack/api/command/test/UsageCmdTest.java
@@ -28,7 +28,7 @@ import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.mockito.Mockito;
-import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
+import org.apache.cloudstack.api.command.admin.usage.ListUsageRecordsCmd;
import org.apache.cloudstack.usage.Usage;
import org.apache.cloudstack.usage.UsageService;
@@ -36,7 +36,7 @@ import com.cloud.utils.Pair;
public class UsageCmdTest extends TestCase {
- private GetUsageRecordsCmd getUsageRecordsCmd;
+ private ListUsageRecordsCmd listUsageRecordsCmd;
@Rule
public ExpectedException expectedException = ExpectedException.none();
@@ -45,7 +45,7 @@ public class UsageCmdTest extends TestCase {
@Before
public void setUp() {
- getUsageRecordsCmd = new GetUsageRecordsCmd() {
+ listUsageRecordsCmd = new ListUsageRecordsCmd() {
};
}
@@ -53,8 +53,8 @@ public class UsageCmdTest extends TestCase {
@Test
public void testExecuteSuccess() {
UsageService usageService = Mockito.mock(UsageService.class);
- getUsageRecordsCmd._usageService = usageService;
- getUsageRecordsCmd.execute();
+ listUsageRecordsCmd._usageService = usageService;
+ listUsageRecordsCmd.execute();
}
@Test
@@ -64,29 +64,29 @@ public class UsageCmdTest extends TestCase {
Pair<List<? extends Usage>, Integer> usageRecords = new Pair<List<? extends Usage>, Integer>(new ArrayList<Usage>(), new Integer(0));
- Mockito.when(usageService.getUsageRecords(getUsageRecordsCmd)).thenReturn(usageRecords);
+ Mockito.when(usageService.getUsageRecords(listUsageRecordsCmd)).thenReturn(usageRecords);
- getUsageRecordsCmd._usageService = usageService;
- getUsageRecordsCmd.execute();
+ listUsageRecordsCmd._usageService = usageService;
+ listUsageRecordsCmd.execute();
}
@Test
public void testCrud() {
- getUsageRecordsCmd.setDomainId(1L);
- assertTrue(getUsageRecordsCmd.getDomainId().equals(1L));
+ listUsageRecordsCmd.setDomainId(1L);
+ assertTrue(listUsageRecordsCmd.getDomainId().equals(1L));
- getUsageRecordsCmd.setAccountName("someAccount");
- assertTrue(getUsageRecordsCmd.getAccountName().equals("someAccount"));
+ listUsageRecordsCmd.setAccountName("someAccount");
+ assertTrue(listUsageRecordsCmd.getAccountName().equals("someAccount"));
Date d = new Date();
- getUsageRecordsCmd.setStartDate(d);
- getUsageRecordsCmd.setEndDate(d);
- assertTrue(getUsageRecordsCmd.getStartDate().equals(d));
- assertTrue(getUsageRecordsCmd.getEndDate().equals(d));
+ listUsageRecordsCmd.setStartDate(d);
+ listUsageRecordsCmd.setEndDate(d);
+ assertTrue(listUsageRecordsCmd.getStartDate().equals(d));
+ assertTrue(listUsageRecordsCmd.getEndDate().equals(d));
- getUsageRecordsCmd.setUsageId("someId");
- assertTrue(getUsageRecordsCmd.getUsageId().equals("someId"));
+ listUsageRecordsCmd.setUsageId("someId");
+ assertTrue(listUsageRecordsCmd.getUsageId().equals("someId"));
}
}
diff --git a/server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java b/server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java
index 970e62f..b1051a7 100644
--- a/server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java
+++ b/server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java
@@ -50,7 +50,7 @@ import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.ServerApiException;
import org.apache.cloudstack.api.command.admin.resource.ArchiveAlertsCmd;
import org.apache.cloudstack.api.command.admin.resource.DeleteAlertsCmd;
-import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
+import org.apache.cloudstack.api.command.admin.usage.ListUsageRecordsCmd;
import org.apache.cloudstack.api.command.user.event.ArchiveEventsCmd;
import org.apache.cloudstack.api.command.user.event.DeleteEventsCmd;
import org.apache.cloudstack.api.command.user.event.ListEventsCmd;
@@ -308,7 +308,7 @@ public class ParamProcessWorker implements DispatchWorker {
// This piece of code is for maintaining backward compatibility
// and support both the date formats(Bug 9724)
if (cmdObj instanceof ListEventsCmd || cmdObj instanceof DeleteEventsCmd || cmdObj instanceof ArchiveEventsCmd ||
- cmdObj instanceof ArchiveAlertsCmd || cmdObj instanceof DeleteAlertsCmd || cmdObj instanceof GetUsageRecordsCmd) {
+ cmdObj instanceof ArchiveAlertsCmd || cmdObj instanceof DeleteAlertsCmd || cmdObj instanceof ListUsageRecordsCmd) {
final boolean isObjInNewDateFormat = isObjInNewDateFormat(paramObj.toString());
if (isObjInNewDateFormat) {
final DateFormat newFormat = newInputFormat;
diff --git a/server/src/main/java/com/cloud/server/ManagementServerImpl.java b/server/src/main/java/com/cloud/server/ManagementServerImpl.java
index 0b846b9..b211cab 100644
--- a/server/src/main/java/com/cloud/server/ManagementServerImpl.java
+++ b/server/src/main/java/com/cloud/server/ManagementServerImpl.java
@@ -217,7 +217,7 @@ import org.apache.cloudstack.api.command.admin.usage.AddTrafficTypeCmd;
import org.apache.cloudstack.api.command.admin.usage.DeleteTrafficMonitorCmd;
import org.apache.cloudstack.api.command.admin.usage.DeleteTrafficTypeCmd;
import org.apache.cloudstack.api.command.admin.usage.GenerateUsageRecordsCmd;
-import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
+import org.apache.cloudstack.api.command.admin.usage.ListUsageRecordsCmd;
import org.apache.cloudstack.api.command.admin.usage.ListTrafficMonitorsCmd;
import org.apache.cloudstack.api.command.admin.usage.ListTrafficTypeImplementorsCmd;
import org.apache.cloudstack.api.command.admin.usage.ListTrafficTypesCmd;
@@ -2703,7 +2703,7 @@ public class ManagementServerImpl extends ManagerBase implements ManagementServe
cmdList.add(DeleteTrafficMonitorCmd.class);
cmdList.add(DeleteTrafficTypeCmd.class);
cmdList.add(GenerateUsageRecordsCmd.class);
- cmdList.add(GetUsageRecordsCmd.class);
+ cmdList.add(ListUsageRecordsCmd.class);
cmdList.add(RemoveRawUsageRecordsCmd.class);
cmdList.add(ListTrafficMonitorsCmd.class);
cmdList.add(ListTrafficTypeImplementorsCmd.class);
diff --git a/server/src/main/java/com/cloud/usage/UsageServiceImpl.java b/server/src/main/java/com/cloud/usage/UsageServiceImpl.java
index efd8ef4..531b291 100644
--- a/server/src/main/java/com/cloud/usage/UsageServiceImpl.java
+++ b/server/src/main/java/com/cloud/usage/UsageServiceImpl.java
@@ -56,7 +56,7 @@ import com.cloud.utils.db.TransactionLegacy;
import com.cloud.vm.VMInstanceVO;
import com.cloud.vm.dao.VMInstanceDao;
import org.apache.cloudstack.api.command.admin.usage.GenerateUsageRecordsCmd;
-import org.apache.cloudstack.api.command.admin.usage.GetUsageRecordsCmd;
+import org.apache.cloudstack.api.command.admin.usage.ListUsageRecordsCmd;
import org.apache.cloudstack.api.command.admin.usage.RemoveRawUsageRecordsCmd;
import org.apache.cloudstack.api.response.UsageTypeResponse;
import org.apache.cloudstack.context.CallContext;
@@ -159,7 +159,7 @@ public class UsageServiceImpl extends ManagerBase implements UsageService, Manag
}
@Override
- public Pair<List<? extends Usage>, Integer> getUsageRecords(GetUsageRecordsCmd cmd) {
+ public Pair<List<? extends Usage>, Integer> getUsageRecords(ListUsageRecordsCmd cmd) {
Long accountId = cmd.getAccountId();
Long domainId = cmd.getDomainId();
String accountName = cmd.getAccountName();