org.apache.river.jeri.internal.http

Class HttpClientConnection

java.lang.Object

org.apache.river.jeri.internal.http.HttpClientConnection

All Implemented Interfaces:

TimedConnection

public class HttpClientConnection
extends Object
implements TimedConnection

Class representing a client-side HTTP connection used to send HTTP requests.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
HttpClientConnection(String host, int port, HttpClientSocketFactory factory, HttpClientManager manager) Creates HttpClientConnection which sends requests directly to given host/port through a socket obtained from the given socket factory.
HttpClientConnection(String targetHost, int targetPort, String proxyHost, int proxyPort, boolean tunnel, boolean persist, HttpClientSocketFactory factory, HttpClientManager manager) Creates HttpClientConnection which sends requests to given target host/port through the indicated HTTP proxy over a socket provided by the specified socket factory.

Method Summary

Modifier and Type	Method and Description
Socket	getSocket() Returns socket over which requests are sent.
protected void	idle() Upcall indicating that connection has become idle.
OutboundRequest	newRequest() Initiates new request to connection target.
boolean	ping() Pings target.
boolean	shutdown(boolean force) Attempts to shut down connection, returning true if connection is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientConnection

public HttpClientConnection(String host,
                            int port,
                            HttpClientSocketFactory factory,
                            HttpClientManager manager)
                     throws IOException

Creates HttpClientConnection which sends requests directly to given host/port through a socket obtained from the given socket factory. The createSocket method of the given socket factory may be called more than once in cases where connection establishment involves multiple HTTP message exchanges.

Throws:

IOException

HttpClientConnection

public HttpClientConnection(String targetHost,
                            int targetPort,
                            String proxyHost,
                            int proxyPort,
                            boolean tunnel,
                            boolean persist,
                            HttpClientSocketFactory factory,
                            HttpClientManager manager)
                     throws IOException

Creates HttpClientConnection which sends requests to given target host/port through the indicated HTTP proxy over a socket provided by the specified socket factory. If tunnel is true, requests are tunneled through the proxy over an additional layered socket (also provided by the socket factory). If persist and tunnel are both false, the connection can only be used for a single request. If persist is true and tunnel is false, a persistent connection is maintained if possible. The createSocket and createTunnelSocket methods of the given socket factory may be called more than once in cases where connection establishment involves multiple HTTP message exchanges.

Throws:

IOException

Method Detail

ping

public boolean ping()
             throws IOException

Pings target. Returns true if ping succeeded, false if it fails "cleanly" (i.e., if a valid HTTP response indicating request failure is received).

Throws:

IOException

newRequest

public OutboundRequest newRequest()
                           throws IOException

Initiates new request to connection target. Throws an IOException if the connection is currently busy.

Throws:

IOException

idle

protected void idle()

Upcall indicating that connection has become idle. Subclasses may override this method to perform an appropriate action, such as scheduling an idle timeout.

getSocket

public Socket getSocket()

Returns socket over which requests are sent.

shutdown

public boolean shutdown(boolean force)

Attempts to shut down connection, returning true if connection is closed. If force is true, connection is always shut down; if force is false, connection is only shut down if idle.

Specified by:

shutdown in interface TimedConnection