com.helger.httpclient.response.ExtendedHttpResponseException.java Source code

Introduction

Here is the source code for com.helger.httpclient.response.ExtendedHttpResponseException.java

Source

/**
 * Copyright (C) 2016-2018 Philip Helger (www.helger.com)
 * philip[at]helger[dot]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.helger.httpclient.response;

import java.io.IOException;
import java.nio.charset.Charset;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.StatusLine;
import org.apache.http.client.HttpResponseException;
import org.apache.http.entity.ContentType;
import org.apache.http.util.EntityUtils;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.ArrayHelper;
import com.helger.httpclient.HttpClientHelper;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * A specialized version of {@link HttpResponseException} that has access to all
 * the fields in a structured way.
 *
 * @author Philip Helger
 * @since 8.8.1
 */
public class ExtendedHttpResponseException extends HttpResponseException {
    private final StatusLine m_aStatusLine;
    private final HttpResponse m_aHttpResponse;
    private final byte[] m_aResponseBody;
    private final Charset m_aResponseCharset;

    @SuppressFBWarnings("EI_EXPOSE_REP2")
    public ExtendedHttpResponseException(@Nonnull final StatusLine aStatusLine,
            @Nonnull final HttpResponse aHttpResponse, @Nullable final byte[] aResponseBody,
            @Nonnull final Charset aCharset) {
        super(aStatusLine.getStatusCode(),
                aStatusLine.getReasonPhrase() + " [" + aStatusLine.getStatusCode() + "]");
        ValueEnforcer.notNull(aHttpResponse, "HTTPResponse");
        ValueEnforcer.notNull(aCharset, "Charset");
        m_aStatusLine = aStatusLine;
        m_aHttpResponse = aHttpResponse;
        m_aResponseBody = aResponseBody;
        m_aResponseCharset = aCharset;
    }

    /**
     * @return The status line received. Never <code>null</code>.
     */
    @Nonnull
    public StatusLine getStatusLine() {
        return m_aStatusLine;
    }

    /**
     * @return The HTTP response object that triggered the exception. May not be
     *         <code>null</code>. May be used to determine the headers of the
     *         response.
     */
    @Nonnull
    public HttpResponse getHttpResponse() {
        return m_aHttpResponse;
    }

    /**
     * @return The response body bytes. May be <code>null</code>.
     */
    @Nullable
    @ReturnsMutableObject
    @SuppressFBWarnings("EI_EXPOSE_REP")
    public byte[] directGetResponseBody() {
        return m_aResponseBody;
    }

    /**
     * @return A copy of the response body bytes. May be <code>null</code>.
     */
    @Nullable
    @ReturnsMutableCopy
    public byte[] getResponseBody() {
        return ArrayHelper.getCopy(m_aResponseBody);
    }

    /**
     * @return <code>true</code> if a response body is present, <code>false</code>
     *         otherwise.
     */
    public boolean hasResponseBody() {
        return ArrayHelper.isNotEmpty(m_aResponseBody);
    }

    /**
     * @return The response charset. Never <code>null</code>.
     */
    @Nonnull
    public Charset getResponseCharset() {
        return m_aResponseCharset;
    }

    /**
     * @return The response body as a string in the response charset. May be
     *         <code>null</code> if no response body is present.
     * @see #getResponseBodyAsString(Charset)
     * @see #getResponseCharset()
     */
    @Nullable
    public String getResponseBodyAsString() {
        return getResponseBodyAsString(m_aResponseCharset);
    }

    /**
     * Get the response body as a string in the provided charset.
     *
     * @param aCharset
     *        The charset to use. May not be <code>null</code>.
     * @return <code>null</code> if no response body is present.
     */
    @Nullable
    public String getResponseBodyAsString(@Nonnull final Charset aCharset) {
        return m_aResponseBody == null ? null : new String(m_aResponseBody, aCharset);
    }

    @Override
    @Nonnull
    public String getMessage() {
        final StringBuilder aSB = new StringBuilder();
        aSB.append(m_aStatusLine.getReasonPhrase()).append(" [").append(m_aStatusLine.getStatusCode()).append(']');

        final Header[] aHeaders = m_aHttpResponse.getAllHeaders();
        aSB.append("\nAll ").append(aHeaders.length).append(" headers returned");
        for (final Header aHeader : aHeaders)
            aSB.append("\n  ").append(aHeader.getName()).append('=').append(aHeader.getValue());

        if (m_aResponseBody != null) {
            aSB.append("\nResponse Body (in ").append(getResponseCharset().name()).append("):\n")
                    .append(getResponseBodyAsString());
        } else
            aSB.append("\nNo Response Body present!");

        return aSB.toString();
    }

    @Nonnull
    public static ExtendedHttpResponseException create(@Nonnull final StatusLine aStatusLine,
            @Nonnull final HttpResponse aHttpResponse, @Nonnull final HttpEntity aEntity) throws IOException {
        ContentType aContentType = ContentType.get(aEntity);
        if (aContentType == null)
            aContentType = ContentType.DEFAULT_TEXT;

        // Default to ISO-8859-1 internally
        final Charset aCharset = HttpClientHelper.getCharset(aContentType);

        // Consume entity
        final byte[] aResponseBody = EntityUtils.toByteArray(aEntity);

        return new ExtendedHttpResponseException(aStatusLine, aHttpResponse, aResponseBody, aCharset);
    }
}