Add validation annotations to models and controllers + Added Application Exception Handler

Author: teetangh

pom.xml

@@ -52,6 +52,10 @@
             <scope>runtime</scope>
             <optional>true</optional>
         </dependency>
+        <dependency> 
+            <groupId>org.springframework.boot</groupId> 
+            <artifactId>spring-boot-starter-validation</artifactId> 
+        </dependency>
 
         <dependency>
             <groupId>io.springfox</groupId>

src/main/java/org/couchbase/quickstart/springboot/advice/ApplicationExceptionHandler.java

@@ -0,0 +1,29 @@
+package org.couchbase.quickstart.springboot.advice;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+@RestControllerAdvice
+public class ApplicationExceptionHandler {
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public Map<String, String> handleValidationExceptions(
+            MethodArgumentNotValidException ex) {
+        Map<String, String> errorMap = new HashMap<>();
+
+        ex.getBindingResult().getAllErrors().forEach(error -> {
+            String fieldName = ((FieldError) error).getField();
+            String errorMessage = error.getDefaultMessage();
+            errorMap.put(fieldName, errorMessage);
+        });
+        
+        return errorMap;
+    }
+}

src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java

@@ -3,6 +3,8 @@
 import java.net.URI;
 import java.util.List;
 
+import javax.validation.Valid;
+
 import org.couchbase.quickstart.springboot.configs.DBProperties;
 import org.couchbase.quickstart.springboot.models.Airline;
 import org.springframework.http.HttpStatus;
@@ -54,7 +56,7 @@ public ResponseEntity<Airline> getAirline(@PathVariable String id) {
     }
 
     @PostMapping("/{id}")
-    public ResponseEntity<Airline> createAirline(@PathVariable String id, @RequestBody Airline airline) {
+    public ResponseEntity<Airline> createAirline(@PathVariable String id,@Valid @RequestBody Airline airline) {
         try {
             airlineCol.insert(id, airline);
             Airline createdAirline = airlineCol.get(id).contentAs(Airline.class);
@@ -66,7 +68,7 @@ public ResponseEntity<Airline> createAirline(@PathVariable String id, @RequestBo
     }
 
     @PutMapping("/{id}")
-    public ResponseEntity<Airline> updateAirline(@PathVariable String id, @RequestBody Airline airline) {
+    public ResponseEntity<Airline> updateAirline(@PathVariable String id,@Valid @RequestBody Airline airline) {
         try {
             airlineCol.replace(id, airline);
             Airline updatedAirline = airlineCol.get(id).contentAs(Airline.class);

src/main/java/org/couchbase/quickstart/springboot/controllers/AirportController.java

@@ -3,6 +3,8 @@
 import java.net.URI;
 import java.util.List;
 
+import javax.validation.Valid;
+
 import org.couchbase.quickstart.springboot.configs.DBProperties;
 import org.couchbase.quickstart.springboot.models.Airport;
 import org.springframework.http.HttpStatus;
@@ -52,7 +54,7 @@ public ResponseEntity<Airport> getAirport(@PathVariable String id) {
     }
 
     @PostMapping("/{id}")
-    public ResponseEntity<Airport> createAirport(@PathVariable String id, @RequestBody Airport airport) {
+    public ResponseEntity<Airport> createAirport(@PathVariable String id,@Valid @RequestBody Airport airport) {
         try {
             airportCol.insert(id, airport);
             Airport createdAirport = airportCol.get(id).contentAs(Airport.class);
@@ -63,7 +65,7 @@ public ResponseEntity<Airport> createAirport(@PathVariable String id, @RequestBo
     }
 
     @PutMapping("/{id}")
-    public ResponseEntity<Airport> updateAirport(@PathVariable String id, @RequestBody Airport airport) {
+    public ResponseEntity<Airport> updateAirport(@PathVariable String id,@Valid @RequestBody Airport airport) {
         try {
             airportCol.replace(id, airport);
             Airport updatedAirport = airportCol.get(id).contentAs(Airport.class);

src/main/java/org/couchbase/quickstart/springboot/controllers/RouteController.java

@@ -3,6 +3,8 @@
 import java.net.URI;
 import java.util.List;
 
+import javax.validation.Valid;
+
 import org.couchbase.quickstart.springboot.configs.DBProperties;
 import org.couchbase.quickstart.springboot.models.Route;
 import org.springframework.http.HttpStatus;
@@ -52,7 +54,7 @@ public ResponseEntity<Route> getRoute(@PathVariable String id) {
     }
 
     @PostMapping("/{id}")
-    public ResponseEntity<Route> createRoute(@PathVariable String id, @RequestBody Route route) {
+    public ResponseEntity<Route> createRoute(@PathVariable String id,@Valid @RequestBody Route route) {
         try {
             routeCol.insert(id, route);
             Route createdRoute = routeCol.get(id).contentAs(Route.class);
@@ -63,7 +65,7 @@ public ResponseEntity<Route> createRoute(@PathVariable String id, @RequestBody R
     }
 
     @PutMapping("/{id}")
-    public ResponseEntity<Route> updateRoute(@PathVariable String id, @RequestBody Route route) {
+    public ResponseEntity<Route> updateRoute(@PathVariable String id,@Valid @RequestBody Route route) {
         try {
             routeCol.replace(id, route);
             Route updatedRoute = routeCol.get(id).contentAs(Route.class);
@@ -86,7 +88,7 @@ public ResponseEntity<Void> deleteRoute(@PathVariable String id) {
     @GetMapping("/list")
     public ResponseEntity<List<Route>> listRoutes() {
         try {
-            String statement = "SELECT airport.* FROM `" + dbProperties.getBucketName() + "`.`inventory`.`route`";
+            String statement = "SELECT route.* FROM `" + dbProperties.getBucketName() + "`.`inventory`.`route`";
             List<Route> routes = cluster
                     .query(statement, QueryOptions.queryOptions().scanConsistency(QueryScanConsistency.REQUEST_PLUS))
                     .rowsAs(Route.class);

src/main/java/org/couchbase/quickstart/springboot/models/Airline.java

@@ -1,29 +1,43 @@
 package org.couchbase.quickstart.springboot.models;
 
+import java.io.Serializable;
+
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.Pattern;
+
 import lombok.AllArgsConstructor;
+import lombok.Data;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
-import java.io.Serializable;
-
 @Getter
 @Setter
 @AllArgsConstructor
 @NoArgsConstructor
+@Data
 public class Airline implements Serializable {
 
+    @NotBlank(message = "ID is mandatory")
     private String id;
 
+    @NotBlank(message = "Type is mandatory")
     private String type;
 
+    @NotBlank(message = "Name is mandatory")
     private String name;
 
+    @NotBlank(message = "IATA code is mandatory")
+    @Pattern(regexp = "^[A-Z]{2}$", message = "IATA code must be a 2-letter uppercase code")
     private String iata;
 
+    @NotBlank(message = "ICAO code is mandatory")
+    @Pattern(regexp = "^[A-Z]{3}$", message = "ICAO code must be a 3-letter uppercase code")
     private String icao;
 
+    @NotBlank(message = "Callsign is mandatory")
     private String callsign;
 
+    @NotBlank(message = "Country is mandatory")
     private String country;
 }

src/main/java/org/couchbase/quickstart/springboot/models/Airport.java

@@ -1,5 +1,9 @@
 package org.couchbase.quickstart.springboot.models;
 
+import javax.validation.Valid;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.Pattern;
+
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -11,22 +15,33 @@
 @NoArgsConstructor
 public class Airport {
 
+    @NotBlank(message = "ID is mandatory")
     private String id;
 
+    @NotBlank(message = "Type is mandatory")
     private String type;
 
+    @NotBlank(message = "Airport name is mandatory")
     private String airportname;
 
+    @NotBlank(message = "City is mandatory")
     private String city;
 
+    @NotBlank(message = "Country is mandatory")
     private String country;
 
+    // @NotBlank(message = "FAA is mandatory")
+    @Pattern(regexp = "[A-Z]{3}", message = "FAA must be 3 uppercase letters")
     private String faa;
 
+    // @NotBlank(message = "ICAO is mandatory")
+    @Pattern(regexp = "[A-Z]{4}", message = "ICAO must be 4 uppercase letters")
     private String icao;
 
+    @NotBlank(message = "Timezone is mandatory")
     private String tz;
 
+    @Valid
     private Geo geo;
 
     @Getter
@@ -35,10 +50,13 @@ public class Airport {
     @NoArgsConstructor
     public static class Geo {
 
+        // @NotBlank(message = "Altitude is mandatory")
         private double alt;
 
+        // @NotBlank(message = "Latitude is mandatory")
         private double lat;
 
+        // @NotBlank(message = "Longitude is mandatory")
         private double lon;
     }
 }

src/main/java/org/couchbase/quickstart/springboot/models/Route.java

@@ -2,7 +2,12 @@
 
 import java.util.List;
 
+import javax.validation.Valid;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotNull;
+
 import lombok.AllArgsConstructor;
+import lombok.Data;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
@@ -11,26 +16,37 @@
 @Setter
 @AllArgsConstructor
 @NoArgsConstructor
+@Data
 public class Route {
 
+    @NotBlank(message = "ID is mandatory")
     private String id;
 
+    @NotBlank(message = "Type is mandatory")
     private String type;
 
+    @NotBlank(message = "Airline is mandatory")
     private String airline;
 
-    private String airlineId;
+    @NotBlank(message = "Airline ID is mandatory")
+    private String airlineid;
 
-    private String sourceAirport;
+    @NotBlank(message = "Source airport is mandatory")
+    private String sourceairport;
 
-    private String destinationAirport;
+    @NotBlank(message = "Destination airport is mandatory")
+    private String destinationairport;
 
+    @NotNull(message = "Stops is mandatory")
     private int stops;
 
+    @NotBlank(message = "Equipment is mandatory")
     private String equipment;
 
+    @Valid
     private List<Schedule> schedule;
 
+    @NotNull(message = "Distance is mandatory")
     private double distance;
 
     @Getter
@@ -39,10 +55,14 @@ public class Route {
     @NoArgsConstructor
     public static class Schedule {
 
+        @NotNull(message = "Day is mandatory")
         private int day;
 
-        private String flight;
-
+        @NotBlank(message = "UTC is mandatory")
         private String utc;
+
+        @NotBlank(message = "Flight is mandatory")
+        private String flight;
+        
     }
 }