org.ws4d.java.communication.protocol.http

Class HTTPClient

java.lang.Object

org.ws4d.java.util.TimedEntry

org.ws4d.java.communication.protocol.http.HTTPClient

public class HTTPClient
extends TimedEntry

Client for asynchronous HTTP communication.

This client allows the asynchronous communication over HTTP.

Example

HTTPClient client = HTTPClient.create("http://127.0.0.1:8080/hello");
// access http://127.0.0.1:8080/hello
client.exchange();
// access http://127.0.0.1:8080/test
client.exchange("/test");
// access http://127.0.0.1:8080/test with a user defined HTTP GET request
HTTPRequest request = new DefaultHTTPGetRequest(); client.exchange(request);
// Close the communication
client.close();

See Also:

HTTPRequest

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CLIENT_CONNECTIONS

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection with the server.
static void	closeAllClients() Close all existing and provided HTTP clients with the close() method.
static void	exchange(HTTPClientDestination dest, boolean secure) Sends a simple HTTP GET request to the host, defined by the create method.
static void	exchange(HTTPClientDestination dest, HTTPRequest request) Sends a HTTP request (with the path defined in the HTTP header inside the request) to the host, defined by the create method.
static void	exchange(HTTPClientDestination dest, java.lang.String request, boolean secure) Sends a simple HTTP GET request with given request path to the host, defined by the create method.
java.lang.String	getPresetRequest() Returns the preset HTTP path for the request.
TCPConnection	getTCPConnection() Returns the TCP connection for this HTTP client.
boolean	isClosed() Returns true if the client is closed and cannot be used for a request or false if the client can still be used.
void	kill() Closes the connection with the server immediately!!!
static void	killAllClients() Kill all existing and provided HTTP clients with the kill() method.
void	register(ContentType type, HTTPResponseHandler handler) Registers a handler with given Internet media type which will handle incoming HTTP responses.
protected void	timedOut() Runs what should be done at time out.

Methods inherited from class org.ws4d.java.util.TimedEntry

isDisabled, toString

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CLIENT_CONNECTIONS

public static final int MAX_CLIENT_CONNECTIONS

Method Detail

killAllClients

public static void killAllClients()

Kill all existing and provided HTTP clients with the kill() method.

closeAllClients

public static void closeAllClients()

Close all existing and provided HTTP clients with the close() method.

exchange

public static void exchange(HTTPClientDestination dest,
                            boolean secure)

Sends a simple HTTP GET request to the host, defined by the create method.

The request is not actually sent instantaneously to the host. It is put into a request queue and will be started as soon as possible. The speed depends on the thread scheduler and the Object.notifiy() method.

exchange

public static void exchange(HTTPClientDestination dest,
                            java.lang.String request,
                            boolean secure)

Sends a simple HTTP GET request with given request path to the host, defined by the create method.

The request is not actually sent instantaneously to the host. It is put into a request queue and will be started as soon as possible. The speed depends on the thread scheduler and the Object.notifiy() method.

Parameters:

request - the HTTP request path.

exchange

public static void exchange(HTTPClientDestination dest,
                            HTTPRequest request)

Sends a HTTP request (with the path defined in the HTTP header inside the request) to the host, defined by the create method.

The request is not actually sent instantaneously to the host. It is put into a request queue and will be started as soon as possible. The speed depends on the thread scheduler and the Object.notifiy() method..

Parameters:

request - the HTTP request.

register

public void register(ContentType type,
                     HTTPResponseHandler handler)

Registers a handler with given Internet media type which will handle incoming HTTP responses.

This HTTPResponseHandler will ONLY BE USED if NO handler is returned by the HTTPRequest.getResponseHandler(ContentType) method.

Parameters:

type - the Internet media type.

handler - the handler which will handle the HTTP response.

See Also:

HTTPRequest

getPresetRequest

public java.lang.String getPresetRequest()

Returns the preset HTTP path for the request.

Returns:

the HTTP path.

getTCPConnection

public TCPConnection getTCPConnection()

Returns the TCP connection for this HTTP client.

Returns:

the TCP connection

close

public void close()

Closes the connection with the server.

This will stop the response and request threads before the connection is closed. The client will try to send the queued requests and handle the incoming responses before the client is closed.

If the client should be closed immediately use the kill() method.

kill

public void kill()

Closes the connection with the server immediately!!!

Existing connections will be closed regardless of which thread wants to read the streams. This will stop the response and request threads before the connection is closed.

If the connection should be closed without killing the connections the close() method should be used.

isClosed

public boolean isClosed()

Returns true if the client is closed and cannot be used for a request or false if the client can still be used.

Returns:

true if the client is closed and cannot be used for a request or false if the client can still be used.

timedOut

protected void timedOut()

Description copied from class: TimedEntry

Runs what should be done at time out. Will be called by the Watchdog at time out.

Specified by:

timedOut in class TimedEntry