Package org.apache.http.impl.conn

Class DefaultManagedHttpClientConnection

java.lang.Object

org.apache.http.impl.BHttpConnectionBase

org.apache.http.impl.DefaultBHttpClientConnection

org.apache.http.impl.conn.DefaultManagedHttpClientConnection

All Implemented Interfaces:

Closeable, AutoCloseable, ManagedHttpClientConnection, HttpClientConnection, HttpConnection, HttpInetConnection, HttpContext

public class DefaultManagedHttpClientConnection
extends DefaultBHttpClientConnection
implements ManagedHttpClientConnection, HttpContext

Default ManagedHttpClientConnection implementation.

Since:

4.3

Field Summary

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

RESERVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultManagedHttpClientConnection(String id, int bufferSize)
DefaultManagedHttpClientConnection(String id, int bufferSize, int fragmentSizeHint, CharsetDecoder charDecoder, CharsetEncoder charEncoder, MessageConstraints constraints, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy, HttpMessageWriterFactory<HttpRequest> requestWriterFactory, HttpMessageParserFactory<HttpResponse> responseParserFactory)

Method Summary

Modifier and Type	Method	Description
void	bind(Socket socket)	Binds this connection to the given socket.
Object	getAttribute(String id)	Obtains attribute with the given name.
String	getId()	Returns connection ID which is expected to be unique for the life span of the connection manager.
Socket	getSocket()	Returns the underlying socket.
SSLSession	getSSLSession()	Obtains the SSL session of the underlying connection, if any.
Object	removeAttribute(String id)	Removes attribute with the given name from the context.
void	setAttribute(String id, Object obj)	Sets value of the attribute with the given name.
void	shutdown()	Force-closes this connection.

Methods inherited from class org.apache.http.impl.DefaultBHttpClientConnection

flush, isResponseAvailable, receiveResponseEntity, receiveResponseHeader, sendRequestEntity, sendRequestHeader

Methods inherited from class org.apache.http.impl.BHttpConnectionBase

close, getLocalAddress, getLocalPort, getMetrics, getRemoteAddress, getRemotePort, getSocketTimeout, isOpen, isStale, setSocketTimeout, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.http.HttpClientConnection

flush, isResponseAvailable, receiveResponseEntity, receiveResponseHeader, sendRequestEntity, sendRequestHeader

Methods inherited from interface org.apache.http.HttpConnection

close, getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout

Methods inherited from interface org.apache.http.HttpInetConnection

getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort

Constructor Detail

DefaultManagedHttpClientConnection

public DefaultManagedHttpClientConnection(String id,
                                          int bufferSize,
                                          int fragmentSizeHint,
                                          CharsetDecoder charDecoder,
                                          CharsetEncoder charEncoder,
                                          MessageConstraints constraints,
                                          ContentLengthStrategy incomingContentStrategy,
                                          ContentLengthStrategy outgoingContentStrategy,
                                          HttpMessageWriterFactory<HttpRequest> requestWriterFactory,
                                          HttpMessageParserFactory<HttpResponse> responseParserFactory)

DefaultManagedHttpClientConnection

public DefaultManagedHttpClientConnection(String id,
                                          int bufferSize)

Method Detail

getId

public 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

shutdown

public void shutdown()
              throws 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

Overrides:

shutdown in class BHttpConnectionBase

Throws:

IOException

getAttribute

public Object getAttribute(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.

removeAttribute

public Object removeAttribute(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.

setAttribute

public void setAttribute(String id,
                         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.

bind

public void bind(Socket socket)
          throws 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

Overrides:

bind in class DefaultBHttpClientConnection

Parameters:

socket - the socket to bind the connection to.

Throws:

IOException

getSocket

public Socket getSocket()

Description copied from interface: ManagedHttpClientConnection

Returns the underlying socket.

Specified by:

getSocket in interface ManagedHttpClientConnection

getSSLSession

public 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