org.apache.http.impl.conn

Class CPoolProxy

java.lang.Object

org.apache.http.impl.conn.CPoolProxy

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ManagedHttpClientConnection, HttpClientConnection, HttpConnection, HttpInetConnection, HttpContext

@NotThreadSafe
 class CPoolProxy
extends java.lang.Object
implements ManagedHttpClientConnection, HttpContext

Since:

4.3

Field Summary

Fields inherited from interface org.apache.http.protocol.HttpContext

RESERVED_PREFIX

Constructor Summary

Constructors

Constructor and Description
CPoolProxy(CPoolEntry entry)

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(java.net.Socket socket) Binds this connection to the given socket.
void	close() Closes this connection gracefully.
(package private) CPoolEntry	detach()
static CPoolEntry	detach(HttpClientConnection conn)
void	flush() Writes out all pending buffered data over the open connection.
java.lang.Object	getAttribute(java.lang.String id) Obtains attribute with the given name.
(package private) ManagedHttpClientConnection	getConnection()
java.lang.String	getId() Returns connection ID which is expected to be unique for the life span of the connection manager.
java.net.InetAddress	getLocalAddress()
int	getLocalPort()
HttpConnectionMetrics	getMetrics() Returns a collection of connection metrics.
(package private) CPoolEntry	getPoolEntry()
static CPoolEntry	getPoolEntry(HttpClientConnection proxy)
java.net.InetAddress	getRemoteAddress()
int	getRemotePort()
java.net.Socket	getSocket() Returns the underlying socket.
int	getSocketTimeout() Returns the socket timeout value.
javax.net.ssl.SSLSession	getSSLSession() Obtains the SSL session of the underlying connection, if any.
(package private) ManagedHttpClientConnection	getValidConnection()
boolean	isOpen() Checks if this connection is open.
boolean	isResponseAvailable(int timeout) Checks if response data is available from the connection.
boolean	isStale() Checks whether this connection has gone down.
static HttpClientConnection	newProxy(CPoolEntry poolEntry)
void	receiveResponseEntity(HttpResponse response) Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
HttpResponse	receiveResponseHeader() Receives the request line and headers of the next response available from this connection.
java.lang.Object	removeAttribute(java.lang.String id) Removes attribute with the given name from the context.
void	sendRequestEntity(HttpEntityEnclosingRequest request) Sends the request entity over the connection.
void	sendRequestHeader(HttpRequest request) Sends the request line and all headers over the connection.
void	setAttribute(java.lang.String id, java.lang.Object obj) Sets value of the attribute with the given name.
void	setSocketTimeout(int timeout) Sets the socket timeout value.
void	shutdown() Force-closes this connection.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CPoolProxy

CPoolProxy(CPoolEntry entry)

Method Detail

getPoolEntry

CPoolEntry getPoolEntry()

detach

CPoolEntry detach()

getConnection

ManagedHttpClientConnection getConnection()

getValidConnection

ManagedHttpClientConnection getValidConnection()

close

public void close()
           throws java.io.IOException

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

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()

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()

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)

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()

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.

getId

public java.lang.String getId()

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

bind

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

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()

Description copied from interface: ManagedHttpClientConnection

Returns the underlying socket.

Specified by:

getSocket in interface ManagedHttpClientConnection

getSSLSession

public javax.net.ssl.SSLSession getSSLSession()

Description copied from interface: ManagedHttpClientConnection

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.

Specified by:

getSSLSession in interface ManagedHttpClientConnection

Returns:

the underlying SSL session if available, null otherwise

isResponseAvailable

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

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

sendRequestHeader

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

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

sendRequestEntity

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

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

receiveResponseHeader

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

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

receiveResponseEntity

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

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

flush

public void flush()
           throws java.io.IOException

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

getMetrics

public HttpConnectionMetrics getMetrics()

Description copied from interface: HttpConnection

Returns a collection of connection metrics.

Specified by:

getMetrics in interface HttpConnection

Returns:

HttpConnectionMetrics

getLocalAddress

public java.net.InetAddress getLocalAddress()

Specified by:

getLocalAddress in interface HttpInetConnection

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface HttpInetConnection

getRemoteAddress

public java.net.InetAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface HttpInetConnection

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface HttpInetConnection

getAttribute

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

Description copied from interface: HttpContext

Obtains attribute with the given name.

Specified by:

getAttribute in interface HttpContext

Parameters:

id - the attribute name.

Returns:

attribute value, or null if not set.

setAttribute

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

Description copied from interface: HttpContext

Sets value of the attribute with the given name.

Specified by:

setAttribute in interface HttpContext

Parameters:

id - the attribute name.

obj - the attribute value.

removeAttribute

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

Description copied from interface: HttpContext

Removes attribute with the given name from the context.

Specified by:

removeAttribute in interface HttpContext

Parameters:

id - the attribute name.

Returns:

attribute value, or null if not set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newProxy

public static HttpClientConnection newProxy(CPoolEntry poolEntry)

getPoolEntry

public static CPoolEntry getPoolEntry(HttpClientConnection proxy)

detach

public static CPoolEntry detach(HttpClientConnection conn)