Package org.apache.http.impl

Class SocketHttpClientConnection

java.lang.Object

org.apache.http.impl.AbstractHttpClientConnection

org.apache.http.impl.SocketHttpClientConnection

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultHttpClientConnection

@Deprecated
public class SocketHttpClientConnection
extends AbstractHttpClientConnection
implements HttpInetConnection

Deprecated.

(4.3) use DefaultBHttpClientConnection

Implementation of a client-side HTTP connection that can be bound to an arbitrary Socket for receiving data from and transmitting data to a remote server.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
SocketHttpClientConnection()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	assertNotOpen()	Deprecated.
protected void	assertOpen()	Deprecated. Asserts if the connection is open.
protected void	bind(java.net.Socket socket, HttpParams params)	Deprecated. Binds this connection to the given Socket.
void	close()	Deprecated. Closes this connection gracefully.
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.net.InetAddress	getLocalAddress()	Deprecated.
int	getLocalPort()	Deprecated.
java.net.InetAddress	getRemoteAddress()	Deprecated.
int	getRemotePort()	Deprecated.
protected java.net.Socket	getSocket()	Deprecated.
int	getSocketTimeout()	Deprecated. Returns the socket timeout value.
boolean	isOpen()	Deprecated. Checks if this connection is open.
void	setSocketTimeout(int timeout)	Deprecated. Sets the socket timeout value.
void	shutdown()	Deprecated. Force-closes this connection.
java.lang.String	toString()	Deprecated.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.HttpConnection

getMetrics, isStale

Constructor Detail

SocketHttpClientConnection

public SocketHttpClientConnection()

Deprecated.

Method Detail

assertNotOpen

protected void assertNotOpen()

Deprecated.

assertOpen

protected void assertOpen()

Deprecated.

Description copied from class: AbstractHttpClientConnection

Asserts if the connection is open.

Specified by:

assertOpen in class AbstractHttpClientConnection

createSessionInputBuffer

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

Deprecated.

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.

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(Socket, int, HttpParams)

createSessionOutputBuffer

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

Deprecated.

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.

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(Socket, int, HttpParams)

bind

protected void bind(java.net.Socket socket,
                    HttpParams params)
             throws java.io.IOException

Deprecated.

Binds this connection to the given Socket. This socket will be used by the connection to send and receive data.

This method will invoke createSessionInputBuffer(Socket, int, HttpParams) and createSessionOutputBuffer(Socket, int, HttpParams) methods to create session input / output buffers bound to this socket and then will invoke AbstractHttpClientConnection.init(SessionInputBuffer, SessionOutputBuffer, HttpParams) method to pass references to those buffers to the underlying HTTP message parser and formatter.

After this method's execution the connection status will be reported as open and the isOpen() will return true.

Parameters:

socket - the socket.

params - HTTP parameters.

Throws:

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

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.

getSocket

protected java.net.Socket getSocket()

Deprecated.

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

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.

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

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.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface HttpConnection

Throws:

java.io.IOException

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object