All Downloads are FREE. Search and download functionalities are using the official Maven repository.

gov.nasa.pds.api.registry.controllers.RegistryApiResponseEntityExceptionHandler Maven / Gradle / Ivy

Go to download

Registry API Service contributing to the PDS Federated Search API

There is a newer version: 4.5.6
Show newest version
package gov.nasa.pds.api.registry.controllers;


import java.util.Set;
import gov.nasa.pds.api.registry.configuration.WebMVCConfig;
import gov.nasa.pds.api.registry.model.exceptions.*;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;


@ControllerAdvice
public class RegistryApiResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {

  private String errorDisclaimerHeader = "An error occured.\n";
  private String errorDisclaimerFooter =
      "For assistance, forward this error message to [email protected]";

  // TODO refactor code to avoid repeating oneself.

  private ResponseEntity genericExceptionHandler(RegistryApiException ex,
      WebRequest request, String errorDescrpitionSuffix, HttpStatus status) {

    String requestDescription = request.getDescription(false);
    String errorDescription = ex.getMessage() + errorDescrpitionSuffix;
    String errorIdentifier = ex.getUuid();


    String bodyOfResponse =
        status.toString() + "\n Request " + requestDescription + " failed with message:\n"
            + errorDescription + "(ref:" + errorIdentifier + ")\n" + errorDisclaimerFooter;
    return handleExceptionInternal(ex, bodyOfResponse, new HttpHeaders(), status, request);

  }


  @ExceptionHandler(value = {NotFoundException.class})
  protected ResponseEntity notFound(NotFoundException ex, WebRequest request) {
    return genericExceptionHandler(ex, request, "", HttpStatus.NOT_FOUND);

  }

  @ExceptionHandler(value = {BadRequestException.class})
  protected ResponseEntity badRequest(BadRequestException ex, WebRequest request) {
    return genericExceptionHandler(ex, request, "", HttpStatus.BAD_REQUEST);

  }

  @ExceptionHandler(value = {UnhandledException.class})
  protected ResponseEntity unhandled(UnhandledException ex, WebRequest request) {
    return genericExceptionHandler(ex, request, "", HttpStatus.INTERNAL_SERVER_ERROR);
  }


  @ExceptionHandler(value = {AcceptFormatNotSupportedException.class})
  protected ResponseEntity notAcceptable(AcceptFormatNotSupportedException ex,
      WebRequest request) {
    Set supportedFormats = WebMVCConfig.getFormatters().keySet();
    String errorDescriptionSuffix =
        " Supported formats (in Accept header) are: " + String.join(", ", supportedFormats);

    return genericExceptionHandler(ex, request, errorDescriptionSuffix, HttpStatus.NOT_ACCEPTABLE);

  }

  @ExceptionHandler(value = {SortSearchAfterMismatchException.class})
  protected ResponseEntity missSort(SortSearchAfterMismatchException ex,
      WebRequest request) {
    return genericExceptionHandler(ex, request, "", HttpStatus.BAD_REQUEST);
  }

  @ExceptionHandler(value = {UnparsableQParamException.class})
  protected ResponseEntity unparsableQParam(UnparsableQParamException ex,
      WebRequest request) {
    return genericExceptionHandler(ex, request, "", HttpStatus.BAD_REQUEST);
  }


}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy