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

OperatedClientConnection, HttpClientConnection, HttpConnection, HttpInetConnection

public class DefaultClientConnection
extends SocketHttpClientConnection
implements OperatedClientConnection

Default implementation of an operated client connection.

Since:

4.0

Version:

$Revision: 673450 $ $Date: 2008-07-02 10:35:05 -0700 (Wed, 02 Jul 2008) $

Author:

Roland Weber

Constructor Summary

Constructors

Constructor	Description
DefaultClientConnection()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this connection gracefully.
protected HttpMessageParser	createResponseParser(SessionInputBuffer buffer, HttpResponseFactory responseFactory, HttpParams params)
protected SessionInputBuffer	createSessionInputBuffer(Socket socket, int buffersize, HttpParams params)
protected SessionOutputBuffer	createSessionOutputBuffer(Socket socket, int buffersize, HttpParams params)
Socket	getSocket()	Obtains the socket for this connection.
HttpHost	getTargetHost()	Obtains the target host for this connection.
boolean	isSecure()	Indicates whether this connection is secure.
void	openCompleted(boolean secure, HttpParams params)	Signals that the connection has been successfully open.
void	opening(Socket sock, HttpHost target)	Signals that this connection is in the process of being open.
HttpResponse	receiveResponseHeader()	Receives the request line and headers of the next response available from this connection.
void	sendRequestHeader(HttpRequest request)	Sends the request line and all headers over the connection.
void	shutdown()	Force-closes this connection.
void	update(Socket sock, HttpHost target, boolean secure, HttpParams params)	Updates this connection.

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

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

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

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

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.HttpClientConnection

flush, isResponseAvailable, receiveResponseEntity, sendRequestEntity

Methods inherited from interface org.apache.http.HttpConnection

getMetrics, getSocketTimeout, isOpen, isStale, setSocketTimeout

Methods inherited from interface org.apache.http.HttpInetConnection

getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort

Constructor Details

DefaultClientConnection

public DefaultClientConnection()

Method Details

getTargetHost

public final HttpHost getTargetHost()

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

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

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 OperatedClientConnection

Overrides:

getSocket in class SocketHttpClientConnection

Returns:

the socket for communicating with the target host

opening

public void opening(Socket sock,
HttpHost target)
             throws IOException

Description copied from interface: OperatedClientConnection

Signals that this connection is in the process of being open.
By calling this method, you can provide the connection with the unconnected socket that will be connected before OperatedClientConnection.openCompleted(boolean, org.apache.http.params.HttpParams) is called. This allows the connection to close that socket if shutdown is called before it is open. Closing the 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.
You also must call 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:

IOException

openCompleted

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

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:

IOException

shutdown

public void shutdown()
              throws IOException

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:

IOException - in case of a problem

close

public void close()
           throws IOException

Description copied from interface: HttpConnection

Closes this connection gracefully. This method will attempt to flush the transmitter's internal 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 HttpConnection

Overrides:

close in class SocketHttpClientConnection

Throws:

IOException

createSessionInputBuffer

protected SessionInputBuffer createSessionInputBuffer(Socket socket,
int buffersize,
HttpParams params)
                                               throws IOException

Overrides:

createSessionInputBuffer in class SocketHttpClientConnection

Throws:

IOException

createSessionOutputBuffer

protected SessionOutputBuffer createSessionOutputBuffer(Socket socket,
int buffersize,
HttpParams params)
                                                 throws IOException

Overrides:

createSessionOutputBuffer in class SocketHttpClientConnection

Throws:

IOException

createResponseParser

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

Overrides:

createResponseParser in class AbstractHttpClientConnection

update

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

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:

IOException

receiveResponseHeader

public HttpResponse receiveResponseHeader()
                                   throws HttpException,
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

Overrides:

receiveResponseHeader in class AbstractHttpClientConnection

Returns:

a new HttpResponse object with status line and headers initialized.

Throws:

HttpException

IOException

sendRequestHeader

public void sendRequestHeader(HttpRequest request)
                       throws HttpException,
IOException

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

IOException