Skip to content

Commit 330fa1b

Browse files
emeroademeroad
committed
[#noissue] Cleanup Response
1 parent 5157e23 commit 330fa1b

File tree

22 files changed

+112
-97
lines changed

22 files changed

+112
-97
lines changed

‎collector/src/main/java/com/navercorp/pinpoint/collector/manage/controller/AuthInterceptor.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818

1919
import com.fasterxml.jackson.core.JsonProcessingException;
2020
import com.fasterxml.jackson.databind.ObjectMapper;
21+
import com.navercorp.pinpoint.common.server.response.MapResponse;
22+
import com.navercorp.pinpoint.common.server.response.Result;
2123
import jakarta.servlet.http.HttpServletRequest;
2224
import jakarta.servlet.http.HttpServletResponse;
2325
import org.apache.commons.lang3.StringUtils;
@@ -79,7 +81,7 @@ public boolean preHandle(HttpServletRequest request, HttpServletResponse respons
7981
}
8082

8183
private String jsonError(String errorMessage) throws JsonProcessingException {
82-
SimpleResponse response = new SimpleResponse(false, errorMessage);
84+
MapResponse response = new MapResponse(Result.FAIL, errorMessage);
8385
return mapper.writeValueAsString(response);
8486
}
8587

‎collector/src/main/java/com/navercorp/pinpoint/collector/manage/controller/HandlerManagerController.java

+13-10
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
package com.navercorp.pinpoint.collector.manage.controller;
1818

1919
import com.navercorp.pinpoint.collector.manage.HandlerManager;
20+
import com.navercorp.pinpoint.common.server.response.MapResponse;
21+
import com.navercorp.pinpoint.common.server.response.Response;
22+
import com.navercorp.pinpoint.common.server.response.Result;
2023
import org.springframework.http.HttpStatus;
2124
import org.springframework.http.ResponseEntity;
2225
import org.springframework.web.bind.annotation.GetMapping;
@@ -39,10 +42,10 @@ public HandlerManagerController(HandlerManager handlerManager) {
3942
}
4043

4144
@GetMapping(value = "/enableAccess")
42-
public ResponseEntity<SimpleResponse> enableAccess() {
45+
public ResponseEntity<Response> enableAccess() {
4346
try {
4447
handlerManager.enableAccess();
45-
return ResponseEntity.ok(SimpleResponse.success());
48+
return ResponseEntity.ok(MapResponse.ok());
4649
} catch (Exception e) {
4750
return unauthorizedResponse(e.getMessage());
4851
}
@@ -51,27 +54,27 @@ public ResponseEntity<SimpleResponse> enableAccess() {
5154

5255

5356
@GetMapping(value = "/disableAccess")
54-
public ResponseEntity<SimpleResponse> disableAccess() {
57+
public ResponseEntity<Response> disableAccess() {
5558
try {
5659
handlerManager.disableAccess();
57-
return ResponseEntity.ok(SimpleResponse.success());
60+
return ResponseEntity.ok(MapResponse.ok());
5861
} catch (Exception e) {
5962
return unauthorizedResponse(e.getMessage());
6063
}
6164
}
6265

6366
@GetMapping(value = "/isEnable")
64-
public ResponseEntity<SimpleResponse> isEnable() {
67+
public ResponseEntity<Response> isEnable() {
6568
boolean isEnable = handlerManager.isEnable();
6669

67-
SimpleResponse simpleResponse = SimpleResponse.success();
68-
simpleResponse.addAttribute("isEnable", isEnable);
70+
MapResponse response = new MapResponse(Result.SUCCESS);
71+
response.addAttribute("isEnable", isEnable);
6972

70-
return ResponseEntity.ok(simpleResponse);
73+
return ResponseEntity.ok(response);
7174
}
7275

73-
private ResponseEntity<SimpleResponse> unauthorizedResponse(String errorMessage) {
74-
SimpleResponse body = new SimpleResponse(false, errorMessage);
76+
private ResponseEntity<Response> unauthorizedResponse(String errorMessage) {
77+
MapResponse body = new MapResponse(Result.FAIL, errorMessage);
7578
return ResponseEntity.status(HttpStatus.FORBIDDEN).body(body);
7679
}
7780
}

‎collector/src/main/java/com/navercorp/pinpoint/collector/manage/controller/SimpleResponse.java renamed to ‎commons-server/src/main/java/com/navercorp/pinpoint/common/server/response/MapResponse.java

+8-24
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,26 @@
1-
package com.navercorp.pinpoint.collector.manage.controller;
1+
package com.navercorp.pinpoint.common.server.response;
22

33
import com.fasterxml.jackson.annotation.JsonAnyGetter;
44
import com.fasterxml.jackson.annotation.JsonInclude;
5-
import com.navercorp.pinpoint.common.server.response.Response;
65

76
import java.util.HashMap;
87
import java.util.Map;
98
import java.util.Objects;
109

1110
@JsonInclude(JsonInclude.Include.NON_NULL)
12-
public class SimpleResponse implements Response {
13-
private final boolean result;
14-
private final String message;
11+
public class MapResponse extends SimpleResponse {
1512
private Map<String, Object> attributeMap;
1613

17-
public static SimpleResponse success() {
18-
return new SimpleResponse(true);
14+
public static Response ok() {
15+
return new MapResponse(Result.SUCCESS);
1916
}
2017

21-
public SimpleResponse(boolean result, String message) {
22-
this.result = result;
23-
this.message = message;
18+
public MapResponse(Result result, String message) {
19+
super(result, message);
2420
}
2521

26-
public SimpleResponse(boolean result) {
27-
this.result = result;
28-
this.message = null;
29-
}
30-
31-
public String getResult() {
32-
if (result) {
33-
return "success";
34-
}
35-
return "fail";
36-
}
37-
38-
public String getMessage() {
39-
return message;
22+
public MapResponse(Result result) {
23+
super(result);
4024
}
4125

4226
public void addAttribute(String attributeName, Object attributeValue) {

‎commons-server/src/main/java/com/navercorp/pinpoint/common/server/response/Response.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
package com.navercorp.pinpoint.common.server.response;
22

33
public interface Response {
4-
}
4+
Result getResult();
5+
}

‎commons-server/src/main/java/com/navercorp/pinpoint/common/server/response/Result.java

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package com.navercorp.pinpoint.common.server.response;
2+
3+
public enum Result {
4+
SUCCESS, FAIL;
5+
6+
public static Result of(boolean success) {
7+
if (success) {
8+
return SUCCESS;
9+
}
10+
return FAIL;
11+
}
12+
}

‎commons-server/src/main/java/com/navercorp/pinpoint/common/server/response/SuccessResponse.java renamed to ‎commons-server/src/main/java/com/navercorp/pinpoint/common/server/response/SimpleResponse.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@
44

55
import java.util.Objects;
66

7-
public class SuccessResponse implements Response {
8-
private final String result;
7+
public class SimpleResponse implements Response {
8+
private final Result result;
99
private final String message;
1010

1111
public static Response ok() {
12-
return new SuccessResponse("SUCCESS");
12+
return new SimpleResponse(Result.SUCCESS);
1313
}
1414

1515
public static Response ok(String message) {
16-
return new SuccessResponse("SUCCESS", message);
16+
return new SimpleResponse(Result.SUCCESS, message);
1717
}
1818

19-
public SuccessResponse(String result) {
19+
public SimpleResponse(Result result) {
2020
this(result, null);
2121
}
2222

23-
public SuccessResponse(String result, String message) {
23+
public SimpleResponse(Result result, String message) {
2424
this.result = Objects.requireNonNull(result, "result");
2525
this.message = message;
26-
2726
}
2827

29-
public String getResult() {
28+
@Override
29+
public Result getResult() {
3030
return result;
3131
}
3232

‎web/src/main/java/com/navercorp/pinpoint/web/authorization/controller/AlarmController.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
package com.navercorp.pinpoint.web.authorization.controller;
1818

1919
import com.navercorp.pinpoint.common.server.response.Response;
20-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
20+
import com.navercorp.pinpoint.common.server.response.Result;
21+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
2122
import com.navercorp.pinpoint.common.util.StringUtils;
2223
import com.navercorp.pinpoint.web.alarm.CheckerCategory;
2324
import com.navercorp.pinpoint.web.alarm.vo.Rule;
@@ -62,7 +63,7 @@ public AlarmResponse insertRule(@RequestBody Rule rule) {
6263
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "there is not applicationId/checkerName/userGroupId/threashold to insert alarm rule");
6364
}
6465
final String ruleId = alarmService.insertRule(rule);
65-
return new AlarmResponse("SUCCESS", ruleId);
66+
return new AlarmResponse(Result.SUCCESS, ruleId);
6667
}
6768

6869
@DeleteMapping
@@ -71,7 +72,7 @@ public Response deleteRule(@RequestBody Rule rule) {
7172
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "there is not ruleId to delete alarm rule");
7273
}
7374
alarmService.deleteRule(rule);
74-
return SuccessResponse.ok();
75+
return SimpleResponse.ok();
7576
}
7677

7778
@GetMapping(params = USER_GROUP_ID)
@@ -93,7 +94,7 @@ public Response updateRule(@RequestBody Rule rule) {
9394
);
9495
}
9596
alarmService.updateRule(rule);
96-
return SuccessResponse.ok();
97+
return SimpleResponse.ok();
9798
}
9899

99100
@GetMapping(value = "/checker")

‎web/src/main/java/com/navercorp/pinpoint/web/authorization/controller/UserController.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
package com.navercorp.pinpoint.web.authorization.controller;
1717

1818
import com.navercorp.pinpoint.common.server.response.Response;
19-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
19+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
2020
import com.navercorp.pinpoint.common.util.StringUtils;
2121
import com.navercorp.pinpoint.web.service.UserService;
2222
import com.navercorp.pinpoint.web.util.ValueValidator;
@@ -65,7 +65,7 @@ public Response insertUser(@RequestBody User user) {
6565
);
6666
}
6767
userService.insertUser(user);
68-
return SuccessResponse.ok();
68+
return SimpleResponse.ok();
6969
}
7070

7171
@DeleteMapping
@@ -77,7 +77,7 @@ public Response deleteUser(@RequestBody User user) {
7777
);
7878
}
7979
userService.deleteUser(user.getUserId());
80-
return SuccessResponse.ok();
80+
return SimpleResponse.ok();
8181
}
8282

8383
@GetMapping(params = "userId")
@@ -129,7 +129,7 @@ public Response updateUser(@RequestBody User user) {
129129
);
130130
}
131131
userService.updateUser(user);
132-
return SuccessResponse.ok();
132+
return SimpleResponse.ok();
133133
}
134134

135135
}

‎web/src/main/java/com/navercorp/pinpoint/web/authorization/controller/UserGroupController.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
package com.navercorp.pinpoint.web.authorization.controller;
1717

1818
import com.navercorp.pinpoint.common.server.response.Response;
19-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
19+
import com.navercorp.pinpoint.common.server.response.Result;
20+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
2021
import com.navercorp.pinpoint.common.util.StringUtils;
2122
import com.navercorp.pinpoint.web.response.CreateUserGroupResponse;
2223
import com.navercorp.pinpoint.web.service.UserGroupService;
@@ -71,7 +72,7 @@ public CreateUserGroupResponse createUserGroup(@RequestBody UserGroup userGroup)
7172

7273
try {
7374
final String userGroupNumber = userGroupService.createUserGroup(userGroup);
74-
return new CreateUserGroupResponse("SUCCESS", userGroupNumber);
75+
return new CreateUserGroupResponse(Result.SUCCESS, userGroupNumber);
7576
} catch (PinpointUserGroupException e) {
7677
logger.error(e.getMessage(), e);
7778
throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, e.getMessage());
@@ -89,7 +90,7 @@ public Response deleteUserGroup(@RequestBody UserGroup userGroup) {
8990

9091
try {
9192
userGroupService.deleteUserGroup(userGroup);
92-
return SuccessResponse.ok();
93+
return SimpleResponse.ok();
9394
} catch (PinpointUserGroupException e) {
9495
logger.error(e.getMessage(), e);
9596
throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, e.getMessage());
@@ -122,7 +123,7 @@ public Response insertUserGroupMember(@RequestBody UserGroupMemberParam userGrou
122123
);
123124
}
124125
userGroupService.insertMember(userGroupMember);
125-
return SuccessResponse.ok();
126+
return SimpleResponse.ok();
126127
}
127128

128129
@DeleteMapping(value = "/member")
@@ -135,7 +136,7 @@ public Response deleteUserGroupMember(@RequestBody UserGroupMemberParam userGrou
135136
);
136137
}
137138
userGroupService.deleteMember(userGroupMember);
138-
return SuccessResponse.ok();
139+
return SimpleResponse.ok();
139140
}
140141

141142
@GetMapping(value = "/member")

‎web/src/main/java/com/navercorp/pinpoint/web/authorization/controller/WebhookAlarmController.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
package com.navercorp.pinpoint.web.authorization.controller;
1919

2020
import com.navercorp.pinpoint.common.server.response.Response;
21-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
21+
import com.navercorp.pinpoint.common.server.response.Result;
22+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
2223
import com.navercorp.pinpoint.web.alarm.vo.Rule;
2324
import com.navercorp.pinpoint.web.response.AlarmResponse;
2425
import com.navercorp.pinpoint.web.webhook.WebhookModule;
@@ -57,7 +58,7 @@ public AlarmResponse insertRuleWithWebhooks(@RequestBody RuleWithWebhooks ruleWi
5758
}
5859

5960
final String ruleId = webhookAlarmServiceFacade.insertRuleWithWebhooks(rule, ruleWithWebhooks.getWebhookIds());
60-
return new AlarmResponse("SUCCESS", ruleId);
61+
return new AlarmResponse(Result.SUCCESS, ruleId);
6162
}
6263

6364
@PutMapping(value = "/includeWebhooks")
@@ -67,7 +68,7 @@ public Response updateRuleWithWebhooks(@RequestBody RuleWithWebhooks ruleWithWeb
6768
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "there is not ruleId/userGroupId/applicationid/checkerName to update alarm rule");
6869
}
6970
webhookAlarmServiceFacade.updateRuleWithWebhooks(rule, ruleWithWebhooks.getWebhookIds());
70-
return SuccessResponse.ok();
71+
return SimpleResponse.ok();
7172
}
7273

7374
static public class RuleWithWebhooks {

‎web/src/main/java/com/navercorp/pinpoint/web/controller/AgentStatisticsController.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
package com.navercorp.pinpoint.web.controller;
1818

1919
import com.navercorp.pinpoint.common.server.response.Response;
20-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
20+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
2121
import com.navercorp.pinpoint.common.server.util.time.Range;
2222
import com.navercorp.pinpoint.web.service.AgentStatisticsService;
2323
import com.navercorp.pinpoint.web.util.DateTimeUtils;
@@ -65,7 +65,7 @@ public Response insertAgentCount(
6565
boolean success = agentStatisticsService.insertAgentCount(agentCountStatistics);
6666

6767
if (success) {
68-
return SuccessResponse.ok();
68+
return SimpleResponse.ok();
6969
} else {
7070
throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "insert DAO error.");
7171
}

‎web/src/main/java/com/navercorp/pinpoint/web/response/AlarmResponse.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
package com.navercorp.pinpoint.web.response;
22

33
import com.fasterxml.jackson.annotation.JsonInclude;
4-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
4+
import com.navercorp.pinpoint.common.server.response.Result;
5+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
56

6-
public class AlarmResponse extends SuccessResponse {
7+
public class AlarmResponse extends SimpleResponse {
78
private final String ruleId;
89

9-
public AlarmResponse(String result, String ruleId) {
10+
public AlarmResponse(Result result, String ruleId) {
1011
super(result);
1112
this.ruleId = ruleId;
1213
}

‎web/src/main/java/com/navercorp/pinpoint/web/response/CreateUserGroupResponse.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
package com.navercorp.pinpoint.web.response;
22

3-
import com.navercorp.pinpoint.common.server.response.SuccessResponse;
3+
import com.navercorp.pinpoint.common.server.response.Result;
4+
import com.navercorp.pinpoint.common.server.response.SimpleResponse;
45

56
import java.util.Objects;
67

7-
public class CreateUserGroupResponse extends SuccessResponse {
8+
public class CreateUserGroupResponse extends SimpleResponse {
89
private final String number;
910

10-
public CreateUserGroupResponse(String result, String number) {
11+
public CreateUserGroupResponse(Result result, String number) {
1112
super(result);
1213
this.number = Objects.requireNonNull(number, "number");
1314
}

0 commit comments

Comments
 (0)