Bael 7622: Bulk and Batch APi operations (#16733)

* bulk api

* bulk and batch api

* bulk and batch api refacotring

* bulk and batch api impl

* Refactor code with exception handling, generic fixes and other fix

* refactor code

* refactor code

* refactor code

* refactor code

* restructure packaging

* restructure code

* add unit tests

* refactor tests

* refactor tests

* refactor

* refactor

* http status change as per standards

* fixed test cases

* fix test case

* refactoring

* code review fixes

* code review fixes

* code review fix

* code review fix

* test fixed

* optional code updated

* refactored code based on suggestions

Author: saikatcse03

spring-web-modules/spring-rest-http-3/pom.xml

@@ -24,6 +24,10 @@
             <groupId>com.fasterxml.jackson.dataformat</groupId>
             <artifactId>jackson-dataformat-xml</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
     </dependencies>
 
     <properties>

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/controller/BatchController.java

@@ -0,0 +1,46 @@
+package com.baeldung.bulkandbatchapi.controller;
+
+import com.baeldung.bulkandbatchapi.request.Address;
+import com.baeldung.bulkandbatchapi.service.AddressService;
+import com.baeldung.bulkandbatchapi.request.Customer;
+import com.baeldung.bulkandbatchapi.service.CustomerService;
+import com.baeldung.bulkandbatchapi.request.BatchRequest;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+@RestController
+@RequestMapping("/api")
+@Validated
+public class BatchController {
+
+    private final CustomerService customerService;
+    private final AddressService addressService;
+    private final ObjectMapper objectMapper;
+
+    public BatchController(CustomerService customerService, AddressService addressService, ObjectMapper objectMapper) {
+        this.customerService = customerService;
+        this.addressService = addressService;
+        this.objectMapper = objectMapper;
+    }
+
+    @PostMapping(path = "/batch")
+    public ResponseEntity<String> batchUpdateCustomerWithAddress(@RequestBody @Valid @Size(min = 1, max = 20) List<BatchRequest> batchRequests) {
+        batchRequests.forEach(batchRequest -> {
+            if (batchRequest.getMethod().equals(HttpMethod.POST) && batchRequest.getRelativeUrl().equals("/address")) {
+                addressService.createAddress(objectMapper.convertValue(batchRequest.getData(), Address.class));
+            } else if (batchRequest.getMethod().equals(HttpMethod.PATCH) && batchRequest.getRelativeUrl().equals("/customer")) {
+                customerService.updateCustomer(objectMapper.convertValue(batchRequest.getData(), Customer.class));
+            }
+        });
+
+        return new ResponseEntity<>("Batch update is processed", HttpStatus.OK);
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/controller/BulkController.java

@@ -0,0 +1,71 @@
+package com.baeldung.bulkandbatchapi.controller;
+
+import com.baeldung.bulkandbatchapi.request.BulkActionType;
+import com.baeldung.bulkandbatchapi.request.Customer;
+import com.baeldung.bulkandbatchapi.request.CustomerBulkRequest;
+import com.baeldung.bulkandbatchapi.response.BulkStatus;
+import com.baeldung.bulkandbatchapi.response.CustomerBulkResponse;
+import com.baeldung.bulkandbatchapi.service.CustomerService;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Size;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.*;
+import java.util.function.Function;
+
+import static java.util.stream.Collectors.toList;
+
+@RestController
+@RequestMapping("/api")
+@Validated
+public class BulkController {
+
+    private final CustomerService customerService;
+    private final EnumMap<BulkActionType, Function<Customer, Optional<Customer>>> bulkActionFuncMap = new EnumMap<>(BulkActionType.class);
+
+    public BulkController(CustomerService customerService) {
+        this.customerService = customerService;
+        bulkActionFuncMap.put(BulkActionType.CREATE, customerService::createCustomer);
+        bulkActionFuncMap.put(BulkActionType.UPDATE, customerService::updateCustomer);
+        bulkActionFuncMap.put(BulkActionType.DELETE, customerService::deleteCustomer);
+    }
+
+    @PostMapping(path = "/customers")
+    public ResponseEntity<List<Customer>> createCustomers(@RequestHeader(value = "X-ActionType") String actionType, @RequestBody @Valid @Size(min = 1, max = 20) List<Customer> customers) {
+        List<Customer> customerList = actionType.equals("bulk") ? customerService.createCustomers(customers) :
+                Collections.singletonList(customerService.createCustomer(customers.get(0)).orElse(null));
+
+        return new ResponseEntity<>(customerList, HttpStatus.CREATED);
+    }
+
+    @PostMapping(path = "/customers/bulk")
+    public ResponseEntity<List<CustomerBulkResponse>> bulkProcessCustomers(@RequestBody @Valid @Size(min = 1, max = 20) List<CustomerBulkRequest> customerBulkRequests) {
+        List<CustomerBulkResponse> customerBulkResponseList = new ArrayList<>();
+
+        customerBulkRequests.forEach(customerBulkRequest -> {
+            List<Customer> customers = customerBulkRequest.getCustomers().stream()
+                    .map(bulkActionFuncMap.get(customerBulkRequest.getBulkActionType()))
+                    .filter(Optional::isPresent)
+                    .map(Optional::get)
+                    .collect(toList());
+
+            BulkStatus bulkStatus = getBulkStatus(customerBulkRequest.getCustomers(), customers);
+            customerBulkResponseList.add(new CustomerBulkResponse(customers, customerBulkRequest.getBulkActionType(), bulkStatus));
+        });
+
+        return new ResponseEntity<>(customerBulkResponseList, HttpStatus.MULTI_STATUS);
+    }
+
+    private BulkStatus getBulkStatus(List<Customer> customersInRequest, List<Customer> customersProcessed) {
+        if (!customersProcessed.isEmpty()) {
+            return customersProcessed.size() == customersInRequest.size() ?
+                BulkStatus.PROCESSED :
+                BulkStatus.PARTIALLY_PROCESSED;
+        }
+
+        return BulkStatus.NOT_PROCESSED;
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/exception/BatchException.java

@@ -0,0 +1,7 @@
+package com.baeldung.bulkandbatchapi.exception;
+
+public class BatchException extends RuntimeException {
+    public BatchException(String exceptionMsg) {
+        super(exceptionMsg);
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/exception/CustomErrorHandler.java

@@ -0,0 +1,17 @@
+package com.baeldung.bulkandbatchapi.exception;
+
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.validation.ConstraintViolationException;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+import java.io.IOException;
+
+@ControllerAdvice
+public class CustomErrorHandler {
+    @ExceptionHandler(ConstraintViolationException.class)
+    public void handleConstraintViolationException(ConstraintViolationException exception, HttpServletResponse httpServletResponse) throws IOException {
+        httpServletResponse.sendError(HttpStatus.BAD_REQUEST.value(), exception.getMessage());
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/request/Address.java

@@ -0,0 +1,54 @@
+package com.baeldung.bulkandbatchapi.request;
+
+import jakarta.validation.constraints.NotBlank;
+
+import java.io.Serializable;
+
+public class Address implements Serializable {
+
+    private int id;
+
+    @NotBlank
+    private String street;
+
+    @NotBlank
+    private String city;
+
+    public Address() {
+    }
+
+    public Address(int id, String street, String city) {
+        this.id = id;
+        this.street = street;
+        this.city = city;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getStreet() {
+        return street;
+    }
+
+    public void setStreet(String street) {
+        this.street = street;
+    }
+
+    public String getCity() {
+        return city;
+    }
+
+    public void setCity(String city) {
+        this.city = city;
+    }
+
+    @Override
+    public String toString() {
+        return "Address{" +
+                "id=" + id +
+                ", street='" + street + '\'' +
+                ", city='" + city + '\'' +
+                '}';
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/request/BatchRequest.java

@@ -0,0 +1,38 @@
+package com.baeldung.bulkandbatchapi.request;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import jakarta.validation.constraints.NotNull;
+import org.springframework.http.HttpMethod;
+
+public class BatchRequest {
+    @NotNull
+    private HttpMethod method;
+    @NotNull
+    private String relativeUrl;
+    @NotNull
+    private JsonNode data;
+
+    public JsonNode getData() {
+        return data;
+    }
+
+    public @NotNull String getRelativeUrl() {
+        return relativeUrl;
+    }
+
+    public void setRelativeUrl(@NotNull String relativeUrl) {
+        this.relativeUrl = relativeUrl;
+    }
+
+    public void setData(@NotNull JsonNode data) {
+        this.data = data;
+    }
+
+    public @NotNull HttpMethod getMethod() {
+        return method;
+    }
+
+    public void setMethod(@NotNull HttpMethod method) {
+        this.method = method;
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/request/BulkActionType.java

@@ -0,0 +1,5 @@
+package com.baeldung.bulkandbatchapi.request;
+
+public enum BulkActionType {
+    CREATE, UPDATE, DELETE
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/request/Customer.java

@@ -0,0 +1,70 @@
+package com.baeldung.bulkandbatchapi.request;
+
+import jakarta.validation.constraints.NotBlank;
+
+import java.io.Serializable;
+
+public class Customer implements Serializable {
+
+    private int id;
+
+    @NotBlank
+    private String name;
+
+    @NotBlank
+    private String email;
+
+    @NotBlank
+    private String address;
+
+    public Customer() {
+    }
+
+    public Customer(int id, String name, String email) {
+        this.id = id;
+        this.name = name;
+        this.email = email;
+    }
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+    public String getAddress() {
+        return address;
+    }
+
+    public void setAddress(String address) {
+        this.address = address;
+    }
+
+    @Override
+    public String toString() {
+        return "Customer{" +
+                "id=" + id +
+                ", name='" + name + '\'' +
+                ", email='" + email + '\'' +
+                ", address=" + address +
+                '}';
+    }
+}

spring-web-modules/spring-rest-http-3/src/main/java/com/baeldung/bulkandbatchapi/request/CustomerBulkRequest.java

@@ -0,0 +1,24 @@
+package com.baeldung.bulkandbatchapi.request;
+
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+
+import java.util.List;
+
+public class CustomerBulkRequest {
+
+    @NotNull
+    private BulkActionType bulkActionType;
+
+    @NotNull
+    @Size(min = 1, max = 20)
+    private List<Customer> customers;
+
+    public BulkActionType getBulkActionType() {
+        return bulkActionType;
+    }
+
+    public List<Customer> getCustomers() {
+        return customers;
+    }
+}