Class AbstractClientConnAdapter
- java.lang.Object
-
- org.apache.http.impl.conn.AbstractClientConnAdapter
-
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable,ConnectionReleaseTrigger,HttpRoutedConnection,ManagedClientConnection,ManagedHttpClientConnection,org.apache.http.HttpClientConnection,org.apache.http.HttpConnection,org.apache.http.HttpInetConnection,org.apache.http.protocol.HttpContext
- Direct Known Subclasses:
AbstractPooledConnAdapter
@Deprecated public abstract class AbstractClientConnAdapter extends java.lang.Object implements ManagedClientConnection, org.apache.http.protocol.HttpContext
Deprecated.(4.2) do not useAbstract adapter fromoperatedtomanagedclient connections. Read and write methods are delegated to the wrapped connection. Operations affecting the connection state have to be implemented by derived classes. Operations for querying the connection state are delegated to the wrapped connection if there is one, or return a default value if there is none.This adapter tracks the checkpoints for reusable communication states, as indicated by
markReusableand queried byisMarkedReusable. All send and receive operations will automatically clear the mark.Connection release calls are delegated to the connection manager, if there is one.
abortConnectionwill clear the reusability mark first. The connection manager is expected to tolerate multiple calls to the release method.- Since:
- 4.0
-
-
Field Summary
Fields Modifier and Type Field Description private ClientConnectionManagerconnManagerDeprecated.The connection manager.private longdurationDeprecated.The duration this is valid for while idle (in ms).private booleanmarkedReusableDeprecated.The reusability marker.private booleanreleasedDeprecated.True if the connection has been shut down or released.private OperatedClientConnectionwrappedConnectionDeprecated.The wrapped connection.
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractClientConnAdapter(ClientConnectionManager mgr, OperatedClientConnection conn)Deprecated.Creates a new connection adapter.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidabortConnection()Deprecated.Releases the connection without the option of keep-alive.protected voidassertNotAborted()Deprecated.(4.1) useassertValid(OperatedClientConnection)protected voidassertValid(OperatedClientConnection wrappedConn)Deprecated.Asserts that there is a valid wrapped connection to delegate to.voidbind(java.net.Socket socket)Deprecated.Binds this connection to the given socket.protected voiddetach()Deprecated.Detaches this adapter from the wrapped connection.voidflush()Deprecated.java.lang.ObjectgetAttribute(java.lang.String id)Deprecated.java.net.InetAddressgetLocalAddress()Deprecated.intgetLocalPort()Deprecated.protected ClientConnectionManagergetManager()Deprecated.org.apache.http.HttpConnectionMetricsgetMetrics()Deprecated.java.net.InetAddressgetRemoteAddress()Deprecated.intgetRemotePort()Deprecated.java.net.SocketgetSocket()Deprecated.Returns the underlying socket.intgetSocketTimeout()Deprecated.javax.net.ssl.SSLSessiongetSSLSession()Deprecated.Obtains the SSL session of the underlying connection, if any.protected OperatedClientConnectiongetWrappedConnection()Deprecated.booleanisMarkedReusable()Deprecated.Indicates whether this connection is in a reusable communication state.booleanisOpen()Deprecated.protected booleanisReleased()Deprecated.booleanisResponseAvailable(int timeout)Deprecated.booleanisSecure()Deprecated.Indicates whether this connection is secure.booleanisStale()Deprecated.voidmarkReusable()Deprecated.Marks this connection as being in a reusable communication state.voidreceiveResponseEntity(org.apache.http.HttpResponse response)Deprecated.org.apache.http.HttpResponsereceiveResponseHeader()Deprecated.voidreleaseConnection()Deprecated.Releases the connection with the option of keep-alive.java.lang.ObjectremoveAttribute(java.lang.String id)Deprecated.voidsendRequestEntity(org.apache.http.HttpEntityEnclosingRequest request)Deprecated.voidsendRequestHeader(org.apache.http.HttpRequest request)Deprecated.voidsetAttribute(java.lang.String id, java.lang.Object obj)Deprecated.voidsetIdleDuration(long duration, java.util.concurrent.TimeUnit unit)Deprecated.Sets the duration that this connection can remain idle before it is reused.voidsetSocketTimeout(int timeout)Deprecated.voidunmarkReusable()Deprecated.Marks this connection as not being in a reusable state.-
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
getRoute, getState, layerProtocol, open, setState, tunnelProxy, tunnelTarget
-
Methods inherited from interface org.apache.http.conn.ManagedHttpClientConnection
getId
-
-
-
-
Field Detail
-
connManager
private final ClientConnectionManager connManager
Deprecated.The connection manager.
-
wrappedConnection
private volatile OperatedClientConnection wrappedConnection
Deprecated.The wrapped connection.
-
markedReusable
private volatile boolean markedReusable
Deprecated.The reusability marker.
-
released
private volatile boolean released
Deprecated.True if the connection has been shut down or released.
-
duration
private volatile long duration
Deprecated.The duration this is valid for while idle (in ms).
-
-
Constructor Detail
-
AbstractClientConnAdapter
protected AbstractClientConnAdapter(ClientConnectionManager mgr, OperatedClientConnection conn)
Deprecated.Creates a new connection adapter. The adapter is initially notmarkedas reusable.- Parameters:
mgr- the connection manager, ornullconn- the connection to wrap, ornull
-
-
Method Detail
-
detach
protected void detach()
Deprecated.Detaches this adapter from the wrapped connection. This adapter becomes useless.
-
getWrappedConnection
protected OperatedClientConnection getWrappedConnection()
Deprecated.
-
getManager
protected ClientConnectionManager getManager()
Deprecated.
-
assertNotAborted
@Deprecated protected final void assertNotAborted() throws java.io.InterruptedIOExceptionDeprecated.(4.1) useassertValid(OperatedClientConnection)- Throws:
java.io.InterruptedIOException
-
isReleased
protected boolean isReleased()
Deprecated.- Returns:
- value of released flag
- Since:
- 4.1
-
assertValid
protected final void assertValid(OperatedClientConnection wrappedConn) throws ConnectionShutdownException
Deprecated.Asserts that there is a valid wrapped connection to delegate to.- Throws:
ConnectionShutdownException- if there is no wrapped connection or connection has been aborted
-
isOpen
public boolean isOpen()
Deprecated.- Specified by:
isOpenin interfaceorg.apache.http.HttpConnection
-
isStale
public boolean isStale()
Deprecated.- Specified by:
isStalein interfaceorg.apache.http.HttpConnection
-
setSocketTimeout
public void setSocketTimeout(int timeout)
Deprecated.- Specified by:
setSocketTimeoutin interfaceorg.apache.http.HttpConnection
-
getSocketTimeout
public int getSocketTimeout()
Deprecated.- Specified by:
getSocketTimeoutin interfaceorg.apache.http.HttpConnection
-
getMetrics
public org.apache.http.HttpConnectionMetrics getMetrics()
Deprecated.- Specified by:
getMetricsin interfaceorg.apache.http.HttpConnection
-
flush
public void flush() throws java.io.IOExceptionDeprecated.- Specified by:
flushin interfaceorg.apache.http.HttpClientConnection- Throws:
java.io.IOException
-
isResponseAvailable
public boolean isResponseAvailable(int timeout) throws java.io.IOExceptionDeprecated.- Specified by:
isResponseAvailablein interfaceorg.apache.http.HttpClientConnection- Throws:
java.io.IOException
-
receiveResponseEntity
public void receiveResponseEntity(org.apache.http.HttpResponse response) throws org.apache.http.HttpException, java.io.IOExceptionDeprecated.- Specified by:
receiveResponseEntityin interfaceorg.apache.http.HttpClientConnection- Throws:
org.apache.http.HttpExceptionjava.io.IOException
-
receiveResponseHeader
public org.apache.http.HttpResponse receiveResponseHeader() throws org.apache.http.HttpException, java.io.IOExceptionDeprecated.- Specified by:
receiveResponseHeaderin interfaceorg.apache.http.HttpClientConnection- Throws:
org.apache.http.HttpExceptionjava.io.IOException
-
sendRequestEntity
public void sendRequestEntity(org.apache.http.HttpEntityEnclosingRequest request) throws org.apache.http.HttpException, java.io.IOExceptionDeprecated.- Specified by:
sendRequestEntityin interfaceorg.apache.http.HttpClientConnection- Throws:
org.apache.http.HttpExceptionjava.io.IOException
-
sendRequestHeader
public void sendRequestHeader(org.apache.http.HttpRequest request) throws org.apache.http.HttpException, java.io.IOExceptionDeprecated.- Specified by:
sendRequestHeaderin interfaceorg.apache.http.HttpClientConnection- Throws:
org.apache.http.HttpExceptionjava.io.IOException
-
getLocalAddress
public java.net.InetAddress getLocalAddress()
Deprecated.- Specified by:
getLocalAddressin interfaceorg.apache.http.HttpInetConnection
-
getLocalPort
public int getLocalPort()
Deprecated.- Specified by:
getLocalPortin interfaceorg.apache.http.HttpInetConnection
-
getRemoteAddress
public java.net.InetAddress getRemoteAddress()
Deprecated.- Specified by:
getRemoteAddressin interfaceorg.apache.http.HttpInetConnection
-
getRemotePort
public int getRemotePort()
Deprecated.- Specified by:
getRemotePortin interfaceorg.apache.http.HttpInetConnection
-
isSecure
public boolean isSecure()
Deprecated.Description copied from interface:ManagedClientConnectionIndicates whether this connection is secure. The return value is well-defined only while the connection is open. It may change even while the connection is open.- Specified by:
isSecurein interfaceHttpRoutedConnection- Specified by:
isSecurein interfaceManagedClientConnection- Returns:
trueif this connection is secure,falseotherwise
-
bind
public void bind(java.net.Socket socket) throws java.io.IOExceptionDeprecated.Description copied from interface:ManagedHttpClientConnectionBinds this connection to the given socket. The connection is considered open if it is bound and the underlying socket is connection to a remote host.- Specified by:
bindin interfaceManagedHttpClientConnection- Parameters:
socket- the socket to bind the connection to.- Throws:
java.io.IOException
-
getSocket
public java.net.Socket getSocket()
Deprecated.Description copied from interface:ManagedHttpClientConnectionReturns the underlying socket.- Specified by:
getSocketin interfaceManagedHttpClientConnection
-
getSSLSession
public javax.net.ssl.SSLSession getSSLSession()
Deprecated.Description copied from interface:ManagedClientConnectionObtains the SSL session of the underlying connection, if any. If this connection is open, and the underlying socket is anSSLSocket, the SSL session of that socket is obtained. This is a potentially blocking operation.Note: Whether the underlying socket is an SSL socket can not necessarily be determined via
ManagedClientConnection.isSecure(). Plain sockets may be considered secure, for example if they are connected to a known host in the same network segment. On the other hand, SSL sockets may be considered insecure, for example depending on the chosen cipher suite.- Specified by:
getSSLSessionin interfaceHttpRoutedConnection- Specified by:
getSSLSessionin interfaceManagedClientConnection- Specified by:
getSSLSessionin interfaceManagedHttpClientConnection- Returns:
- the underlying SSL session if available,
nullotherwise
-
markReusable
public void markReusable()
Deprecated.Description copied from interface:ManagedClientConnectionMarks this connection as being in a reusable communication state. The checkpoints for reuseable communication states (in the absence of pipelining) are before sending a request and after receiving the response in its entirety. The connection will automatically clear the checkpoint when used for communication. A call to this method indicates that the next checkpoint has been reached.A reusable communication state is necessary but not sufficient for the connection to be reused. A
routemismatch, the connection being closed, or other circumstances might prevent reuse.- Specified by:
markReusablein interfaceManagedClientConnection
-
unmarkReusable
public void unmarkReusable()
Deprecated.Description copied from interface:ManagedClientConnectionMarks this connection as not being in a reusable state. This can be used immediately before releasing this connection to prevent its reuse. Reasons for preventing reuse include error conditions and the evaluation of areuse strategy.Note: It is not necessary to call here before writing to or reading from this connection. Communication attempts will automatically unmark the state as non-reusable. It can then be switched back using
markReusable.- Specified by:
unmarkReusablein interfaceManagedClientConnection
-
isMarkedReusable
public boolean isMarkedReusable()
Deprecated.Description copied from interface:ManagedClientConnectionIndicates whether this connection is in a reusable communication state. SeemarkReusableandunmarkReusablefor details.- Specified by:
isMarkedReusablein interfaceManagedClientConnection- Returns:
trueif this connection is marked as being in a reusable communication state,falseotherwise
-
setIdleDuration
public void setIdleDuration(long duration, java.util.concurrent.TimeUnit unit)Deprecated.Description copied from interface:ManagedClientConnectionSets the duration that this connection can remain idle before it is reused. The connection should not be used again if this time elapses. The idle duration must be reset after each request sent over this connection. The elapsed time starts counting when the connection is released, which is typically after the headers (and any response body, if present) is fully consumed.- Specified by:
setIdleDurationin interfaceManagedClientConnection
-
releaseConnection
public void releaseConnection()
Deprecated.Description copied from interface:ConnectionReleaseTriggerReleases the connection with the option of keep-alive. This is a "graceful" release and may cause IO operations for consuming the remainder of a response entity. UseabortConnectionfor a hard release. The connection may be reused as specified by the duration.- Specified by:
releaseConnectionin interfaceConnectionReleaseTrigger
-
abortConnection
public void abortConnection()
Deprecated.Description copied from interface:ConnectionReleaseTriggerReleases the connection without the option of keep-alive. This is a "hard" release that implies a shutdown of the connection. UseConnectionReleaseTrigger.releaseConnection()for a graceful release.- Specified by:
abortConnectionin interfaceConnectionReleaseTrigger
-
getAttribute
public java.lang.Object getAttribute(java.lang.String id)
Deprecated.- Specified by:
getAttributein interfaceorg.apache.http.protocol.HttpContext
-
removeAttribute
public java.lang.Object removeAttribute(java.lang.String id)
Deprecated.- Specified by:
removeAttributein interfaceorg.apache.http.protocol.HttpContext
-
setAttribute
public void setAttribute(java.lang.String id, java.lang.Object obj)Deprecated.- Specified by:
setAttributein interfaceorg.apache.http.protocol.HttpContext
-
-