MVP

schools/src/main/java/com/lambdaschool/schools/config/SwaggerWebMVC.java

@@ -0,0 +1,35 @@
+package com.lambdaschool.usermodel.config;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+/**
+ * The application turns off any automatic web page generate done by Spring. This is done to improve exception handling.
+ * However, we do need some web page generate done for Swagger, so we do that here.
+ */
+@Configuration
+public class SwaggerWebMVC
+        implements WebMvcConfigurer
+{
+    /**
+     * Adds the Swagger web pages to Spring.
+     * This still gives the following warning
+     * <p>
+     * No mapping for GET /
+     * No mapping for GET /csrf
+     * <p>
+     * All works though
+     *
+     * @param registry the place that holds the web pages for Spring
+     */
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry)
+    {
+        registry.addResourceHandler("swagger-ui.html")
+                .addResourceLocations("classpath:/META-INF/resources/");
+
+        registry.addResourceHandler("/webjars/**")
+                .addResourceLocations("classpath:/META-INF/resources/webjars/");
+    }
+}

schools/src/main/java/com/lambdaschool/schools/exceptions/CustomErrorDetails.java

@@ -0,0 +1,33 @@
+package com.lambdaschool.schools.exceptions;
+
+import com.lambdaschool.schools.services.HelperFunctions;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
+import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.WebRequest;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+@Component
+public class CustomErrorDetails extends DefaultErrorAttributes
+{
+    @Autowired
+    HelperFunctions helperFunctions;
+
+    @Override
+    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
+       Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
+       Map<String, Object> errorDetails = new LinkedHashMap<>();
+
+       errorDetails.put("title", errorAttributes.get("error"));
+       errorDetails.put("status", errorAttributes.get("status"));
+       errorDetails.put("detail", errorAttributes.get("message"));
+       errorDetails.put("timestamps", errorAttributes.get("timestamp"));
+       errorDetails.put("developerMessage", "path: " + errorAttributes.get("path"));
+
+       errorDetails.put("errors", helperFunctions.getConstraintViolation(this.getError(webRequest)));
+
+        return errorDetails;
+    }
+}

schools/src/main/java/com/lambdaschool/schools/exceptions/ResourceNotFoundException.java

@@ -0,0 +1,9 @@
+package com.lambdaschool.schools.exceptions;
+
+public class ResourceNotFoundException extends RuntimeException
+{
+    public ResourceNotFoundException(String message)
+    {
+        super(message);
+    }
+}

schools/src/main/java/com/lambdaschool/schools/handlers/RestExceptionHandler.java

@@ -0,0 +1,74 @@
+package com.lambdaschool.schools.handlers;
+
+
+import com.lambdaschool.schools.exceptions.ResourceNotFoundException;
+import com.lambdaschool.schools.models.ErrorDetail;
+import com.lambdaschool.schools.services.HelperFunctions;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.NoHandlerFoundException;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+import java.util.Date;
+
+@Order(Ordered.HIGHEST_PRECEDENCE)
+@RestControllerAdvice
+public class RestExceptionHandler extends ResponseEntityExceptionHandler
+{
+    @Autowired
+    private HelperFunctions helperFunctions;
+
+    public RestExceptionHandler()
+    {
+        super();
+    }
+
+    @ExceptionHandler(ResourceNotFoundException.class)
+    public ResponseEntity<?> handleResourcesNotFoundException(ResourceNotFoundException rnfe)
+    {
+        ErrorDetail errorDetail = new ErrorDetail();
+        errorDetail.setTimestamp(new Date());
+        errorDetail.setStatus(HttpStatus.NOT_FOUND.value());
+        errorDetail.setTitle("Resource Not Found!");
+        errorDetail.setDetail(rnfe.getMessage());
+        errorDetail.setDeveloperMessage(rnfe.getClass().getName());
+        errorDetail.setErrors(helperFunctions.getConstraintViolation(rnfe));
+
+        return new ResponseEntity<>(errorDetail, HttpStatus.NOT_FOUND);
+    }
+
+    @Override
+    protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request) {
+        ErrorDetail errorDetail = new ErrorDetail();
+
+        errorDetail.setTimestamp(new Date());
+        errorDetail.setStatus(HttpStatus.NOT_FOUND.value());
+        errorDetail.setTitle("REST Internal Exception!");
+        errorDetail.setDetail(ex.getMessage());
+        errorDetail.setDeveloperMessage(ex.getClass().getName());
+        errorDetail.setErrors(helperFunctions.getConstraintViolation(ex));
+
+
+        return new ResponseEntity<>(errorDetail, status);
+    }
+
+    @Override
+    protected ResponseEntity<Object> handleNoHandlerFoundException(NoHandlerFoundException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
+        ErrorDetail errorDetail = new ErrorDetail();
+        errorDetail.setTimestamp(new Date());
+        errorDetail.setStatus(status.value());
+        errorDetail.setTitle("Rest Endpoint Not Valid");
+        errorDetail.setDetail(request.getDescription(false));
+        errorDetail.setDeveloperMessage("Rest Handler Not Found (Check For Valid URI)");
+        errorDetail.setErrors(helperFunctions.getConstraintViolation(ex));
+
+        return new ResponseEntity<>(errorDetail, null, status);
+    }
+}

schools/src/main/java/com/lambdaschool/schools/models/ErrorDetail.java

@@ -0,0 +1,68 @@
+package com.lambdaschool.schools.models;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+public class ErrorDetail
+{
+    private String title;
+    private int status;
+    private String detail;
+    private Date timestamp;
+    private String developerMessage;
+
+    private List<ValidationError> errors = new ArrayList<>();
+
+    public ErrorDetail()
+    {
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public int getStatus() {
+        return status;
+    }
+
+    public void setStatus(int status) {
+        this.status = status;
+    }
+
+    public String getDetail() {
+        return detail;
+    }
+
+    public void setDetail(String detail) {
+        this.detail = "Found an error with School: " + detail;
+    }
+
+    public Date getTimestamp() {
+        return timestamp;
+    }
+
+    public void setTimestamp(Date timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    public String getDeveloperMessage() {
+        return developerMessage;
+    }
+
+    public void setDeveloperMessage(String developerMessage) {
+        this.developerMessage = developerMessage;
+    }
+
+    public List<ValidationError> getErrors() {
+        return errors;
+    }
+
+    public void setErrors(List<ValidationError> errors) {
+        this.errors = errors;
+    }
+}

schools/src/main/java/com/lambdaschool/schools/models/ValidationError.java

@@ -0,0 +1,31 @@
+package com.lambdaschool.schools.models;
+
+public class ValidationError
+{
+    private String code;
+    private String message;
+
+    public String getCode() {
+        return code;
+    }
+
+    public void setCode(String code) {
+        this.code = code;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+
+    @Override
+    public String toString() {
+        return "ValidationError{" +
+                "code='" + code + '\'' +
+                ", message='" + message + '\'' +
+                '}';
+    }
+}

schools/src/main/java/com/lambdaschool/schools/services/CoursesServiceImpl.java

@@ -1,5 +1,6 @@
 package com.lambdaschool.schools.services;
 
+import com.lambdaschool.schools.exceptions.ResourceNotFoundException;
 import com.lambdaschool.schools.models.Course;
 import com.lambdaschool.schools.models.Instructor;
 import com.lambdaschool.schools.models.StudCourses;
@@ -58,15 +59,15 @@ public List<Course> findAll()
     public Course findCourseById(long id)
     {
         return courserepos.findById(id)
-            .orElseThrow(() -> new EntityNotFoundException("Course id " + id + " not found!"));
+            .orElseThrow(() -> new ResourceNotFoundException("Course id " + id + " not found!"));
     }
 
     @Transactional
     @Override
     public void delete(long id)
     {
         courserepos.findById(id)
-            .orElseThrow(() -> new EntityNotFoundException("Course id " + id + " not found!"));
+            .orElseThrow(() -> new ResourceNotFoundException("Course id " + id + " not found!"));
         courserepos.deleteById(id);
     }
 
@@ -79,15 +80,15 @@ public Course save(Course course)
         if (course.getCourseid() != 0)
         {
             Course oldCourse = courserepos.findById(course.getCourseid())
-                .orElseThrow(() -> new EntityNotFoundException("Course id " + course.getCourseid() + " not found!"));
+                .orElseThrow(() -> new ResourceNotFoundException("Course id " + course.getCourseid() + " not found!"));
 
             newCourse.setCourseid(course.getCourseid());
         }
 
         newCourse.setCoursename(course.getCoursename());
         Instructor newInstructor = instructorrepos.findById(course.getInstructor()
             .getInstructorid())
-            .orElseThrow(() -> new EntityNotFoundException("Instructor id " + course.getInstructor()
+            .orElseThrow(() -> new ResourceNotFoundException("Instructor id " + course.getInstructor()
                 .getInstructorid() + " not found!"));
         newCourse.setInstructor(newInstructor);
 
@@ -97,7 +98,7 @@ public Course save(Course course)
         {
             Student newStudent = studentrepos.findById(sc.getStudent()
                 .getStudentid())
-                .orElseThrow(() -> new EntityNotFoundException("Instructor id " + sc.getStudent()
+                .orElseThrow(() -> new ResourceNotFoundException("Instructor id " + sc.getStudent()
                     .getStudentid() + " not found!"));
 
             newCourse.getStudents()

schools/src/main/java/com/lambdaschool/schools/services/HelperFunctions.java

@@ -0,0 +1,10 @@
+package com.lambdaschool.schools.services;
+
+import com.lambdaschool.schools.exceptions.ResourceNotFoundException;
+import com.lambdaschool.schools.models.ValidationError;
+
+import java.util.List;
+
+public interface HelperFunctions {
+      List<ValidationError> getConstraintViolation(Throwable cause);
+}

schools/src/main/java/com/lambdaschool/schools/services/HelperFunctionsImpl.java

@@ -0,0 +1,50 @@
+package com.lambdaschool.schools.services;
+
+import com.lambdaschool.schools.models.ValidationError;
+import org.hibernate.exception.ConstraintViolationException;
+import org.springframework.stereotype.Service;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@Service(value = "helperFunctions")
+public class HelperFunctionsImpl implements HelperFunctions
+{
+
+    @Override
+    public List<ValidationError> getConstraintViolation(Throwable cause) {
+        while ((cause != null) && !(cause instanceof org.hibernate.exception.ConstraintViolationException ||
+                cause instanceof MethodArgumentNotValidException))
+        {
+            cause = cause.getCause();
+        }
+
+        List<ValidationError> listVE = new ArrayList<>();
+        if (cause != null)
+        {
+            if (cause instanceof  org.hibernate.exception.ConstraintViolationException)
+            {
+                org.hibernate.exception.ConstraintViolationException ex = (ConstraintViolationException) cause;
+                ValidationError newVE = new ValidationError();
+                newVE.setCode(ex.getMessage());
+                newVE.setMessage(ex.getConstraintName());
+                listVE.add(newVE);
+            } else
+            {
+                MethodArgumentNotValidException ex = (MethodArgumentNotValidException) cause;
+                List<FieldError> fieldErrors = ex.getBindingResult().getFieldErrors();
+                for (FieldError err : fieldErrors)
+                {
+                    ValidationError newVE = new ValidationError();
+                    newVE.setCode(err.getField());
+                    newVE.setMessage(err.getDefaultMessage());
+                    listVE.add(newVE);
+                }
+            }
+
+        }
+        return listVE;
+    }
+}