Move Public API to top of Class

The structure of code should be ordered, so that the more abstract
API is at the top and the more nitty gritty details are below. This
has the advantage that one interested in an quick overview need not
to scroll up and down. You only need to scroll down for details.

Also add some null-checks and missing API doc.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

src/main/java/io/securecodebox/persistence/defectdojo/service/EndpointService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Endpoint;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
+import lombok.NonNull;
 
 public class EndpointService extends GenericDefectDojoService<Endpoint> {
   public EndpointService(Config config) {
@@ -26,7 +27,7 @@ protected Class<Endpoint> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Endpoint> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Endpoint> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/EngagementService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Engagement;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
+import lombok.NonNull;
 
 public class EngagementService extends GenericDefectDojoService<Engagement> {
   public EngagementService(Config config) {
@@ -26,7 +27,7 @@ protected Class<Engagement> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Engagement> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Engagement> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/FindingService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Finding;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
+import lombok.NonNull;
 
 import java.net.URISyntaxException;
 import java.util.List;
@@ -30,7 +31,7 @@ protected Class<Finding> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Finding> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Finding> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/GenericDefectDojoService.java

@@ -38,7 +38,7 @@
 
 // TODO: Remove JsonProcessingException, URISyntaxException from public API and use a own runtime exception type bc these checked exceptions clutter the client coe.
 @Slf4j
-abstract class GenericDefectDojoService<T extends Model> implements DefectDojoService<T>{
+abstract class GenericDefectDojoService<T extends Model> implements DefectDojoService<T> {
   private static final String API_PREFIX = "/api/v2/";
   private static final long DEFECT_DOJO_OBJET_LIMIT = 100L;
   protected Config config;
@@ -66,33 +66,6 @@ public GenericDefectDojoService(@NonNull Config config) {
     this.restTemplate = this.setupRestTemplate();
   }
 
-
-  /**
-   * @return The DefectDojo Authentication Header
-   */
-  private HttpHeaders getDefectDojoAuthorizationHeaders() {
-    return new Foo(config, new ProxyConfigFactory().create()).generateAuthorizationHeaders();
-  }
-
-  private RestTemplate setupRestTemplate() {
-    RestTemplate restTemplate = new Foo(config, new ProxyConfigFactory().create()).createRestTemplate();
-    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
-    converter.setObjectMapper(this.objectMapper);
-    restTemplate.setMessageConverters(List.of(
-      new FormHttpMessageConverter(),
-      new ResourceHttpMessageConverter(),
-      new StringHttpMessageConverter(),
-      converter
-    ));
-    return restTemplate;
-  }
-
-  protected abstract String getUrlPath();
-
-  protected abstract Class<T> getModelClass();
-
-  protected abstract PaginatedResult<T> deserializeList(String response) throws JsonProcessingException;
-
   @Override
   public final T get(long id) {
     var restTemplate = this.getRestTemplate();
@@ -110,34 +83,6 @@ public final T get(long id) {
     return response.getBody();
   }
 
-  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());
-
-    var mutableQueryParams = new HashMap<>(queryParams);
-
-    mutableQueryParams.put("limit", String.valueOf(limit));
-    mutableQueryParams.put("offset", String.valueOf(offset));
-
-    var multiValueMap = new LinkedMultiValueMap<String, String>();
-    for (var entry : mutableQueryParams.entrySet()) {
-      multiValueMap.set(entry.getKey(), String.valueOf(entry.getValue()));
-    }
-
-    var url = new URI(this.config.getUrl() + API_PREFIX + this.getUrlPath() + "/");
-    log.debug("Requesting URL: "  + url);
-    var uriBuilder = UriComponentsBuilder.fromUri(url).queryParams(multiValueMap);
-
-    ResponseEntity<String> responseString = restTemplate.exchange(
-      uriBuilder.build(mutableQueryParams),
-      HttpMethod.GET,
-      payload,
-      String.class
-    );
-
-    return deserializeList(responseString.getBody());
-  }
-
   @Override
   public final List<T> search(Map<String, Object> queryParams) throws URISyntaxException, JsonProcessingException {
     List<T> objects = new LinkedList<>();
@@ -208,4 +153,75 @@ public final T update(T object, long objectId) {
     ResponseEntity<T> response = restTemplate.exchange(this.config.getUrl() + API_PREFIX + getUrlPath() + "/" + objectId + "/", HttpMethod.PUT, payload, getModelClass());
     return response.getBody();
   }
+  
+  /**
+   * Get the URL path for the REST endpoint relative to {@link #API_PREFIX}
+   *
+   * @return not {@code null}, not empty
+   */
+  protected abstract String getUrlPath();
+
+  /**
+   * Get the model type the service handles
+   *
+   * @return not {@code null}
+   */
+  protected abstract Class<T> getModelClass();
+
+  /**
+   * Deserializes the response JSON string
+   *
+   * @param response not {@code null}, maybe empty
+   * @return not {@code null}
+   * @throws JsonProcessingException if string is not parsable as JSON
+   */
+  protected abstract PaginatedResult<T> deserializeList(@NonNull String response) throws JsonProcessingException;
+
+  /**
+   * @return The DefectDojo Authentication Header
+   */
+  private HttpHeaders getDefectDojoAuthorizationHeaders() {
+    return new Foo(config, new ProxyConfigFactory().create()).generateAuthorizationHeaders();
+  }
+
+  private RestTemplate setupRestTemplate() {
+    RestTemplate restTemplate = new Foo(config, new ProxyConfigFactory().create()).createRestTemplate();
+    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
+    converter.setObjectMapper(this.objectMapper);
+    restTemplate.setMessageConverters(List.of(
+      new FormHttpMessageConverter(),
+      new ResourceHttpMessageConverter(),
+      new StringHttpMessageConverter(),
+      converter
+    ));
+    return restTemplate;
+  }
+
+  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());
+
+    var mutableQueryParams = new HashMap<>(queryParams);
+
+    mutableQueryParams.put("limit", String.valueOf(limit));
+    mutableQueryParams.put("offset", String.valueOf(offset));
+
+    var multiValueMap = new LinkedMultiValueMap<String, String>();
+    for (var entry : mutableQueryParams.entrySet()) {
+      multiValueMap.set(entry.getKey(), String.valueOf(entry.getValue()));
+    }
+
+    var url = new URI(this.config.getUrl() + API_PREFIX + this.getUrlPath() + "/");
+    log.debug("Requesting URL: " + url);
+    var uriBuilder = UriComponentsBuilder.fromUri(url).queryParams(multiValueMap);
+
+    ResponseEntity<String> responseString = restTemplate.exchange(
+      uriBuilder.build(mutableQueryParams),
+      HttpMethod.GET,
+      payload,
+      String.class
+    );
+
+    return deserializeList(responseString.getBody());
+  }
 }

src/main/java/io/securecodebox/persistence/defectdojo/service/GroupMemberService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.GroupMember;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
+import lombok.NonNull;
 
 public class GroupMemberService extends GenericDefectDojoService<GroupMember> {
   public GroupMemberService(Config config) {
@@ -26,7 +27,7 @@ protected Class<GroupMember> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<GroupMember> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<GroupMember> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/GroupService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.Group;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
+import lombok.NonNull;
 
 public class GroupService extends GenericDefectDojoService<Group> {
   public GroupService(Config config) {
@@ -26,7 +27,7 @@ protected Class<Group> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Group> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Group> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/ProductGroupService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.ProductGroup;
+import lombok.NonNull;
 
 public class ProductGroupService extends GenericDefectDojoService<ProductGroup> {
   public ProductGroupService(Config config) {
@@ -26,7 +27,7 @@ protected Class<ProductGroup> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<ProductGroup> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ProductGroup> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/ProductService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.Product;
+import lombok.NonNull;
 
 public class ProductService extends GenericDefectDojoService<Product> {
 
@@ -27,7 +28,7 @@ protected Class<Product> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Product> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Product> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/ProductTypeService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.ProductType;
+import lombok.NonNull;
 
 public final class ProductTypeService extends GenericDefectDojoService<ProductType> {
 
@@ -27,7 +28,7 @@ protected Class<ProductType> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<ProductType> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<ProductType> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }

src/main/java/io/securecodebox/persistence/defectdojo/service/TestService.java

@@ -9,6 +9,7 @@
 import io.securecodebox.persistence.defectdojo.config.Config;
 import io.securecodebox.persistence.defectdojo.model.PaginatedResult;
 import io.securecodebox.persistence.defectdojo.model.Test;
+import lombok.NonNull;
 
 public class TestService extends GenericDefectDojoService<Test> {
   public TestService(Config config) {
@@ -26,7 +27,7 @@ protected Class<Test> getModelClass() {
   }
 
   @Override
-  protected PaginatedResult<Test> deserializeList(String response) throws JsonProcessingException {
+  protected PaginatedResult<Test> deserializeList(@NonNull String response) throws JsonProcessingException {
     return this.objectMapper.readValue(response, new TypeReference<>() {
     });
   }