#23 Give the Class a Better Name and Documentation

Weltraumschaf · Weltraumschaf · commit f1fd8ff4a887 · 2024-02-09T10:01:01.000+01:00
Signed-off-by: Sven Strittmatter &lt;sven.strittmatter@iteratec.com&gt;
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/model/PaginatedResult.java b/src/main/java/io/securecodebox/persistence/defectdojo/model/PaginatedResult.java
@@ -9,10 +9,13 @@
 
 import java.util.List;
 
-// TODO: Why we do not have as many annotations as the other models here?
-// TODO: Why does this class does not implement Model?
+/**
+ * This class wraps the paginated results from DefectDojo
+ *
+ * @param <T> type of results
+ */
 @Data
-public final class Response<T> {
+public final class PaginatedResult<T> {
   @JsonProperty
   private int count;
 
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/EndpointService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/EndpointService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Endpoint;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class EndpointService extends GenericDefectDojoService<Endpoint> {
   public EndpointService(Config config) {
@@ -26,7 +26,7 @@ protected Class<Endpoint> getModelClass() {
   }
 
   @Override
-  protected Response<Endpoint> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Endpoint> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/EngagementService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/EngagementService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Engagement;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class EngagementService extends GenericDefectDojoService<Engagement> {
   public EngagementService(Config config) {
@@ -26,7 +26,7 @@ protected Class<Engagement> getModelClass() {
   }
 
   @Override
-  protected Response<Engagement> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Engagement> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/FindingService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/FindingService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Finding;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 import java.net.URISyntaxException;
 import java.util.List;
@@ -30,7 +30,7 @@ protected Class<Finding> getModelClass() {
   }
 
   @Override
-  protected Response<Finding> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Finding> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/GenericDefectDojoService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/GenericDefectDojoService.java
@@ -16,7 +16,7 @@
 import io.securecodebox.persistence.defectdojo.http.ProxyConfigFactory;
 import io.securecodebox.persistence.defectdojo.model.Engagement;
 import io.securecodebox.persistence.defectdojo.model.Model;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import lombok.Getter;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
@@ -87,7 +87,7 @@ private RestTemplate setupRestTemplate() {
 
   protected abstract Class<T> getModelClass();
 
-  protected abstract Response<T> deserializeList(String response) throws JsonProcessingException;
+  protected abstract PaginatedResult<T> deserializeList(String response) throws JsonProcessingException;
 
   public T get(long id) {
     var restTemplate = this.getRestTemplate();
@@ -103,7 +103,7 @@ public T get(long id) {
     return response.getBody();
   }
 
-  protected Response<T> internalSearch(Map<String, Object> queryParams, long limit, long offset) throws JsonProcessingException, URISyntaxException {
+  protected PaginatedResult<T> internalSearch(Map<String, Object> queryParams, long limit, long offset) throws JsonProcessingException, URISyntaxException {
     var restTemplate = this.getRestTemplate();
     HttpEntity<String> payload = new HttpEntity<>(getDefectDojoAuthorizationHeaders());
 
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/GroupMemberService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/GroupMemberService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.GroupMember;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class GroupMemberService extends GenericDefectDojoService<GroupMember> {
   public GroupMemberService(Config config) {
@@ -26,7 +26,7 @@ protected Class<GroupMember> getModelClass() {
   }
 
   @Override
-  protected Response<GroupMember> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<GroupMember> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/GroupService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/GroupService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Group;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class GroupService extends GenericDefectDojoService<Group> {
   public GroupService(Config config) {
@@ -26,7 +26,7 @@ protected Class<Group> getModelClass() {
   }
 
   @Override
-  protected Response<Group> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Group> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductGroupService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductGroupService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.ProductGroup;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class ProductGroupService extends GenericDefectDojoService<ProductGroup> {
   public ProductGroupService(Config config) {
@@ -26,7 +26,7 @@ protected Class<ProductGroup> getModelClass() {
   }
 
   @Override
-  protected Response<ProductGroup> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ProductGroup> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Product;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class ProductService extends GenericDefectDojoService<Product> {
 
@@ -27,7 +27,7 @@ protected Class<Product> getModelClass() {
   }
 
   @Override
-  protected Response<Product> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Product> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductTypeService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/ProductTypeService.java
@@ -8,7 +8,7 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.ProductType;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 
 public class ProductTypeService extends GenericDefectDojoService<ProductType> {
 
@@ -27,7 +27,7 @@ protected Class<ProductType> getModelClass() {
   }
 
   @Override
-  protected Response<ProductType> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ProductType> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/TestService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/TestService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.Test;
 
 public class TestService extends GenericDefectDojoService<Test> {
@@ -26,7 +26,7 @@ protected Class<Test> getModelClass() {
   }
 
   @Override
-  protected Response<Test> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Test> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/TestTypeService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/TestTypeService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.TestType;
 
 public class TestTypeService extends GenericDefectDojoService<TestType> {
@@ -26,7 +26,7 @@ protected Class<TestType> getModelClass() {
   }
 
   @Override
-  protected Response<TestType> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<TestType> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/ToolConfigService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/ToolConfigService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.ToolConfig;
 
 public class ToolConfigService extends GenericDefectDojoService<ToolConfig> {
@@ -26,7 +26,7 @@ protected Class<ToolConfig> getModelClass() {
   }
 
   @Override
-  protected Response<ToolConfig> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ToolConfig> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/ToolTypeService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/ToolTypeService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.ToolType;
 
 public class ToolTypeService extends GenericDefectDojoService<ToolType> {
@@ -31,7 +31,7 @@ protected Class<ToolType> getModelClass() {
   }
 
   @Override
-  protected Response<ToolType> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ToolType> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/UserProfileService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/UserProfileService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.UserProfile;
 
 import java.util.ArrayList;
@@ -30,15 +30,15 @@ protected Class<UserProfile> getModelClass() {
   }
 
   @Override
-  protected Response<UserProfile> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<UserProfile> deserializeList(String response) throws JsonProcessingException {
     // GenericDefectDojoService expects that the response from the defectdojo api is a list
     // This endpoint returns a single object though, to not break the code this response gets converted to a defectdojo response
     UserProfile userProfile = this.objectMapper.readValue(response, new TypeReference<>() {
     });
     List<UserProfile> userProfileList = new ArrayList<>();
     userProfileList.add(userProfile);
 
-    Response<UserProfile> fakeResult = new Response<>();
+    PaginatedResult<UserProfile> fakeResult = new PaginatedResult<>();
     fakeResult.setResults(userProfileList);
     fakeResult.setCount(1);
     return fakeResult;
diff --git a/src/main/java/io/securecodebox/persistence/defectdojo/service/UserService.java b/src/main/java/io/securecodebox/persistence/defectdojo/service/UserService.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
 import io.securecodebox.persistence.defectdojo.config.Config;
-import io.securecodebox.persistence.defectdojo.model.Response;
+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.User;
 
 public class UserService extends GenericDefectDojoService<User> {
@@ -26,7 +26,7 @@ protected Class<User> getModelClass() {
   }
 
   @Override
-  protected Response<User> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<User> deserializeList(String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }
diff --git a/src/test/java/io/securecodebox/persistence/defectdojo/model/PaginatedResultTest.java b/src/test/java/io/securecodebox/persistence/defectdojo/model/PaginatedResultTest.java
@@ -5,12 +5,12 @@
 import org.junit.jupiter.api.Test;
 
 /**
- * Tests for {@link Response}
+ * Tests for {@link PaginatedResult}
  */
-class ResponseTest {
+class PaginatedResultTest {
   @Test
   void equalsAndHashCode() {
-    EqualsVerifier.forClass(Response.class)
+    EqualsVerifier.forClass(PaginatedResult.class)
       .suppress(Warning.NONFINAL_FIELDS)
       .verify();
   }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`import com.fasterxml.jackson.core.type.TypeReference;`
`9`	`9`	`import io.securecodebox.persistence.defectdojo.config.Config;`
`10`	`10`	`import io.securecodebox.persistence.defectdojo.model.Product;`
`11`		`-import io.securecodebox.persistence.defectdojo.model.Response;`
	`11`	`+import io.securecodebox.persistence.defectdojo.model.PaginatedResult;`
`12`	`12`
`13`	`13`	`public class ProductService extends GenericDefectDojoService<Product> {`
`14`	`14`
`@@ -27,7 +27,7 @@ protected Class<Product> getModelClass() {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override`
`30`		`- protected Response<Product> deserializeList(String response) throws JsonProcessingException {`
	`30`	`+ protected PaginatedResult<Product> deserializeList(String response) throws JsonProcessingException {`
`31`	`31`	`return this.objectMapper.readValue(response, new TypeReference<>() {`
`32`	`32`	`});`
`33`	`33`	`}`