/*
    * ====================================================================
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.hc.client5.http.impl.classic;
  
  import java.io.IOException;
  import java.util.Iterator;
  import java.util.Locale;
  
  import org.apache.hc.client5.http.classic.ExecRuntime;
  import org.apache.hc.core5.annotation.Internal;
  import org.apache.hc.core5.http.ClassicHttpResponse;
  import org.apache.hc.core5.http.Header;
  import org.apache.hc.core5.http.HttpEntity;
  import org.apache.hc.core5.http.ProtocolException;
  import org.apache.hc.core5.http.ProtocolVersion;
  import org.apache.hc.core5.io.CloseMode;
  import org.apache.hc.core5.io.ModalCloseable;
  import org.apache.hc.core5.util.Args;
  
  /**
   * Provided for backward compatibility with HttpClient 4.x.
   *
   * @since 4.3
   */
  public final class CloseableHttpResponse implements ClassicHttpResponse, ModalCloseable {
  
      private final ClassicHttpResponse response;
      private final CloseableDelegate closeableDelegate;
  
      /**
       * @since 5.4
       */
      @Internal
      public static CloseableHttpResponse adapt(final ClassicHttpResponse response) {
          if (response == null) {
              return null;
          }
          return response instanceof CloseableHttpResponse ?
                  (CloseableHttpResponse) response :
                  new CloseableHttpResponse(response);
      }
  
      /**
       * @since 5.5
       */
      @Internal
      public static CloseableHttpResponse create(final ClassicHttpResponse response,
                                                 final CloseableDelegate closeableDelegate) {
          if (response == null) {
              return null;
          }
          return new CloseableHttpResponse(response, closeableDelegate);
      }
  
      CloseableHttpResponse(final ClassicHttpResponse response) {
          this.response = Args.notNull(response, "Response");
          this.closeableDelegate = null;
      }
  
      CloseableHttpResponse(final ClassicHttpResponse response, final CloseableDelegate closeableDelegate) {
          this.response = Args.notNull(response, "Response");
          this.closeableDelegate = closeableDelegate;
      }
  
      CloseableHttpResponse(final ClassicHttpResponse response, final ExecRuntime execRuntime) {
          this.response = Args.notNull(response, "Response");
          this.closeableDelegate = (closeable, closeMode) -> {
              try {
                  if (closeMode == CloseMode.GRACEFUL) {
                      response.close();
                  }
                  execRuntime.disconnectEndpoint();
              } finally {
                  execRuntime.discardEndpoint();
             }
         };
     }
 
     @Override
     public int getCode() {
         return response.getCode();
     }
 
     @Override
     public HttpEntity getEntity() {
         return response.getEntity();
     }
 
     @Override
     public boolean containsHeader(final String name) {
         return response.containsHeader(name);
     }
 
     @Override
     public void setVersion(final ProtocolVersion version) {
         response.setVersion(version);
     }
 
     @Override
     public void setCode(final int code) {
         response.setCode(code);
     }
 
     @Override
     public String getReasonPhrase() {
         return response.getReasonPhrase();
     }
 
     @Override
     public int countHeaders(final String name) {
         return response.countHeaders(name);
     }
 
     @Override
     public void setEntity(final HttpEntity entity) {
         response.setEntity(entity);
     }
 
     @Override
     public ProtocolVersion getVersion() {
         return response.getVersion();
     }
 
     @Override
     public void setReasonPhrase(final String reason) {
         response.setReasonPhrase(reason);
     }
 
     @Override
     public Header[] getHeaders(final String name) {
         return response.getHeaders(name);
     }
 
     @Override
     public void addHeader(final Header header) {
         response.addHeader(header);
     }
 
     @Override
     public Locale getLocale() {
         return response.getLocale();
     }
 
     @Override
     public void addHeader(final String name, final Object value) {
         response.addHeader(name, value);
     }
 
     @Override
     public void setLocale(final Locale loc) {
         response.setLocale(loc);
     }
 
     @Override
     public Header getHeader(final String name) throws ProtocolException {
         return response.getHeader(name);
     }
 
     @Override
     public void setHeader(final Header header) {
         response.setHeader(header);
     }
 
     @Override
     public Header getFirstHeader(final String name) {
         return response.getFirstHeader(name);
     }
 
     @Override
     public void setHeader(final String name, final Object value) {
         response.setHeader(name, value);
     }
 
     @Override
     public void setHeaders(final Header... headers) {
         response.setHeaders(headers);
     }
 
     @Override
     public boolean removeHeader(final Header header) {
         return response.removeHeader(header);
     }
 
     @Override
     public boolean removeHeaders(final String name) {
         return response.removeHeaders(name);
     }
 
     @Override
     public Header getLastHeader(final String name) {
         return response.getLastHeader(name);
     }
 
     @Override
     public Header[] getHeaders() {
         return response.getHeaders();
     }
 
     @Override
     public Iterator<Header> headerIterator() {
         return response.headerIterator();
     }
 
     @Override
     public Iterator<Header> headerIterator(final String name) {
         return response.headerIterator(name);
     }
 
     private void doClose(final CloseMode closeMode) throws IOException {
         if (closeableDelegate != null) {
             closeableDelegate.close(response, closeMode);
         } else {
             response.close();
         }
     }
 
     @Override
     public void close(final CloseMode closeMode) {
         try {
             doClose(closeMode);
         } catch (final IOException ignore) {
         }
     }
 
     @Override
     public void close() throws IOException {
         doClose(CloseMode.GRACEFUL);
     }
 
     @Override
     public String toString() {
         return response.toString();
     }
 
 }