io.spotnext.spring.web.controller.AbstractBaseRestController Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spot-spring-web-support Show documentation

The spOt microservice framework.

There is a newer version: 1.0.21-BETA-20190513

Show newest version

package io.spotnext.spring.web.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.http.HttpStatus;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import io.spotnext.spring.web.http.HttpResponse;
import io.spotnext.spring.web.http.Status;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * Abstract AbstractBaseRestController class.
 *
 * @author mojo2012
 * @version 1.0
 * @since 1.0
 */
@ControllerAdvice
@SuppressFBWarnings("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
public abstract class AbstractBaseRestController extends AbstractBaseController {

	/**
	 * Handles all thrown exceptions and returns error details as JSON.
	 *
	 * @param request a {@link javax.servlet.http.HttpServletRequest} object.
	 * @param exception a {@link java.lang.Exception} object.
	 * @param response a {@link javax.servlet.http.HttpServletResponse} object.
	 * @return a {@link io.spotnext.spring.web.http.HttpResponse} object.
	 */
	@ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR)
	@ResponseBody
	@ExceptionHandler({ Exception.class, IllegalStateException.class, IllegalArgumentException.class })
	public HttpResponse handleError(final HttpServletRequest request, final HttpServletResponse response,
			final Exception exception) {

		loggingService.exception(String.format("Unhandled exception %s occured: %s",
				exception.getClass().getSimpleName(), exception.getMessage()), exception);

		final HttpResponse ret = new HttpResponse<>(HttpStatus.INTERNAL_SERVER_ERROR);

		if (exception instanceof HttpMediaTypeNotSupportedException) {
			response.setStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE.value());
		}

		ret.getBody().getErrors().add(new Status("server.error", exception.getMessage()));

		return ret;
	}
}