org.apache.http.impl.conn
Class AbstractPooledConnAdapter

java.lang.Object
  extended by org.apache.http.impl.conn.AbstractClientConnAdapter
      extended by org.apache.http.impl.conn.AbstractPooledConnAdapter
All Implemented Interfaces:
ConnectionReleaseTrigger, ManagedClientConnection, org.apache.http.HttpClientConnection, org.apache.http.HttpConnection, org.apache.http.HttpInetConnection
Direct Known Subclasses:
BasicPooledConnAdapter, SingleClientConnManager.ConnAdapter

public abstract class AbstractPooledConnAdapter
extends AbstractClientConnAdapter
implements ManagedClientConnection

Abstract adapter from pool entries to 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. shutdown and close will clear the tracked route in the pool entry and call the respective method of the wrapped connection.

Since:
4.0
Version:
$Revision: 573844 $ $Date: 2007-09-08 16:20:53 +0200 (Sat, 08 Sep 2007) $
Author:
Roland Weber

Field Summary
protected  AbstractPoolEntry poolEntry
          The wrapped pool entry.
 
Fields inherited from class org.apache.http.impl.conn.AbstractClientConnAdapter
connManager, markedReusable, wrappedConnection
 
Constructor Summary
protected AbstractPooledConnAdapter(ClientConnectionManager manager, AbstractPoolEntry entry)
          Creates a new connection adapter.
 
Method Summary
protected  void assertAttached()
          Asserts that this adapter is still attached.
 void close()
           
protected  void detach()
          Detaches this adapter from the wrapped connection.
 HttpRoute getRoute()
          Obtains the current route of this connection.
 void layerProtocol(org.apache.http.protocol.HttpContext context, org.apache.http.params.HttpParams params)
          Layers a new protocol on top of a tunnelled connection.
 void open(HttpRoute route, org.apache.http.protocol.HttpContext context, org.apache.http.params.HttpParams params)
          Opens this connection according to the given route.
 void shutdown()
           
 void tunnelProxy(org.apache.http.HttpHost next, boolean secure, org.apache.http.params.HttpParams params)
          Indicates that a tunnel to an intermediate proxy has been established.
 void tunnelTarget(boolean secure, org.apache.http.params.HttpParams params)
          Indicates that a tunnel to the target has been established.
 
Methods inherited from class org.apache.http.impl.conn.AbstractClientConnAdapter
abortConnection, assertWrappedConn, flush, getLocalAddress, getLocalPort, getMetrics, getRemoteAddress, getRemotePort, getSocketTimeout, getSSLSession, isMarkedReusable, isOpen, isResponseAvailable, isSecure, isStale, markReusable, receiveResponseEntity, receiveResponseHeader, releaseConnection, sendRequestEntity, sendRequestHeader, setSocketTimeout, unmarkReusable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.http.conn.ManagedClientConnection
getSSLSession, isMarkedReusable, isSecure, markReusable, unmarkReusable
 
Methods inherited from interface org.apache.http.HttpClientConnection
flush, isResponseAvailable, receiveResponseEntity, receiveResponseHeader, sendRequestEntity, sendRequestHeader
 
Methods inherited from interface org.apache.http.HttpConnection
getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout
 
Methods inherited from interface org.apache.http.HttpInetConnection
getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort
 
Methods inherited from interface org.apache.http.HttpConnection
getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout
 
Methods inherited from interface org.apache.http.conn.ConnectionReleaseTrigger
abortConnection, releaseConnection
 

Field Detail

poolEntry

protected AbstractPoolEntry poolEntry
The wrapped pool entry.

Constructor Detail

AbstractPooledConnAdapter

protected AbstractPooledConnAdapter(ClientConnectionManager manager,
                                    AbstractPoolEntry entry)
Creates a new connection adapter.

Parameters:
manager - the connection manager
entry - the pool entry for the connection being wrapped
Method Detail

assertAttached

protected final void assertAttached()
Asserts that this adapter is still attached.

Throws:
java.lang.IllegalStateException - if it is detached

detach

protected void detach()
Detaches this adapter from the wrapped connection. This adapter becomes useless.


getRoute

public HttpRoute getRoute()
Description copied from interface: ManagedClientConnection
Obtains the current route of this connection.

Specified by:
getRoute in interface ManagedClientConnection
Returns:
the route established so far, or null if not connected

open

public void open(HttpRoute route,
                 org.apache.http.protocol.HttpContext context,
                 org.apache.http.params.HttpParams params)
          throws java.io.IOException
Description copied from interface: ManagedClientConnection
Opens this connection according to the given route.

Specified by:
open in interface ManagedClientConnection
Parameters:
route - the route along which to open. It will be opened to the first proxy if present, or directly to the target.
context - the context for opening this connection
params - the parameters for opening this connection
Throws:
java.io.IOException - in case of a problem

tunnelTarget

public void tunnelTarget(boolean secure,
                         org.apache.http.params.HttpParams params)
                  throws java.io.IOException
Description copied from interface: ManagedClientConnection
Indicates that a tunnel to the target has been established. The route is the one previously passed to open. Subsequently, layerProtocol can be called to layer the TLS/SSL protocol on top of the tunnelled connection.
Note: In HttpClient 3, a call to the corresponding method would automatically trigger the layering of the TLS/SSL protocol. This is not the case anymore, you can establish a tunnel without layering a new protocol over the connection.

Specified by:
tunnelTarget in interface ManagedClientConnection
Parameters:
secure - true if the tunnel should be considered secure, false otherwise
params - the parameters for tunnelling this connection
Throws:
java.io.IOException - in case of a problem

tunnelProxy

public void tunnelProxy(org.apache.http.HttpHost next,
                        boolean secure,
                        org.apache.http.params.HttpParams params)
                 throws java.io.IOException
Description copied from interface: ManagedClientConnection
Indicates that a tunnel to an intermediate proxy has been established. This is used exclusively for so-called proxy chains, where a request has to pass through multiple proxies before reaching the target. In that case, all proxies but the last need to be tunnelled when establishing the connection. Tunnelling of the last proxy to the target is optional and would be indicated via ManagedClientConnection.tunnelTarget(boolean, org.apache.http.params.HttpParams).

Specified by:
tunnelProxy in interface ManagedClientConnection
Parameters:
next - the proxy to which the tunnel was established. This is not the proxy through which the tunnel was established, but the new end point of the tunnel. The tunnel does not yet reach to the target, use ManagedClientConnection.tunnelTarget(boolean, org.apache.http.params.HttpParams) to indicate an end-to-end tunnel.
secure - true if the connection should be considered secure, false otherwise
params - the parameters for tunnelling this connection
Throws:
java.io.IOException - in case of a problem

layerProtocol

public void layerProtocol(org.apache.http.protocol.HttpContext context,
                          org.apache.http.params.HttpParams params)
                   throws java.io.IOException
Description copied from interface: ManagedClientConnection
Layers a new protocol on top of a tunnelled connection. This is typically used to create a TLS/SSL connection through a proxy. The route is the one previously passed to open. It is not guaranteed that the layered connection is secure.

Specified by:
layerProtocol in interface ManagedClientConnection
Parameters:
context - the context for layering on top of this connection
params - the parameters for layering on top of this connection
Throws:
java.io.IOException - in case of a problem

close

public void close()
           throws java.io.IOException
Specified by:
close in interface org.apache.http.HttpConnection
Throws:
java.io.IOException

shutdown

public void shutdown()
              throws java.io.IOException
Specified by:
shutdown in interface org.apache.http.HttpConnection
Throws:
java.io.IOException


Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.