org.apache.http.impl.conn

Class DefaultClientConnection

java.lang.Object

org.apache.http.impl.AbstractHttpClientConnection

org.apache.http.impl.SocketHttpClientConnection

org.apache.http.impl.conn.DefaultClientConnection

All Implemented Interfaces:

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

Deprecated.

(4.3) use ManagedHttpClientConnectionFactory.

@NotThreadSafe
@Deprecated
public class DefaultClientConnection
extends SocketHttpClientConnection
implements OperatedClientConnection, ManagedHttpClientConnection, HttpContext

Default implementation of an operated client connection.

Since:

4.0

Field Summary

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

RESERVED_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultClientConnection() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(java.net.Socket socket) Deprecated. Binds this connection to the given socket.
void	close() Deprecated. Closes this connection gracefully.
protected HttpMessageParser<HttpResponse>	createResponseParser(SessionInputBuffer buffer, HttpResponseFactory responseFactory, HttpParams params) Deprecated. Creates an instance of HttpMessageParser to be used for parsing HTTP responses received over this connection.
protected SessionInputBuffer	createSessionInputBuffer(java.net.Socket socket, int buffersize, HttpParams params) Deprecated. Creates an instance of SocketInputBuffer to be used for receiving data from the given Socket.
protected SessionOutputBuffer	createSessionOutputBuffer(java.net.Socket socket, int buffersize, HttpParams params) Deprecated. Creates an instance of SessionOutputBuffer to be used for sending data to the given Socket.
java.lang.Object	getAttribute(java.lang.String id) Deprecated. Obtains attribute with the given name.
java.lang.String	getId() Deprecated. Returns connection ID which is expected to be unique for the life span of the connection manager.
java.net.Socket	getSocket() Deprecated. Obtains the socket for this connection.
javax.net.ssl.SSLSession	getSSLSession() Deprecated. Obtains the SSL session of the underlying connection, if any.
HttpHost	getTargetHost() Deprecated. Obtains the target host for this connection.
boolean	isSecure() Deprecated. Indicates whether this connection is secure.
void	openCompleted(boolean secure, HttpParams params) Deprecated. Signals that the connection has been successfully open.
void	opening(java.net.Socket sock, HttpHost target) Deprecated. Signals that this connection is in the process of being open.
HttpResponse	receiveResponseHeader() Deprecated. Receives the request line and headers of the next response available from this connection.
java.lang.Object	removeAttribute(java.lang.String id) Deprecated. Removes attribute with the given name from the context.
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. Sets value of the attribute with the given name.
void	shutdown() Deprecated. Force-closes this connection.
void	update(java.net.Socket sock, HttpHost target, boolean secure, HttpParams params) Deprecated. Updates this connection.

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

assertNotOpen, assertOpen, bind, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSocketTimeout, isOpen, setSocketTimeout, toString

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

createConnectionMetrics, createEntityDeserializer, createEntitySerializer, createHttpResponseFactory, createRequestWriter, doFlush, flush, getMetrics, init, isEof, isResponseAvailable, isStale, receiveResponseEntity, sendRequestEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.HttpClientConnection

flush, isResponseAvailable, receiveResponseEntity, sendRequestEntity

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

Constructor Detail

DefaultClientConnection

public DefaultClientConnection()

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

getTargetHost

public final HttpHost getTargetHost()

Deprecated.

Description copied from interface: OperatedClientConnection

Obtains the target host for this connection. If the connection is to a proxy but not tunnelled, this is the proxy. If the connection is tunnelled through a proxy, this is the target of the tunnel.

The return value is well-defined only while the connection is open. It may change even while the connection is open, because of an update.

Specified by:

getTargetHost in interface OperatedClientConnection

Returns:

the host to which this connection is opened

isSecure

public final boolean isSecure()

Deprecated.

Description copied from interface: OperatedClientConnection

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, because of an update.

Specified by:

isSecure in interface OperatedClientConnection

Returns:

true if this connection is secure, false otherwise

getSocket

public final java.net.Socket getSocket()

Deprecated.

Description copied from interface: OperatedClientConnection

Obtains the socket for this connection. The return value is well-defined only while the connection is open. It may change even while the connection is open, because of an update.

Specified by:

getSocket in interface ManagedHttpClientConnection

Specified by:

getSocket in interface OperatedClientConnection

Overrides:

getSocket in class SocketHttpClientConnection

Returns:

the socket for communicating with the target host

getSSLSession

public javax.net.ssl.SSLSession getSSLSession()

Deprecated.

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

opening

public void opening(java.net.Socket sock,
           HttpHost target)
             throws java.io.IOException

Deprecated.

Description copied from interface: OperatedClientConnection

Signals that this connection is in the process of being open.

By calling this method, the connection can be re-initialized with a new Socket instance before OperatedClientConnection.openCompleted(boolean, org.apache.http.params.HttpParams) is called. This enabled the connection to close that socket if shutdown is called before it is fully open. Closing an unconnected socket will interrupt a thread that is blocked on the connect. Otherwise, that thread will either time out on the connect, or it returns successfully and then opens this connection which was just shut down.

This method can be called multiple times if the connection is layered over another protocol. Note: This method will not close the previously used socket. It is the caller's responsibility to close that socket if it is no longer required.

The caller must invoke OperatedClientConnection.openCompleted(boolean, org.apache.http.params.HttpParams) in order to complete the process.

Specified by:

opening in interface OperatedClientConnection

Parameters:

sock - the unconnected socket which is about to be connected.

target - the target host of this connection

Throws:

java.io.IOException

openCompleted

public void openCompleted(boolean secure,
                 HttpParams params)
                   throws java.io.IOException

Deprecated.

Description copied from interface: OperatedClientConnection

Signals that the connection has been successfully open. An attempt to call this method on an open connection will cause an exception.

Specified by:

openCompleted in interface OperatedClientConnection

Parameters:

secure - true if this connection is secure, for example if an SSLSocket is used, or false if it is not secure

params - parameters for this connection. The parameters will be used when creating dependent objects, for example to determine buffer sizes.

Throws:

java.io.IOException

shutdown

public void shutdown()
              throws java.io.IOException

Deprecated.

Force-closes this connection. If the connection is still in the process of being open (the method opening was already called but openCompleted was not), the associated socket that is being connected to a remote address will be closed. That will interrupt a thread that is blocked on connecting the socket. If the connection is not yet open, this will prevent the connection from being opened.

Specified by:

shutdown in interface HttpConnection

Overrides:

shutdown in class SocketHttpClientConnection

Throws:

java.io.IOException - in case of a problem

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

Overrides:

close in class SocketHttpClientConnection

Throws:

java.io.IOException

createSessionInputBuffer

protected SessionInputBuffer createSessionInputBuffer(java.net.Socket socket,
                                          int buffersize,
                                          HttpParams params)
                                               throws java.io.IOException

Deprecated.

Description copied from class: SocketHttpClientConnection

Creates an instance of SocketInputBuffer to be used for receiving data from the given Socket.

This method can be overridden in a super class in order to provide a custom implementation of SessionInputBuffer interface.

Overrides:

createSessionInputBuffer in class SocketHttpClientConnection

Parameters:

socket - the socket.

buffersize - the buffer size.

params - HTTP parameters.

Returns:

session input buffer.

Throws:

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

See Also:

SocketInputBuffer.SocketInputBuffer(Socket, int, HttpParams)

createSessionOutputBuffer

protected SessionOutputBuffer createSessionOutputBuffer(java.net.Socket socket,
                                            int buffersize,
                                            HttpParams params)
                                                 throws java.io.IOException

Deprecated.

Description copied from class: SocketHttpClientConnection

Creates an instance of SessionOutputBuffer to be used for sending data to the given Socket.

This method can be overridden in a super class in order to provide a custom implementation of SocketOutputBuffer interface.

Overrides:

createSessionOutputBuffer in class SocketHttpClientConnection

Parameters:

socket - the socket.

buffersize - the buffer size.

params - HTTP parameters.

Returns:

session output buffer.

Throws:

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

See Also:

SocketOutputBuffer.SocketOutputBuffer(Socket, int, HttpParams)

createResponseParser

protected HttpMessageParser<HttpResponse> createResponseParser(SessionInputBuffer buffer,
                                                   HttpResponseFactory responseFactory,
                                                   HttpParams params)

Deprecated.

Description copied from class: AbstractHttpClientConnection

Creates an instance of HttpMessageParser to be used for parsing HTTP responses received over this connection.

This method can be overridden in a super class in order to provide a different implementation of the HttpMessageParser interface or to pass a different implementation of the LineParser to the the DefaultHttpResponseParser constructor.

Overrides:

createResponseParser in class AbstractHttpClientConnection

Parameters:

buffer - the session input buffer.

responseFactory - the HTTP response factory.

params - HTTP parameters.

Returns:

HTTP message parser.

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

update

public void update(java.net.Socket sock,
          HttpHost target,
          boolean secure,
          HttpParams params)
            throws java.io.IOException

Deprecated.

Description copied from interface: OperatedClientConnection

Updates this connection. A connection can be updated only while it is open. Updates are used for example when a tunnel has been established, or when a TLS/SSL connection has been layered on top of a plain socket connection.

Note: Updating the connection will not close the previously used socket. It is the caller's responsibility to close that socket if it is no longer required.

Specified by:

update in interface OperatedClientConnection

Parameters:

sock - the new socket for communicating with the target host, or null to continue using the old socket. If null is passed, helper objects that depend on the socket should be re-used. In that case, some changes in the parameters will not take effect.

target - the new target host of this connection

secure - true if this connection is now secure, false if it is not secure

params - new parameters for this connection

Throws:

java.io.IOException

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

Overrides:

receiveResponseHeader in class AbstractHttpClientConnection

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

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

Overrides:

sendRequestHeader in class AbstractHttpClientConnection

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

getAttribute

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

Deprecated.

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 java.lang.Object removeAttribute(java.lang.String id)

Deprecated.

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(java.lang.String id,
                java.lang.Object obj)

Deprecated.

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.