VUU70: Add resource for application layouts

layout-server/src/main/java/org/finos/vuu/layoutserver/config/MappingConfig.java

@@ -1,8 +1,8 @@
 package org.finos.vuu.layoutserver.config;
 
 import lombok.RequiredArgsConstructor;
-import org.finos.vuu.layoutserver.dto.request.LayoutRequestDTO;
-import org.finos.vuu.layoutserver.dto.response.MetadataResponseDTO;
+import org.finos.vuu.layoutserver.dto.request.LayoutRequestDto;
+import org.finos.vuu.layoutserver.dto.response.MetadataResponseDto;
 import org.finos.vuu.layoutserver.model.Layout;
 import org.finos.vuu.layoutserver.model.Metadata;
 import org.finos.vuu.layoutserver.service.LayoutService;
@@ -20,14 +20,14 @@ public class MappingConfig {
     public ModelMapper modelMapper() {
         ModelMapper mapper = new ModelMapper();
 
-        mapper.typeMap(LayoutRequestDTO.class, Layout.class)
+        mapper.typeMap(LayoutRequestDto.class, Layout.class)
             .addMappings(m -> m.skip(Layout::setId));
 
-        mapper.typeMap(Metadata.class, MetadataResponseDTO.class)
+        mapper.typeMap(Metadata.class, MetadataResponseDto.class)
             .addMappings(m -> m.map(
                 metadata -> layoutService.getLayoutByMetadataId(metadata.getId()),
-                MetadataResponseDTO::setLayoutId));
+                MetadataResponseDto::setLayoutId));
 
         return mapper;
     }
-}
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/controller/ApplicationLayoutController.java

@@ -0,0 +1,55 @@
+package org.finos.vuu.layoutserver.controller;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.RequiredArgsConstructor;
+import org.finos.vuu.layoutserver.dto.response.ApplicationLayoutDto;
+import org.finos.vuu.layoutserver.service.ApplicationLayoutService;
+import org.modelmapper.ModelMapper;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.*;
+
+@RequiredArgsConstructor
+@RestController
+@RequestMapping("/application-layouts")
+public class ApplicationLayoutController {
+
+    private final ApplicationLayoutService service;
+    private final ModelMapper mapper;
+
+    /**
+     * Gets the persisted application layout for the requesting user. If the requesting user does not have an
+     * application layout persisted, a default layout with a null username is returned instead. No more than one
+     * application layout can be persisted for a given user.
+     *
+     * @return the application layout
+     */
+    @ResponseStatus(HttpStatus.OK)
+    @GetMapping
+    public ApplicationLayoutDto getApplicationLayout(@RequestHeader("username") String username) {
+        return mapper.map(service.getApplicationLayout(username), ApplicationLayoutDto.class);
+    }
+
+    /**
+     * Creates or updates the unique application layout for the requesting user.
+     *
+     * @param layoutDefinition JSON representation of the application layout to be created
+     * @param username         the user making the request
+     */
+    @ResponseStatus(HttpStatus.CREATED)
+    @PutMapping
+    public void persistApplicationLayout(@RequestHeader("username") String username, @RequestBody JsonNode layoutDefinition) {
+        service.persistApplicationLayout(username, layoutDefinition);
+    }
+
+    /**
+     * Deletes the application layout for the requesting user. A 404 will be returned if there is no existing
+     * application layout.
+     *
+     * @param username         the user making the request
+     */
+    @ResponseStatus(HttpStatus.NO_CONTENT)
+    @DeleteMapping
+    public void deleteApplicationLayout(@RequestHeader("username") String username) {
+        service.deleteApplicationLayout(username);
+    }
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/controller/LayoutController.java

@@ -1,27 +1,20 @@
 package org.finos.vuu.layoutserver.controller;
 
-import java.util.List;
-import java.util.UUID;
-import javax.validation.Valid;
 import lombok.RequiredArgsConstructor;
-import org.finos.vuu.layoutserver.dto.request.LayoutRequestDTO;
-import org.finos.vuu.layoutserver.dto.response.LayoutResponseDTO;
-import org.finos.vuu.layoutserver.dto.response.MetadataResponseDTO;
+import org.finos.vuu.layoutserver.dto.request.LayoutRequestDto;
+import org.finos.vuu.layoutserver.dto.response.LayoutResponseDto;
+import org.finos.vuu.layoutserver.dto.response.MetadataResponseDto;
 import org.finos.vuu.layoutserver.model.Layout;
 import org.finos.vuu.layoutserver.service.LayoutService;
 import org.finos.vuu.layoutserver.service.MetadataService;
 import org.modelmapper.ModelMapper;
 import org.springframework.http.HttpStatus;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.ResponseStatus;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
+
+import javax.validation.Valid;
+import java.util.List;
+import java.util.UUID;
 
 @RequiredArgsConstructor
 @RestController
@@ -41,8 +34,8 @@ public class LayoutController {
      */
     @ResponseStatus(HttpStatus.OK)
     @GetMapping("/{id}")
-    public LayoutResponseDTO getLayout(@PathVariable UUID id) {
-        return mapper.map(layoutService.getLayout(id), LayoutResponseDTO.class);
+    public LayoutResponseDto getLayout(@PathVariable UUID id) {
+        return mapper.map(layoutService.getLayout(id), LayoutResponseDto.class);
     }
 
     /**
@@ -52,11 +45,11 @@ public LayoutResponseDTO getLayout(@PathVariable UUID id) {
      */
     @ResponseStatus(HttpStatus.OK)
     @GetMapping("/metadata")
-    public List<MetadataResponseDTO> getMetadata() {
+    public List<MetadataResponseDto> getMetadata() {
 
         return metadataService.getMetadata()
             .stream()
-            .map(metadata -> mapper.map(metadata, MetadataResponseDTO.class))
+            .map(metadata -> mapper.map(metadata, MetadataResponseDto.class))
             .collect(java.util.stream.Collectors.toList());
     }
 
@@ -68,12 +61,12 @@ public List<MetadataResponseDTO> getMetadata() {
      */
     @ResponseStatus(HttpStatus.CREATED)
     @PostMapping
-    public LayoutResponseDTO createLayout(@Valid @RequestBody LayoutRequestDTO layoutToCreate) {
+    public LayoutResponseDto createLayout(@RequestBody @Valid LayoutRequestDto layoutToCreate) {
         Layout layout = mapper.map(layoutToCreate, Layout.class);
 
         Layout createdLayout = layoutService.getLayout(layoutService.createLayout(layout));
 
-        return mapper.map(createdLayout, LayoutResponseDTO.class);
+        return mapper.map(createdLayout, LayoutResponseDto.class);
     }
 
     /**
@@ -84,7 +77,7 @@ public LayoutResponseDTO createLayout(@Valid @RequestBody LayoutRequestDTO layou
      */
     @ResponseStatus(HttpStatus.NO_CONTENT)
     @PutMapping("/{id}")
-    public void updateLayout(@PathVariable UUID id, @Valid @RequestBody LayoutRequestDTO layout) {
+    public void updateLayout(@PathVariable UUID id, @RequestBody @Valid LayoutRequestDto layout) {
         Layout newLayout = mapper.map(layout, Layout.class);
 
         layoutService.updateLayout(id, newLayout);

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/request/LayoutRequestDTO.java → layout-server/src/main/java/org/finos/vuu/layoutserver/dto/request/LayoutRequestDto.java

@@ -1,12 +1,13 @@
 package org.finos.vuu.layoutserver.dto.request;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
-import lombok.Data;
 
 @Data
-public class LayoutRequestDTO {
+public class LayoutRequestDto {
 
     /**
      * The definition of the layout as a string (e.g. stringified JSON structure containing
@@ -18,5 +19,5 @@ public class LayoutRequestDTO {
 
     @JsonProperty(value = "metadata", required = true)
     @NotNull(message = "Metadata must not be null")
-    private MetadataRequestDTO metadata;
+    private MetadataRequestDto metadata;
 }

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/request/MetadataRequestDTO.java → layout-server/src/main/java/org/finos/vuu/layoutserver/dto/request/MetadataRequestDto.java

@@ -5,7 +5,7 @@
 import org.finos.vuu.layoutserver.model.BaseMetadata;
 
 @Data
-public class MetadataRequestDTO {
+public class MetadataRequestDto {
 
     @JsonUnwrapped
     BaseMetadata baseMetadata;

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/ApplicationLayoutDto.java

@@ -0,0 +1,10 @@
+package org.finos.vuu.layoutserver.dto.response;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.Data;
+
+@Data
+public class ApplicationLayoutDto {
+    private String username;
+    private JsonNode definition;
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/ErrorResponse.java

@@ -0,0 +1,24 @@
+package org.finos.vuu.layoutserver.dto.response;
+
+import lombok.Data;
+import org.springframework.http.HttpStatus;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.Date;
+import java.util.List;
+
+@Data
+public class ErrorResponse {
+    private Date timestamp = new Date();
+    private int status;
+    private String error;
+    private List<String> messages;
+    private String path;
+
+    public ErrorResponse(HttpServletRequest request, List<String> messages, HttpStatus status) {
+        this.status = status.value();
+        this.error = status.getReasonPhrase();
+        this.path = request.getRequestURI();
+        this.messages = messages;
+    }
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/LayoutResponseDTO.java → layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/LayoutResponseDto.java

@@ -5,7 +5,7 @@
 import java.util.UUID;
 
 @Data
-public class LayoutResponseDTO {
+public class LayoutResponseDto {
 
     private UUID id;
 
@@ -15,5 +15,5 @@ public class LayoutResponseDTO {
      */
     private String definition;
 
-    private MetadataResponseDTO metadata;
+    private MetadataResponseDto metadata;
 }

layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/MetadataResponseDTO.java → layout-server/src/main/java/org/finos/vuu/layoutserver/dto/response/MetadataResponseDto.java

@@ -1,13 +1,14 @@
 package org.finos.vuu.layoutserver.dto.response;
 
 import com.fasterxml.jackson.annotation.JsonUnwrapped;
-import java.time.LocalDate;
-import java.util.UUID;
 import lombok.Data;
 import org.finos.vuu.layoutserver.model.BaseMetadata;
 
+import java.time.LocalDate;
+import java.util.UUID;
+
 @Data
-public class MetadataResponseDTO {
+public class MetadataResponseDto {
 
     private UUID layoutId;
 

layout-server/src/main/java/org/finos/vuu/layoutserver/exceptions/GlobalExceptionHandler.java

@@ -1,40 +1,50 @@
 package org.finos.vuu.layoutserver.exceptions;
 
-import java.util.List;
-import java.util.NoSuchElementException;
-import java.util.stream.Collectors;
+import org.finos.vuu.layoutserver.dto.response.ErrorResponse;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.converter.HttpMessageNotReadableException;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
 
+import javax.servlet.http.HttpServletRequest;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.stream.Collectors;
+
 @ControllerAdvice
 public class GlobalExceptionHandler {
 
     @ExceptionHandler(NoSuchElementException.class)
-    public ResponseEntity<String> handleNotFound(NoSuchElementException ex) {
-        return new ResponseEntity<>(ex.getMessage(),
-            org.springframework.http.HttpStatus.NOT_FOUND);
+    public ResponseEntity<ErrorResponse> handleNotFound(HttpServletRequest request, Exception ex) {
+        HttpStatus status = HttpStatus.NOT_FOUND;
+        return new ResponseEntity<>(new ErrorResponse(request, List.of(ex.getMessage()), status), status);
     }
 
     @ExceptionHandler({
-        HttpMessageNotReadableException.class,
-        MethodArgumentTypeMismatchException.class})
-    public ResponseEntity<String> handleBadRequest(Exception ex) {
-        return new ResponseEntity<>(ex.getMessage(),
-            org.springframework.http.HttpStatus.BAD_REQUEST);
+            HttpMessageNotReadableException.class,
+            MethodArgumentTypeMismatchException.class})
+    public ResponseEntity<ErrorResponse> handleBadRequest(HttpServletRequest request, Exception ex) {
+        HttpStatus status = HttpStatus.BAD_REQUEST;
+        return new ResponseEntity<>(new ErrorResponse(request, List.of(ex.getMessage()), status), status);
     }
 
     @ExceptionHandler(MethodArgumentNotValidException.class)
-    public ResponseEntity<String> handleMethodArgumentNotValid(MethodArgumentNotValidException ex) {
+    public ResponseEntity<ErrorResponse> handleMethodArgumentNotValid(HttpServletRequest request, MethodArgumentNotValidException ex) {
+        HttpStatus status = HttpStatus.BAD_REQUEST;
         List<String> errors = ex.getFieldErrors()
-            .stream()
-            .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
-            .collect(Collectors.toList());
+                .stream()
+                .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
+                .collect(Collectors.toList());
+        return new ResponseEntity<>(new ErrorResponse(request, errors, status), status);
+    }
+
+    @ExceptionHandler(InternalServerErrorException.class)
+    public ResponseEntity<ErrorResponse> handleInternalServerError(HttpServletRequest request, Exception ex) {
+        HttpStatus status = HttpStatus.INTERNAL_SERVER_ERROR;
+        return new ResponseEntity<>(new ErrorResponse(request, List.of(ex.getMessage()), status), status);
 
-        return new ResponseEntity<>(errors.toString(),
-            org.springframework.http.HttpStatus.BAD_REQUEST);
     }
 }

layout-server/src/main/java/org/finos/vuu/layoutserver/exceptions/InternalServerErrorException.java

@@ -0,0 +1,7 @@
+package org.finos.vuu.layoutserver.exceptions;
+
+public class InternalServerErrorException extends RuntimeException {
+    public InternalServerErrorException(String message) {
+        super(message);
+    }
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/model/ApplicationLayout.java

@@ -0,0 +1,25 @@
+package org.finos.vuu.layoutserver.model;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import org.finos.vuu.layoutserver.utils.JsonNodeConverter;
+
+import javax.persistence.Column;
+import javax.persistence.Convert;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+
+@Data
+@Entity
+@RequiredArgsConstructor
+@AllArgsConstructor
+public class ApplicationLayout {
+    @Id
+    private String username;
+
+    @Convert(converter = JsonNodeConverter.class)
+    @Column(columnDefinition = "JSON")
+    private JsonNode definition;
+}

layout-server/src/main/java/org/finos/vuu/layoutserver/model/BaseMetadata.java

@@ -1,8 +1,9 @@
 package org.finos.vuu.layoutserver.model;
 
+import lombok.Data;
+
 import javax.persistence.Embeddable;
 import javax.persistence.Lob;
-import lombok.Data;
 
 @Data
 @Embeddable