/*
    * ====================================================================
    * 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.http.impl.conn;
  
  import java.io.IOException;
  
  import org.apache.http.HttpHost;
  import org.apache.http.conn.ClientConnectionManager;
  import org.apache.http.conn.OperatedClientConnection;
  import org.apache.http.conn.routing.HttpRoute;
  import org.apache.http.params.HttpParams;
  import org.apache.http.protocol.HttpContext;
  
  /**
   * Abstract adapter from pool {@link AbstractPoolEntry entries} to
   * {@link org.apache.http.conn.ManagedClientConnection managed}
   * client connections.
   * The connection in the pool entry is used to initialize the base class.
   * In addition, methods to establish a route are delegated to the
   * pool entry. {@link #shutdown shutdown} and {@link #close close}
   * will clear the tracked route in the pool entry and call the
   * respective method of the wrapped connection.
   *
   * @since 4.0
   *
   * @deprecated (4.2)  do not use
   */
  @Deprecated
  public abstract class AbstractPooledConnAdapter extends AbstractClientConnAdapter {
  
      /** The wrapped pool entry. */
      protected volatile AbstractPoolEntry poolEntry;
  
      /**
       * Creates a new connection adapter.
       *
       * @param manager   the connection manager
       * @param entry     the pool entry for the connection being wrapped
       */
      protected AbstractPooledConnAdapter(final ClientConnectionManager manager,
                                          final AbstractPoolEntry entry) {
          super(manager, entry.connection);
          this.poolEntry = entry;
      }
  
      @Override
      public String getId() {
          return null;
      }
  
      /**
       * Obtains the pool entry.
       *
       * @return  the pool entry, or {@code null} if detached
       *
       * @deprecated (4.0.1)
       */
      @Deprecated
      protected AbstractPoolEntry getPoolEntry() {
          return this.poolEntry;
      }
  
      /**
       * Asserts that there is a valid pool entry.
       *
       * @throws ConnectionShutdownException if there is no pool entry
       *                                  or connection has been aborted
       *
       * @see #assertValid(OperatedClientConnection)
       */
      protected void assertValid(final AbstractPoolEntry entry) {
          if (isReleased() || entry == null) {
              throw new ConnectionShutdownException();
          }
      }
 
     /**
      * @deprecated (4.1)  use {@link #assertValid(AbstractPoolEntry)}
      */
     @Deprecated
     protected final void assertAttached() {
         if (poolEntry == null) {
             throw new ConnectionShutdownException();
         }
     }
 
     /**
      * Detaches this adapter from the wrapped connection.
      * This adapter becomes useless.
      */
     @Override
     protected synchronized void detach() {
         poolEntry = null;
         super.detach();
     }
 
     @Override
     public HttpRoute getRoute() {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         return (entry.tracker == null) ? null : entry.tracker.toRoute();
     }
 
     @Override
     public void open(final HttpRoute route,
                      final HttpContext context, final HttpParams params)
         throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         entry.open(route, context, params);
     }
 
     @Override
     public void tunnelTarget(final boolean secure, final HttpParams params)
         throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         entry.tunnelTarget(secure, params);
     }
 
     @Override
     public void tunnelProxy(final HttpHost next, final boolean secure, final HttpParams params)
         throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         entry.tunnelProxy(next, secure, params);
     }
 
     @Override
     public void layerProtocol(final HttpContext context, final HttpParams params)
         throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         entry.layerProtocol(context, params);
     }
 
     @Override
     public void close() throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         if (entry != null) {
             entry.shutdownEntry();
         }
 
         final OperatedClientConnection conn = getWrappedConnection();
         if (conn != null) {
             conn.close();
         }
     }
 
     @Override
     public void shutdown() throws IOException {
         final AbstractPoolEntry entry = getPoolEntry();
         if (entry != null) {
             entry.shutdownEntry();
         }
 
         final OperatedClientConnection conn = getWrappedConnection();
         if (conn != null) {
             conn.shutdown();
         }
     }
 
     @Override
     public Object getState() {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         return entry.getState();
     }
 
     @Override
     public void setState(final Object state) {
         final AbstractPoolEntry entry = getPoolEntry();
         assertValid(entry);
         entry.setState(state);
     }
 
 }