org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-utilities Show documentation
Crafter Commons Utilities
There is a newer version: 4.1.8
Show newest version
/*
 * Copyright (C) 2007-2014 Crafter Software Corporation.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.craftercms.commons.rest;

import java.io.IOException;
import java.util.List;

import org.apache.commons.io.IOUtils;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.http.HttpStatus;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.client.HttpMessageConverterExtractor;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestClientException;

/**
 * {@link org.springframework.web.client.ResponseErrorHandler} that converts the body of a response with error status
 * code using {@link org.springframework.http.converter.HttpMessageConverter}s, and then throws a
 * {@link RestServiceException} with the deserialized response body as the {@code errorDetails}.
 *
 * @author avasquez
 */
public class HttpMessageConvertingResponseErrorHandler implements ResponseErrorHandler {

    protected List> messageConverters;
    protected Class responseType;

    public List> getMessageConverters() {
        return messageConverters;
    }

    public void setMessageConverters(List> messageConverters) {
        this.messageConverters = messageConverters;
    }

    public Class getResponseType() {
        return responseType;
    }

    @Required
    public void setResponseType(Class responseType) {
        this.responseType = responseType;
    }

    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        return hasError(response.getStatusCode());
    }

    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
        HttpStatus status = response.getStatusCode();
        HttpMessageConverterExtractor responseExtractor = new HttpMessageConverterExtractor<>(responseType,
            messageConverters);

        Object errorDetails;
        try {
            errorDetails = responseExtractor.extractData(response);
        } catch (RestClientException e) {
            // No message converter to extract the response, so make the error details
            // the response body as string
            throw new RestServiceException(status, getResponseBodyAsString(response));
        }

        throw new RestServiceException(status, errorDetails);
    }

    protected boolean hasError(HttpStatus statusCode) {
        return (statusCode.series() == HttpStatus.Series.CLIENT_ERROR || statusCode.series() == HttpStatus.Series
            .SERVER_ERROR);
    }

    protected String getResponseBodyAsString(ClientHttpResponse response) throws IOException {
        return IOUtils.toString(response.getBody(), response.getHeaders().getContentType().getCharset());
    }

}