com.helger.smpclient.httpclient.AbstractSMPResponseHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of peppol-smp-client Show documentation
Peppol and OASIS BDXR SMP client
There is a newer version: 9.6.0
/*
 * Copyright (C) 2015-2024 Philip Helger
 * 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.smpclient.httpclient;

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

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

import org.apache.hc.client5.http.ClientProtocolException;
import org.apache.hc.client5.http.HttpResponseException;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;

import com.helger.commons.debug.GlobalDebug;
import com.helger.httpclient.HttpClientHelper;
import com.helger.smpclient.exception.SMPClientBadResponseException;

/**
 * Abstract {@link HttpClientResponseHandler} implementation that ensures a leak
 * free usage of the returned response.
 * 
 * Note: this class is also licensed under Apache 2 license, as it was not part
 * of the original implementation
 * 
 *
 * @author Philip Helger
 * @param 
 *        Date type to be created
 */
public abstract class AbstractSMPResponseHandler  implements HttpClientResponseHandler 
{
  /**
   * Handle the response entity and transform it into the actual response
   * object.
   *
   * @param aEntity
   *        The entity to handle. Never null.
   * @return the result. May be null.
   * @throws IOException
   *         on IO error
   * @throws SMPClientBadResponseException
   *         if something goes wrong
   */
  @Nullable
  public abstract T handleEntity (@Nonnull HttpEntity aEntity) throws IOException, SMPClientBadResponseException;

  /**
   * Read the entity from the response body and pass it to the entity handler
   * method if the response was successful (a 2xx status code). If no response
   * body exists, this returns null. If the response was unsuccessful (>= 300
   * status code), throws an {@link HttpResponseException}.
   */
  @Nullable
  public T handleResponse (@Nonnull final ClassicHttpResponse aResponse) throws IOException
  {
    final HttpEntity aEntity = aResponse.getEntity ();
    if (aResponse.getCode () >= 300)
    {
      if (GlobalDebug.isDebugMode ())
      {
        // Contain response details in exception
        final String sEntity = HttpClientHelper.entityToString (aEntity, StandardCharsets.UTF_8);
        throw new HttpResponseException (aResponse.getCode (), aResponse.getReasonPhrase () + "\n" + sEntity);
      }
      throw new HttpResponseException (aResponse.getCode (), aResponse.getReasonPhrase ());
    }
    try
    {
      return aEntity == null ? null : handleEntity (aEntity);
    }
    catch (final SMPClientBadResponseException ex)
    {
      // Wrap to comply to API :(
      throw new ClientProtocolException (ex);
    }
  }
}