nu.yona.server.rest.GlobalExceptionMapping.java Source code

Introduction

Here is the source code for nu.yona.server.rest.GlobalExceptionMapping.java

Source

/*******************************************************************************
 * Copyright (c) 2016, 2017 Stichting Yona Foundation This Source Code Form is subject to the terms of the Mozilla Public License, v.
 * 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *******************************************************************************/
package nu.yona.server.rest;

import java.text.MessageFormat;
import java.util.Locale;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.i18n.LocaleContextHolder;
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.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import nu.yona.server.Translator;
import nu.yona.server.exceptions.YonaException;

/**
 * This class contains the mapping for the different exceptions and how they should be mapped to an http response
 */
@ControllerAdvice
public class GlobalExceptionMapping {
    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionMapping.class);

    /**
     * This method generically handles the illegal argument exceptions. They are translated into nice ResponseMessage objects so
     * the response data is properly organized and JSON parseable.
     * 
     * @param exception The exception.
     * @return The response object to return.
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public ErrorResponseDto handleOtherException(Exception exception, HttpServletRequest request) {
        logUnhandledException("Request {0} completed with unknown exception: {1}", buildRequestInfo(request),
                exception);

        return new ErrorResponseDto(null, exception.getMessage());
    }

    /**
     * This method generically handles the Yona exceptions. They are translated into nice ResponseMessage objects so the response
     * data is properly organized and JSON parseable.
     * 
     * @param exception The exception.
     * @return The response object to return.
     */
    @ExceptionHandler(YonaException.class)
    public ResponseEntity<ErrorResponseDto> handleYonaException(YonaException exception,
            HttpServletRequest request) {
        logUnhandledException("Request {0} completed with Yona exception: {1}", buildRequestInfo(request),
                exception);

        ErrorResponseDto responseMessage = new ErrorResponseDto(exception.getMessageId(), exception.getMessage());

        return new ResponseEntity<>(responseMessage, exception.getStatusCode());
    }

    private void logUnhandledException(String message, String requestInfo, Exception exception) {
        Locale currentLocale = LocaleContextHolder.getLocale();
        try {
            LocaleContextHolder.setLocale(Translator.EN_US_LOCALE);
            logger.error(MessageFormat.format(message, requestInfo, exception.getMessage()), exception);
        } finally {
            LocaleContextHolder.setLocale(currentLocale);
        }
    }

    public static String buildRequestInfo(HttpServletRequest request) {
        String queryString = request.getQueryString();
        String url = StringUtils.isBlank(queryString) ? request.getRequestURI()
                : request.getRequestURI() + "?" + queryString;
        return MessageFormat.format("{0} on URL {1}", request.getMethod(), url);
    }
}