Android - An Open Handset Alliance Project

org.apache.http.impl.conn
public abstract class

org.apache.http.impl.conn.AbstractClientConnAdapter

java.lang.Object
	org.apache.http.impl.conn.AbstractClientConnAdapter	ManagedClientConnection

Abstract adapter from operated to managed client connections. Read and write methods are delegated to the wrapped connection. Operations affecting the connection state have to be implemented by derived classes. Operations for querying the connection state are delegated to the wrapped connection if there is one, or return a default value if there is none.
This adapter tracks the checkpoints for reusable communication states, as indicated by markReusable and queried by isMarkedReusable. All send and receive operations will automatically clear the mark.
Connection release calls are delegated to the connection manager, if there is one. abortConnection will clear the reusability mark first. The connection manager is expected to tolerate multiple calls to the release method.

Known Direct Subclasses

AbstractPooledConnAdapter

Known Indirect Subclasses

BasicPooledConnAdapter, SingleClientConnManager.ConnAdapter

Summary

Fields

protected	ClientConnectionManager	connManager	The connection manager, if any.
protected	boolean	markedReusable	The reusability marker.
protected	OperatedClientConnection	wrappedConnection	The wrapped connection.

Protected Constructors

					AbstractClientConnAdapter(ClientConnectionManager mgr, OperatedClientConnection conn)
					Creates a new connection adapter.

Public Methods

				void	abortConnection()
					Releases the connection without the option of keep-alive.
				void	flush()
					Writes out all pending buffered data over the open connection.
				InetAddress	getLocalAddress()
				int	getLocalPort()
				HttpConnectionMetrics	getMetrics()
					Returns a collection of connection metrcis
				InetAddress	getRemoteAddress()
				int	getRemotePort()
				SSLSession	getSSLSession()
					Obtains the SSL session of the underlying connection, if any.
				int	getSocketTimeout()
					Returns the socket timeout value.
				boolean	isMarkedReusable()
					Indicates whether this connection is in a reusable communication state.
				boolean	isOpen()
					Checks if this connection is open.
				boolean	isResponseAvailable(int timeout)
					Checks if response data is available from the connection.
				boolean	isSecure()
					Indicates whether this connection is secure.
				boolean	isStale()
					Checks whether this connection has gone down.
				void	markReusable()
					Marks this connection as being in a reusable communication state.
				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.
				void	releaseConnection()
					Releases the connection with the option of keep-alive.
				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	setSocketTimeout(int timeout)
					Sets the socket timeout value.
				void	unmarkReusable()
					Marks this connection as not being in a reusable state.

Protected Methods

		final		void	assertWrappedConn()
					Asserts that there is a wrapped connection to delegate to.

Methods inherited from class java.lang.Object

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

				HttpRoute	getRoute()
					Obtains the current route of this connection.
				SSLSession	getSSLSession()
					Obtains the SSL session of the underlying connection, if any.
				boolean	isMarkedReusable()
					Indicates whether this connection is in a reusable communication state.
				boolean	isSecure()
					Indicates whether this connection is secure.
				void	layerProtocol(HttpContext context, HttpParams params)
					Layers a new protocol on top of a tunnelled connection.
				void	markReusable()
					Marks this connection as being in a reusable communication state.
				void	open(HttpRoute route, HttpContext context, HttpParams params)
					Opens this connection according to the given route.
				void	tunnelProxy(HttpHost next, boolean secure, HttpParams params)
					Indicates that a tunnel to an intermediate proxy has been established.
				void	tunnelTarget(boolean secure, HttpParams params)
					Indicates that a tunnel to the target has been established.
				void	unmarkReusable()
					Marks this connection as not being in a reusable state.

Details

Fields

protected ClientConnectionManager connManager

The connection manager, if any. This attribute MUST NOT be final, so the adapter can be detached from the connection manager without keeping a hard reference there.

protected boolean markedReusable

The reusability marker.

protected OperatedClientConnection wrappedConnection

The wrapped connection.

Protected Constructors

protected AbstractClientConnAdapter(ClientConnectionManager mgr, OperatedClientConnection conn)

Creates a new connection adapter. The adapter is initially not marked as reusable.

Parameters

mgr	the connection manager, or `null`
conn	the connection to wrap, or `null`

Public Methods

public void abortConnection()

Releases the connection without the option of keep-alive. This is a "hard" release that implies a shutdown of the connection. Use releaseConnection for a graceful release.

public void flush()

Writes out all pending buffered data over the open connection.

Throws

IOException

public InetAddress getLocalAddress()

public int getLocalPort()

public HttpConnectionMetrics getMetrics()

Returns a collection of connection metrcis

public InetAddress getRemoteAddress()

public int getRemotePort()

public SSLSession getSSLSession()

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.
Note: Whether the underlying socket is an SSL socket can not necessarily be determined via isSecure(). Plain sockets may be considered secure, for example if they are connected to a known host in the same network segment. On the other hand, SSL sockets may be considered insecure, for example depending on the chosen cipher suite.

public int getSocketTimeout()

Returns the socket timeout value.

public boolean isMarkedReusable()

Indicates whether this connection is in a reusable communication state. See markReusable and unmarkReusable for details.

public boolean isOpen()

Checks if this connection is open.

public boolean isResponseAvailable(int timeout)

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.

Throws

IOException

public boolean isSecure()

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.

public boolean isStale()

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.

public void markReusable()

Marks this connection as being in a reusable communication state. The checkpoints for reuseable communication states (in the absence of pipelining) are before sending a request and after receiving the response in it's entirety. The connection will automatically clear the checkpoint when used for communication. A call to this method indicates that the next checkpoint has been reached.
A reusable communication state is necessary but not sufficient for the connection to be reused. A route mismatch, the connection being closed, or other circumstances might prevent reuse.

public void receiveResponseEntity(HttpResponse response)

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.

Throws

HttpException
IOException

public HttpResponse receiveResponseHeader()

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.

Throws

HttpException
IOException

public void releaseConnection()

Releases the connection with the option of keep-alive. This is a "graceful" release and may cause IO operations for consuming the remainder of a response entity. Use abortConnection for a hard release.

public void sendRequestEntity(HttpEntityEnclosingRequest request)

Sends the request entity over the connection.

Throws

HttpException
IOException

public void sendRequestHeader(HttpRequest request)

Sends the request line and all headers over the connection.

Throws

HttpException
IOException

public void setSocketTimeout(int timeout)

Sets the socket timeout value.

public void unmarkReusable()

Marks this connection as not being in a reusable state. This can be used immediately before releasing this connection to prevent it's reuse. Reasons for preventing reuse include error conditions and the evaluation of a reuse strategy.
Note: It is not necessary to call here before writing to or reading from this connection. Communication attempts will automatically unmark the state as non-reusable. It can then be switched back using markReusable.

Protected Methods

protected final void assertWrappedConn()

Asserts that there is a wrapped connection to delegate to.

Throws

IllegalStateException	if there is no wrapped connection

BasicPooledConnAdapter	A connection wrapper and callback handler.
SingleClientConnManager.ConnAdapter	The connection adapter used by this manager.

				void	close()
					Closes this connection gracefully.
				HttpConnectionMetrics	getMetrics()
					Returns a collection of connection metrcis
				int	getSocketTimeout()
					Returns the socket timeout value.
				boolean	isOpen()
					Checks if this connection is open.
				boolean	isStale()
					Checks whether this connection has gone down.
				void	setSocketTimeout(int timeout)
					Sets the socket timeout value.
				void	shutdown()
					Force-closes this connection.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

org.apache.http.impl.conn.AbstractClientConnAdapter

Known Direct Subclasses

Known Indirect Subclasses

Summary

Fields

Protected Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.http.HttpConnection

Methods inherited from interface org.apache.http.conn.ConnectionReleaseTrigger

Methods inherited from interface org.apache.http.HttpClientConnection

Methods inherited from interface org.apache.http.HttpInetConnection

Methods inherited from interface org.apache.http.conn.ManagedClientConnection

Details

Fields

protected ClientConnectionManager connManager

protected boolean markedReusable

protected OperatedClientConnection wrappedConnection

Protected Constructors

protected AbstractClientConnAdapter(ClientConnectionManager mgr, OperatedClientConnection conn)

Parameters

Public Methods

public void abortConnection()

public void flush()

Throws

public InetAddress getLocalAddress()

public int getLocalPort()

public HttpConnectionMetrics getMetrics()

public InetAddress getRemoteAddress()

public int getRemotePort()

public SSLSession getSSLSession()

public int getSocketTimeout()

public boolean isMarkedReusable()

public boolean isOpen()

public boolean isResponseAvailable(int timeout)

Throws

public boolean isSecure()

public boolean isStale()

public void markReusable()

public void receiveResponseEntity(HttpResponse response)

Throws

public HttpResponse receiveResponseHeader()

Throws

public void releaseConnection()

public void sendRequestEntity(HttpEntityEnclosingRequest request)

Throws

public void sendRequestHeader(HttpRequest request)

Throws

public void setSocketTimeout(int timeout)

public void unmarkReusable()

Protected Methods

protected final void assertWrappedConn()

Throws