summaryrefslogtreecommitdiffstats
path: root/sonar-ws
diff options
context:
space:
mode:
authorJulien Lancelot <julien.lancelot@sonarsource.com>2017-08-03 19:12:44 +0200
committerJanos Gyerik <janos.gyerik@sonarsource.com>2017-09-12 10:55:10 +0200
commit682128592478eff93567b11bcc7d083bf23f56b4 (patch)
tree4ab4a79b4c7b28cff17dfebac67c7cc21bea78e8 /sonar-ws
parent6e7b6d89e87413ce7139f8fa269f88cffda1a44e (diff)
downloadsonarqube-682128592478eff93567b11bcc7d083bf23f56b4.tar.gz
sonarqube-682128592478eff93567b11bcc7d083bf23f56b4.zip
SONAR-9676 Clean component parameters in api/measures/component
- deprecate componentId - rename componentKey to component - deprecate id in response
Diffstat (limited to 'sonar-ws')
-rw-r--r--sonar-ws/src/main/java/org/sonarqube/ws/client/measure/ComponentWsRequest.java27
-rw-r--r--sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresService.java9
-rw-r--r--sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresWsParameters.java4
3 files changed, 34 insertions, 6 deletions
diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/ComponentWsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/ComponentWsRequest.java
index 4c2fbf2ce2e..998ac57209f 100644
--- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/ComponentWsRequest.java
+++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/ComponentWsRequest.java
@@ -26,31 +26,58 @@ import javax.annotation.Nullable;
public class ComponentWsRequest {
private String componentId;
private String componentKey;
+ private String component;
private List<String> metricKeys;
private List<String> additionalFields;
private String developerId;
private String developerKey;
+ /**
+ * @deprecated since 6.6, please use {@link #getComponent()} instead
+ */
+ @Deprecated
@CheckForNull
public String getComponentId() {
return componentId;
}
+ /**
+ * @deprecated since 6.6, please use {@link #setComponent(String)} instead
+ */
+ @Deprecated
public ComponentWsRequest setComponentId(@Nullable String componentId) {
this.componentId = componentId;
return this;
}
+ /**
+ * @deprecated since 6.6, please use {@link #getComponent()} instead
+ */
+ @Deprecated
@CheckForNull
public String getComponentKey() {
return componentKey;
}
+ /**
+ * @deprecated since 6.6, please use {@link #setComponent(String)} instead
+ */
+ @Deprecated
public ComponentWsRequest setComponentKey(@Nullable String componentKey) {
this.componentKey = componentKey;
return this;
}
+ @CheckForNull
+ public String getComponent() {
+ return component;
+ }
+
+ public ComponentWsRequest setComponent(@Nullable String component) {
+ this.component = component;
+ return this;
+ }
+
public List<String> getMetricKeys() {
return metricKeys;
}
diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresService.java
index 470dfa7fa29..f81d8b9a72b 100644
--- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresService.java
+++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresService.java
@@ -32,13 +32,13 @@ import static org.sonarqube.ws.client.measure.MeasuresWsParameters.ACTION_COMPON
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.ACTION_COMPONENT_TREE;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.ACTION_SEARCH_HISTORY;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.CONTROLLER_MEASURES;
+import static org.sonarqube.ws.client.measure.MeasuresWsParameters.DEPRECATED_PARAM_COMPONENT_ID;
+import static org.sonarqube.ws.client.measure.MeasuresWsParameters.DEPRECATED_PARAM_COMPONENT_KEY;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_ADDITIONAL_FIELDS;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_BASE_COMPONENT_ID;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_BASE_COMPONENT_KEY;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_BRANCH;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_COMPONENT;
-import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_COMPONENT_ID;
-import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_COMPONENT_KEY;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_DEVELOPER_ID;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_DEVELOPER_KEY;
import static org.sonarqube.ws.client.measure.MeasuresWsParameters.PARAM_FROM;
@@ -79,8 +79,9 @@ public class MeasuresService extends BaseService {
public ComponentWsResponse component(ComponentWsRequest request) {
GetRequest getRequest = new GetRequest(path(ACTION_COMPONENT))
- .setParam(PARAM_COMPONENT_ID, request.getComponentId())
- .setParam(PARAM_COMPONENT_KEY, request.getComponentKey())
+ .setParam(DEPRECATED_PARAM_COMPONENT_ID, request.getComponentId())
+ .setParam(DEPRECATED_PARAM_COMPONENT_KEY, request.getComponentKey())
+ .setParam(PARAM_COMPONENT, request.getComponent())
.setParam(PARAM_ADDITIONAL_FIELDS, inlineMultipleParamValue(request.getAdditionalFields()))
.setParam(PARAM_METRIC_KEYS, inlineMultipleParamValue(request.getMetricKeys()))
.setParam(PARAM_DEVELOPER_ID, request.getDeveloperId())
diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresWsParameters.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresWsParameters.java
index 48599358cc4..70b7c27496d 100644
--- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresWsParameters.java
+++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measure/MeasuresWsParameters.java
@@ -43,8 +43,8 @@ public class MeasuresWsParameters {
public static final String PARAM_METRIC_PERIOD_SORT = "metricPeriodSort";
public static final String PARAM_METRIC_SORT_FILTER = "metricSortFilter";
public static final String PARAM_ADDITIONAL_FIELDS = "additionalFields";
- public static final String PARAM_COMPONENT_ID = "componentId";
- public static final String PARAM_COMPONENT_KEY = "componentKey";
+ public static final String DEPRECATED_PARAM_COMPONENT_ID = "componentId";
+ public static final String DEPRECATED_PARAM_COMPONENT_KEY = "componentKey";
public static final String PARAM_PROJECT_KEYS = "projectKeys";
public static final String PARAM_DEVELOPER_ID = "developerId";
public static final String PARAM_DEVELOPER_KEY = "developerKey";