All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.vip.saturn.job.console.controller.rest.AbstractRestController Maven / Gradle / Ivy

    /**
 * Copyright 2016 vip.com.
 * 
    
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 *  the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 * 
    
 **/

package com.vip.saturn.job.console.controller.rest;

import com.vip.saturn.job.console.controller.AbstractController;
import com.vip.saturn.job.console.domain.RestApiErrorResult;
import com.vip.saturn.job.console.exception.SaturnJobConsoleException;
import com.vip.saturn.job.console.exception.SaturnJobConsoleHttpException;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import static com.vip.saturn.job.console.exception.SaturnJobConsoleException.*;

/**
 * Handler for RESTful API Exception.
 * 
     Created by jeff.zhu on 26/05/2017.
 */
public abstract class AbstractRestController extends AbstractController {

	private static final Logger log = LoggerFactory.getLogger(AbstractRestController.class);

	@ExceptionHandler
	public ResponseEntity handleSaturnJobConsoleException(SaturnJobConsoleException e) {
		String message = e.getMessage();
		if (StringUtils.isBlank(message)) {
			message = e.toString();
		}

		switch (e.getErrorCode()) {
			case ERROR_CODE_NOT_EXISTED:
				log.warn("resource not found while calling REST API:{}", message);
				return constructErrorResponse(message, HttpStatus.NOT_FOUND);
			case ERROR_CODE_BAD_REQUEST:
				log.warn("bad request while calling REST API:{}", message);
				return constructErrorResponse(message, HttpStatus.BAD_REQUEST);
			case ERROR_CODE_INTERNAL_ERROR:
			default:
				log.error("internal server error happens while calling REST API:{}", message);
				return constructErrorResponse(message, HttpStatus.INTERNAL_SERVER_ERROR);
		}
	}

	@ExceptionHandler
	public ResponseEntity handleSaturnJobConsoleHttpException(SaturnJobConsoleHttpException e) {
		HttpHeaders httpHeaders = new HttpHeaders();

		int statusCode = e.getStatusCode();
		if (statusCode == HttpStatus.CREATED.value()) {
			return new ResponseEntity<>(httpHeaders, HttpStatus.CREATED);
		}

		HttpStatus httpStatus;
		try {
			httpStatus = HttpStatus.valueOf(statusCode);
		} catch (IllegalArgumentException e1) {
			httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;
		}

		String message = e.getMessage();
		if (StringUtils.isBlank(message)) {
			message = e.toString();
		}

		if (httpStatus.is5xxServerError()) {
			log.error("Internal server error happens while calling REST API:{}", message);
		} else {
			log.warn("Exception happens while calling REST API:{}", message);
		}

		return constructErrorResponse(message, httpStatus);
	}

	@ExceptionHandler
	@ResponseBody
	@ResponseStatus(HttpStatus.BAD_REQUEST)
	public RestApiErrorResult handleMessageNotReadableException(HttpMessageNotReadableException e) {
		return new RestApiErrorResult("The http message is not readable. Please check your request.");
	}

	@ExceptionHandler
	@ResponseBody
	@ResponseStatus(HttpStatus.BAD_REQUEST)
	public RestApiErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
		return new RestApiErrorResult("Method or argument not valid");
	}

	@ExceptionHandler
	@ResponseBody
	@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
	public RestApiErrorResult handleMessageNotReadableException(HttpMediaTypeNotSupportedException e) {
		return new RestApiErrorResult("Media type not supported.");
	}

	private ResponseEntity constructErrorResponse(String errorMsg, HttpStatus status) {
		HttpHeaders httpHeaders = new HttpHeaders();
		httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);
		RestApiErrorResult restApiErrorResult = new RestApiErrorResult();
		restApiErrorResult.setMessage(errorMsg);
		return new ResponseEntity(restApiErrorResult, httpHeaders, status);
	}
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy