org.apache.http.impl.conn

Class ManagedClientConnectionImpl

java.lang.Object

org.apache.http.impl.conn.ManagedClientConnectionImpl

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ConnectionReleaseTrigger, HttpRoutedConnection, ManagedClientConnection, ManagedHttpClientConnection, HttpClientConnection, HttpConnection, HttpInetConnection

Deprecated.

(4.3) use ManagedHttpClientConnectionFactory.

@Deprecated
@NotThreadSafe
 class ManagedClientConnectionImpl
extends java.lang.Object
implements ManagedClientConnection

Since:

4.2

Constructor Summary

Constructors

Constructor and Description
ManagedClientConnectionImpl(ClientConnectionManager manager, ClientConnectionOperator operator, HttpPoolEntry entry) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortConnection() Deprecated. Releases the connection without the option of keep-alive.
void	bind(java.net.Socket socket) Deprecated. Binds this connection to the given socket.
void	close() Deprecated. Closes this connection gracefully.
(package private) HttpPoolEntry	detach() Deprecated.
void	flush() Deprecated. Writes out all pending buffered data over the open connection.
java.lang.Object	getAttribute(java.lang.String id) Deprecated.
java.lang.String	getId() Deprecated. Returns connection ID which is expected to be unique for the life span of the connection manager.
java.net.InetAddress	getLocalAddress() Deprecated.
int	getLocalPort() Deprecated.
ClientConnectionManager	getManager() Deprecated.
HttpConnectionMetrics	getMetrics() Deprecated. Returns a collection of connection metrics.
(package private) HttpPoolEntry	getPoolEntry() Deprecated.
java.net.InetAddress	getRemoteAddress() Deprecated.
int	getRemotePort() Deprecated.
HttpRoute	getRoute() Deprecated. Obtains the current route of this connection.
java.net.Socket	getSocket() Deprecated. Returns the underlying socket.
int	getSocketTimeout() Deprecated. Returns the socket timeout value.
javax.net.ssl.SSLSession	getSSLSession() Deprecated. Obtains the SSL session of the underlying connection, if any.
java.lang.Object	getState() Deprecated. Returns the state object associated with this connection.
boolean	isMarkedReusable() Deprecated. Indicates whether this connection is in a reusable communication state.
boolean	isOpen() Deprecated. Checks if this connection is open.
boolean	isResponseAvailable(int timeout) Deprecated. Checks if response data is available from the connection.
boolean	isSecure() Deprecated. Indicates whether this connection is secure.
boolean	isStale() Deprecated. Checks whether this connection has gone down.
void	layerProtocol(HttpContext context, HttpParams params) Deprecated. Layers a new protocol on top of a tunnelled connection.
void	markReusable() Deprecated. Marks this connection as being in a reusable communication state.
void	open(HttpRoute route, HttpContext context, HttpParams params) Deprecated. Opens this connection according to the given route.
void	receiveResponseEntity(HttpResponse response) Deprecated. Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
HttpResponse	receiveResponseHeader() Deprecated. Receives the request line and headers of the next response available from this connection.
void	releaseConnection() Deprecated. Releases the connection with the option of keep-alive.
java.lang.Object	removeAttribute(java.lang.String id) Deprecated.
void	sendRequestEntity(HttpEntityEnclosingRequest request) Deprecated. Sends the request entity over the connection.
void	sendRequestHeader(HttpRequest request) Deprecated. Sends the request line and all headers over the connection.
void	setAttribute(java.lang.String id, java.lang.Object obj) Deprecated.
void	setIdleDuration(long duration, java.util.concurrent.TimeUnit unit) Deprecated. Sets the duration that this connection can remain idle before it is reused.
void	setSocketTimeout(int timeout) Deprecated. Sets the socket timeout value.
void	setState(java.lang.Object state) Deprecated. Assigns a state object to this connection.
void	shutdown() Deprecated. Force-closes this connection.
void	tunnelProxy(HttpHost next, boolean secure, HttpParams params) Deprecated. Indicates that a tunnel to an intermediate proxy has been established.
void	tunnelTarget(boolean secure, HttpParams params) Deprecated. Indicates that a tunnel to the target has been established.
void	unmarkReusable() 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

Constructor Detail

ManagedClientConnectionImpl

ManagedClientConnectionImpl(ClientConnectionManager manager,
                           ClientConnectionOperator operator,
                           HttpPoolEntry entry)

Deprecated.

Method Detail

getId

public java.lang.String getId()

Deprecated.

Description copied from interface: ManagedHttpClientConnection

Returns connection ID which is expected to be unique for the life span of the connection manager.

Specified by:

getId in interface ManagedHttpClientConnection

getPoolEntry

HttpPoolEntry getPoolEntry()

Deprecated.

detach

HttpPoolEntry detach()

Deprecated.

getManager

public ClientConnectionManager getManager()

Deprecated.

close

public void close()
           throws java.io.IOException

Deprecated.

Description copied from interface: HttpConnection

Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface HttpConnection

Throws:

java.io.IOException

shutdown

public void shutdown()
              throws java.io.IOException

Deprecated.

Description copied from interface: HttpConnection

Force-closes this connection. This is the only method of a connection which may be called from a different thread to terminate the connection. This method will not attempt to flush the transmitter's internal buffer prior to closing the underlying socket.

Specified by:

shutdown in interface HttpConnection

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Deprecated.

Description copied from interface: HttpConnection

Checks if this connection is open.

Specified by:

isOpen in interface HttpConnection

Returns:

true if it is open, false if it is closed.

isStale

public boolean isStale()

Deprecated.

Description copied from interface: HttpConnection

Checks whether this connection has gone down. Network connections may get closed during some time of inactivity for several reasons. The next time a read is attempted on such a connection it will throw an IOException. This method tries to alleviate this inconvenience by trying to find out if a connection is still usable. Implementations may do that by attempting a read with a very small timeout. Thus this method may block for a small amount of time before returning a result. It is therefore an expensive operation.

Specified by:

isStale in interface HttpConnection

Returns:

true if attempts to use this connection are likely to succeed, or false if they are likely to fail and this connection should be closed

setSocketTimeout

public void setSocketTimeout(int timeout)

Deprecated.

Description copied from interface: HttpConnection

Sets the socket timeout value.

Specified by:

setSocketTimeout in interface HttpConnection

Parameters:

timeout - timeout value in milliseconds

getSocketTimeout

public int getSocketTimeout()

Deprecated.

Description copied from interface: HttpConnection

Returns the socket timeout value.

Specified by:

getSocketTimeout in interface HttpConnection

Returns:

positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.

getMetrics

public HttpConnectionMetrics getMetrics()

Deprecated.

Description copied from interface: HttpConnection

Returns a collection of connection metrics.

Specified by:

getMetrics in interface HttpConnection

Returns:

HttpConnectionMetrics

flush

public void flush()
           throws java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Writes out all pending buffered data over the open connection.

Specified by:

flush in interface HttpClientConnection

Throws:

java.io.IOException - in case of an I/O error

isResponseAvailable

public boolean isResponseAvailable(int timeout)
                            throws java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Checks if response data is available from the connection. May wait for the specified time until some data becomes available. Note that some implementations may completely ignore the timeout parameter.

Specified by:

isResponseAvailable in interface HttpClientConnection

Parameters:

timeout - the maximum time in milliseconds to wait for data

Returns:

true if data is available; false if there was no data available even after waiting for timeout milliseconds.

Throws:

java.io.IOException - if an error happens on the connection

receiveResponseEntity

public void receiveResponseEntity(HttpResponse response)
                           throws HttpException,
                                  java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.

Specified by:

receiveResponseEntity in interface HttpClientConnection

Parameters:

response - the response to attach the entity to

Throws:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

receiveResponseHeader

public HttpResponse receiveResponseHeader()
                                   throws HttpException,
                                          java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Receives the request line and headers of the next response available from this connection. The caller should examine the HttpResponse object to find out if it should try to receive a response entity as well.

Specified by:

receiveResponseHeader in interface HttpClientConnection

Returns:

a new HttpResponse object with status line and headers initialized.

Throws:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

sendRequestEntity

public void sendRequestEntity(HttpEntityEnclosingRequest request)
                       throws HttpException,
                              java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Sends the request entity over the connection.

Specified by:

sendRequestEntity in interface HttpClientConnection

Parameters:

request - the request whose entity to send.

Throws:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

sendRequestHeader

public void sendRequestHeader(HttpRequest request)
                       throws HttpException,
                              java.io.IOException

Deprecated.

Description copied from interface: HttpClientConnection

Sends the request line and all headers over the connection.

Specified by:

sendRequestHeader in interface HttpClientConnection

Parameters:

request - the request whose headers to send.

Throws:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

getLocalAddress

public java.net.InetAddress getLocalAddress()

Deprecated.

Specified by:

getLocalAddress in interface HttpInetConnection

getLocalPort

public int getLocalPort()

Deprecated.

Specified by:

getLocalPort in interface HttpInetConnection

getRemoteAddress

public java.net.InetAddress getRemoteAddress()

Deprecated.

Specified by:

getRemoteAddress in interface HttpInetConnection

getRemotePort

public int getRemotePort()

Deprecated.

Specified by:

getRemotePort in interface HttpInetConnection

isSecure

public boolean isSecure()

Deprecated.

Description copied from interface: ManagedClientConnection

Indicates 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:

isSecure in interface HttpRoutedConnection

Specified by:

isSecure in interface ManagedClientConnection

Returns:

true if this connection is secure, false otherwise

bind

public void bind(java.net.Socket socket)
          throws java.io.IOException

Deprecated.

Description copied from interface: ManagedHttpClientConnection

Binds 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:

bind in interface ManagedHttpClientConnection

Parameters:

socket - the socket to bind the connection to.

Throws:

java.io.IOException

getSocket

public java.net.Socket getSocket()

Deprecated.

Description copied from interface: ManagedHttpClientConnection

Returns the underlying socket.

Specified by:

getSocket in interface ManagedHttpClientConnection

getSSLSession

public javax.net.ssl.SSLSession getSSLSession()

Deprecated.

Description copied from interface: ManagedClientConnection

Obtains the SSL session of the underlying connection, if any. If this connection is open, and the underlying socket is an SSLSocket, 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:

getSSLSession in interface HttpRoutedConnection

Specified by:

getSSLSession in interface ManagedClientConnection

Specified by:

getSSLSession in interface ManagedHttpClientConnection

Returns:

the underlying SSL session if available, null otherwise

getAttribute

public java.lang.Object getAttribute(java.lang.String id)

Deprecated.

removeAttribute

public java.lang.Object removeAttribute(java.lang.String id)

Deprecated.

setAttribute

public void setAttribute(java.lang.String id,
                java.lang.Object obj)

Deprecated.

getRoute

public HttpRoute getRoute()

Deprecated.

Description copied from interface: ManagedClientConnection

Obtains the current route of this connection.

Specified by:

getRoute in interface HttpRoutedConnection

Specified by:

getRoute in interface ManagedClientConnection

Returns:

the route established so far, or null if not connected

open

public void open(HttpRoute route,
        HttpContext context,
        HttpParams params)
          throws java.io.IOException

Deprecated.

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,
                HttpParams params)
                  throws java.io.IOException

Deprecated.

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(HttpHost next,
               boolean secure,
               HttpParams params)
                 throws java.io.IOException

Deprecated.

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(HttpContext context,
                 HttpParams params)
                   throws java.io.IOException

Deprecated.

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

getState

public java.lang.Object getState()

Deprecated.

Description copied from interface: ManagedClientConnection

Returns the state object associated with this connection.

Specified by:

getState in interface ManagedClientConnection

Returns:

The state object

setState

public void setState(java.lang.Object state)

Deprecated.

Description copied from interface: ManagedClientConnection

Assigns a state object to this connection. Connection managers may make use of the connection state when allocating persistent connections.

Specified by:

setState in interface ManagedClientConnection

Parameters:

state - The state object

markReusable

public void markReusable()

Deprecated.

Description copied from interface: ManagedClientConnection

Marks 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 route mismatch, the connection being closed, or other circumstances might prevent reuse.

Specified by:

markReusable in interface ManagedClientConnection

unmarkReusable

public void unmarkReusable()

Deprecated.

Description copied from interface: ManagedClientConnection

Marks 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 a reuse 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:

unmarkReusable in interface ManagedClientConnection

isMarkedReusable

public boolean isMarkedReusable()

Deprecated.

Description copied from interface: ManagedClientConnection

Indicates whether this connection is in a reusable communication state. See markReusable and unmarkReusable for details.

Specified by:

isMarkedReusable in interface ManagedClientConnection

Returns:

true if this connection is marked as being in a reusable communication state, false otherwise

setIdleDuration

public void setIdleDuration(long duration,
                   java.util.concurrent.TimeUnit unit)

Deprecated.

Description copied from interface: ManagedClientConnection

Sets 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:

setIdleDuration in interface ManagedClientConnection

releaseConnection

public void releaseConnection()

Deprecated.

Description copied from interface: ConnectionReleaseTrigger

Releases 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. Use abortConnection for a hard release. The connection may be reused as specified by the duration.

Specified by:

releaseConnection in interface ConnectionReleaseTrigger

abortConnection

public void abortConnection()

Deprecated.

Description copied from interface: ConnectionReleaseTrigger

Releases the connection without the option of keep-alive. This is a "hard" release that implies a shutdown of the connection. Use ConnectionReleaseTrigger.releaseConnection() for a graceful release.

Specified by:

abortConnection in interface ConnectionReleaseTrigger