feat: implemented the backend for demand and capacity notifications 2.0

backend/src/main/java/org/eclipse/tractusx/puris/backend/common/security/SecurityConfig.java

@@ -83,7 +83,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
             .authorizeHttpRequests(
                 // any request in spring context
                 (authorizeHttpRequests) -> authorizeHttpRequests
-                    .requestMatchers("/stockView/**", "/partners/**", "/materials/**", "/materialpartnerrelations/**", "/item-stock/**", "/production/**", "/delivery/**", "/demand/**", "/planned-production/**", "/material-demand/**", "/delivery-information/**", "/edc/**", "/parttypeinformation/**")
+                    .requestMatchers("/stockView/**", "/partners/**", "/materials/**", "/materialpartnerrelations/**", "/item-stock/**", "/production/**", "/delivery/**", "/demand/**", "/notification/**", "/planned-production/**", "/material-demand/**", "/delivery-information/**", "/edrendpoint/**", "/edc/**", "/parttypeinformation/**")
                     .authenticated()
                     .requestMatchers("/swagger-ui/**", "/v3/api-docs/**", "/health/**").permitAll()
                     .dispatcherTypeMatchers(DispatcherType.ERROR).permitAll()

backend/src/main/java/org/eclipse/tractusx/puris/backend/notification/controller/NotificationController.java

@@ -0,0 +1,252 @@
+/*
+Copyright (c) 2024 Volkswagen AG
+Copyright (c) 2024 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Apache License, Version 2.0 which is available at
+https://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+package org.eclipse.tractusx.puris.backend.notification.controller;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+import java.util.stream.Collectors;
+
+import javax.management.openmbean.KeyAlreadyExistsException;
+
+import org.eclipse.tractusx.puris.backend.masterdata.domain.model.Material;
+import org.eclipse.tractusx.puris.backend.masterdata.domain.model.Partner;
+import org.eclipse.tractusx.puris.backend.masterdata.domain.model.Site;
+import org.eclipse.tractusx.puris.backend.masterdata.logic.service.MaterialService;
+import org.eclipse.tractusx.puris.backend.masterdata.logic.service.PartnerService;
+import org.eclipse.tractusx.puris.backend.notification.domain.model.OwnNotification;
+import org.eclipse.tractusx.puris.backend.notification.domain.model.ReportedNotification;
+import org.eclipse.tractusx.puris.backend.notification.logic.dto.NotificationDto;
+import org.eclipse.tractusx.puris.backend.notification.logic.service.OwnNotificationService;
+import org.eclipse.tractusx.puris.backend.notification.logic.service.ReportedNotificationService;
+import org.modelmapper.ModelMapper;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.server.ResponseStatusException;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import jakarta.validation.Validator;
+
+@RestController
+@RequestMapping("notification")
+public class NotificationController {
+    @Autowired
+    private OwnNotificationService ownNotificationService;
+
+    @Autowired
+    private ReportedNotificationService reportedNotificationService;
+
+    @Autowired
+    private MaterialService materialService;
+
+    @Autowired
+    private PartnerService partnerService;
+
+    @Autowired
+    private ModelMapper modelMapper;
+
+    @Autowired
+    private Validator validator;
+
+    @GetMapping()
+    @ResponseBody
+    @Operation(summary = "Get all own notifications", description = "Get all own notifications. Optionally the partner can be filtered by its bpnl.")
+    public List<NotificationDto> getAllNotifications(Optional<String> partnerBpnl) {
+        if (partnerBpnl.isEmpty()) {
+            return ownNotificationService.findAll().stream().map(this::convertToDto).collect(Collectors.toList());
+        } else {
+            return ownNotificationService.findAllByPartnerBpnl(partnerBpnl.get()).stream().map(this::convertToDto).collect(Collectors.toList());
+        }
+    }
+
+    @PostMapping()
+    @ResponseBody
+    @Operation(summary = "Creates a new notification")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "201", description = "Notification was created."),
+            @ApiResponse(responseCode = "400", description = "Malformed or invalid request body."),
+            @ApiResponse(responseCode = "409", description = "Notification already exists. Use PUT instead."),
+            @ApiResponse(responseCode = "500", description = "Internal Server Error.")
+    })
+    @ResponseStatus(HttpStatus.CREATED)
+    public NotificationDto createNotification(@RequestBody NotificationDto notificationDto) {
+        if (!validator.validate(notificationDto).isEmpty()) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Invalid Notification.");
+        }
+
+        if (notificationDto.getPartnerBpnl() == null || notificationDto.getPartnerBpnl().isEmpty()) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
+                    "Demand Information misses partner identification.");
+        }
+
+        try {
+            return convertToDto(ownNotificationService.create(convertToEntity(notificationDto)));
+        } catch (KeyAlreadyExistsException e) {
+            throw new ResponseStatusException(HttpStatus.CONFLICT, "Notification already exists. Use PUT instead.");
+        } catch (IllegalArgumentException e) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Notification is invalid.");
+        } catch (IllegalStateException e) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, e.getMessage());
+        }
+    }
+
+    @PutMapping()
+    @Operation(summary = "Updates a notification by its UUID")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "Notification was updated."),
+            @ApiResponse(responseCode = "400", description = "Malformed or invalid request body."),
+            @ApiResponse(responseCode = "404", description = "Notification does not exist."),
+            @ApiResponse(responseCode = "500", description = "Internal Server Error.")
+    })
+    @ResponseStatus(HttpStatus.OK)
+    public NotificationDto updateNotification(@RequestBody NotificationDto dto) {
+        OwnNotification updatedNotification = ownNotificationService.update(convertToEntity(dto));
+        if (updatedNotification == null) {
+            throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Notification does not exist.");
+        }
+        return convertToDto(updatedNotification);
+    }
+
+    @DeleteMapping("{id}")
+    @Operation(summary = "Deletes a notification by its UUID")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "204", description = "Notification was deleted."),
+            @ApiResponse(responseCode = "400", description = "Malformed or invalid request body."),
+            @ApiResponse(responseCode = "404", description = "Notification does not exist."),
+            @ApiResponse(responseCode = "500", description = "Internal Server Error.")
+    })
+    @ResponseStatus(HttpStatus.NO_CONTENT)
+    public void deleteNotification(@PathVariable UUID id) {
+        OwnNotification demand = ownNotificationService.findById(id);
+        if (demand == null) {
+            throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Notification does not exist.");
+        }
+        ownNotificationService.delete(id);
+    }
+
+    @GetMapping("reported")
+    @ResponseBody
+    @Operation(summary = "Get all reported notifications", description = "Get all reported notifications. Optionally the partner can be filtered by its bpnl.")
+    public List<NotificationDto> getAllReportedNotifications(Optional<String> partnerBpnl) {
+        if (partnerBpnl.isEmpty()) {
+            return reportedNotificationService.findAll().stream().map(this::convertToDto).collect(Collectors.toList());
+        } else {
+            return reportedNotificationService.findAllByPartnerBpnl(partnerBpnl.get()).stream().map(this::convertToDto).collect(Collectors.toList());
+        }
+    }
+
+    private NotificationDto convertToDto(OwnNotification entity) {
+        NotificationDto dto = modelMapper.map(entity, NotificationDto.class);
+        if (entity.getMaterials() != null) {
+            dto.setAffectedMaterialNumbers(entity.getMaterials().stream().map(Material::getOwnMaterialNumber).toList());
+        }
+        if (entity.getAffectedSitesRecipient() != null) {
+            dto.setAffectedSitesBpnsRecipient(entity.getAffectedSitesRecipient().stream().map(Site::getBpns).toList());
+        }
+        if (entity.getAffectedSitesSender() != null) {
+            dto.setAffectedSitesBpnsSender(entity.getAffectedSitesSender().stream().map(Site::getBpns).toList());
+        }
+        dto.setPartnerBpnl(entity.getPartner().getBpnl());
+        dto.setPartnerBpnl(entity.getPartner().getBpnl());
+        dto.setReported(false);
+        return dto;
+    }
+
+    private NotificationDto convertToDto(ReportedNotification entity) {
+        NotificationDto dto = modelMapper.map(entity, NotificationDto.class);
+        if (entity.getMaterials() != null) {
+            dto.setAffectedMaterialNumbers(entity.getMaterials().stream().map(Material::getOwnMaterialNumber).toList());
+        }
+        if (entity.getAffectedSitesRecipient() != null) {
+            dto.setAffectedSitesBpnsRecipient(entity.getAffectedSitesRecipient().stream().map(Site::getBpns).toList());
+        }
+        if (entity.getAffectedSitesSender() != null) {
+            dto.setAffectedSitesBpnsSender(entity.getAffectedSitesSender().stream().map(Site::getBpns).toList());
+        }
+        dto.setPartnerBpnl(entity.getPartner().getBpnl());
+        return dto;
+    }
+
+    private OwnNotification convertToEntity(NotificationDto dto) {
+        OwnNotification entity = modelMapper.map(dto, OwnNotification.class);
+
+        Partner existingPartner = partnerService.findByBpnl(dto.getPartnerBpnl());
+        if (existingPartner == null) {
+            throw new IllegalStateException(String.format(
+                    "Partner for bpnl %s could not be found",
+                    dto.getPartnerBpnl()));
+        }
+        entity.setPartner(existingPartner);
+
+        List<Material> materials = new ArrayList<>();
+        for (String ownMaterialNumber : dto.getAffectedMaterialNumbers()) {
+            Material material = materialService.findByOwnMaterialNumber(ownMaterialNumber);
+            if (material == null) {
+                throw new IllegalStateException(String.format(
+                        "Material for ownMaterialNumber %s could not be found",
+                        ownMaterialNumber));
+            }
+            materials.add(material);
+        }
+        entity.setMaterials(materials);
+
+        List<Site> affectedSitesRecipient = new ArrayList<>();
+        for (String bpns : dto.getAffectedSitesBpnsRecipient()) {
+            Site site = existingPartner.getSites().stream().filter(p -> p.getBpns().equals(bpns)).findFirst()
+                    .orElse(null);
+            if (site == null) {
+                throw new IllegalStateException(String.format(
+                        "Site for bpns %s could not be found",
+                        bpns));
+            }
+            affectedSitesRecipient.add(site);
+        }
+        entity.setAffectedSitesRecipient(affectedSitesRecipient);
+
+        Partner ownPartner = partnerService.getOwnPartnerEntity();
+        List<Site> affectedSitesSender = new ArrayList<>();
+        for (String bpns : dto.getAffectedSitesBpnsSender()) {
+            Site site = ownPartner.getSites().stream().filter(p -> p.getBpns().equals(bpns)).findFirst().orElse(null);
+            if (site == null) {
+                throw new IllegalStateException(String.format(
+                        "Site for bpns %s could not be found",
+                        bpns));
+            }
+            affectedSitesSender.add(site);
+        }
+        entity.setAffectedSitesSender(affectedSitesSender);
+
+        if (dto.getRelatedNotificationId() != null) {
+            OwnNotification relatedNotification = ownNotificationService.findById(dto.getRelatedNotificationId());
+            if (relatedNotification == null) {
+                throw new IllegalStateException(String.format(
+                        "Related notification for UUID %s could not be found",
+                        dto.getRelatedNotificationId()));
+            }
+        }
+
+        return entity;
+    }
+}

backend/src/main/java/org/eclipse/tractusx/puris/backend/notification/domain/model/EffectEnumeration.java

@@ -0,0 +1,43 @@
+/*
+Copyright (c) 2024 Volkswagen AG
+Copyright (c) 2024 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Apache License, Version 2.0 which is available at
+https://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.eclipse.tractusx.puris.backend.notification.domain.model;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+@JsonFormat(shape = JsonFormat.Shape.OBJECT)
+public enum EffectEnumeration {
+    DEMAND_REDUCTION("demand-reduction"),
+    DEMAND_INCREASE("demand-increase"),
+    CAPACITY_REDUCTION("capacity-reduction"),
+    CAPACITY_INCREASE("capacity-increase");
+
+    private String value;
+
+    EffectEnumeration(String value) {
+        this.value = value;
+    }
+
+    @JsonValue
+    public String getValue() {
+        return value;
+    }
+}

backend/src/main/java/org/eclipse/tractusx/puris/backend/notification/domain/model/LeadingRootCauseEnumeration.java

@@ -0,0 +1,46 @@
+/*
+Copyright (c) 2024 Volkswagen AG
+Copyright (c) 2024 Contributors to the Eclipse Foundation
+
+See the NOTICE file(s) distributed with this work for additional
+information regarding copyright ownership.
+
+This program and the accompanying materials are made available under the
+terms of the Apache License, Version 2.0 which is available at
+https://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.eclipse.tractusx.puris.backend.notification.domain.model;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+@JsonFormat(shape = JsonFormat.Shape.OBJECT)
+public enum LeadingRootCauseEnumeration {
+    STRIKE("strike"),
+    NATURAL_DISASTER("natural-disaster"),
+    PRODUCTION_INCIDENT("production-incident"),
+    PANDEMIC_OR_EPIDEMIC("pandemic-or-epidemic"),
+    LOGISTICS_DISRUPTION("logistics-disruption"),
+    WAR("war"),
+    OTHER("other");
+
+    private String value;
+
+    LeadingRootCauseEnumeration(String value) {
+        this.value = value;
+    }
+
+    @JsonValue
+    public String getValue() {
+        return value;
+    }
+}