org.ws4d.java.communication.protocol.http

Class SimpleHTTPClient

java.lang.Object

org.ws4d.java.communication.protocol.http.SimpleHTTPClient

public class SimpleHTTPClient
extends java.lang.Object

Client for HTTP communication.

This client allows synchronous HTTP communication.

Example

HTTPClient client = HTTPClient.create("http://127.0.0.1:8080/test");
// Send a simple GET request for /test
OutputStream out = client.exchange();
// Get the response
HTTP header HTTPResponseHeader response = client.getResponseHeader();
// Get the response HTTP body
InputStream in = client.getResponseBody();
// Send a simple GET request for /hello
OutputStream out = client.exchange("/hello");
// Get the response HTTP header
HTTPResponseHeader response = client.getResponseHeader();
// Get the response HTTP body
InputStream in = client.getResponseBody();
// Close the communication
client.close();

Constructor Summary

Constructors

Constructor and Description
SimpleHTTPClient(HTTPClientDestination dest) Creates a HTTP client to communicate with given host.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the HTTP connection between client and server.
java.io.OutputStream	exchange() Sends a simple HTTP GET request to the host, defined by the create method.
java.io.OutputStream	exchange(HTTPRequestHeader header, boolean sendHeader) Sends a HTTP request with given HTTP header to the host, defined by the create method.
java.io.OutputStream	exchange(java.lang.String request) Sends a simple HTTP GET request with given request path to the host, defined by the create method.
java.io.OutputStream	exchange(java.lang.String method, java.lang.String request) Sends a HTTP request with a given HTTP method and request path to the host, defined by the create method.
void	explicitConnect() Opens a TCP connection to the defined host.
TCPConnection	getConnection()
CredentialInfo	getCredentialInfo()
java.lang.String	getPresetRequest() Returns the preset HTTP path for the request.
HTTPRequestHeader	getRequestHeader() Returns the HTTP request header.
java.io.InputStream	getResponseBody() Returns an InputStream which allows to read the HTTP response body.
HTTPInputStream	getResponseBody(Sync syn)
HTTPResponseHeader	getResponseHeader() Returns the HTTP response header.
boolean	isKeepAlive() Returns true if the HTTP connection must stay persistent, false otherwise.
void	resetConnection() Resets the connection.
void	sendHeader()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHTTPClient

public SimpleHTTPClient(HTTPClientDestination dest)

Creates a HTTP client to communicate with given host.

The given request MUST be a HTTP address. The path behind host and port will be used in the exchange() method as request. The method exchange(String) and exchange(String, String) expect the request on their own.

Parameters:

dest -

Method Detail

getPresetRequest

public java.lang.String getPresetRequest()

Returns the preset HTTP path for the request.

This request is used as default for the exchange() method.

Returns:

the HTTP path.

explicitConnect

public void explicitConnect()
                     throws java.io.IOException

Opens a TCP connection to the defined host.

Usually the exchange methods will open the TCP connection on their own, but sometimes it may be necessary to have previously opened the connection.

Throws:

java.io.IOException - Throws exception if connection fails.

resetConnection

public void resetConnection()

Resets the connection.

Throws:

java.io.IOException

exchange

public java.io.OutputStream exchange()
                              throws java.io.IOException

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

Returns:

An OutputStream which can be used to send HTTP body as part of the request.

Throws:

java.io.IOException - Throws exception if sending the HTTP header fails.

exchange

public java.io.OutputStream exchange(java.lang.String request)
                              throws java.io.IOException

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

Parameters:

request - the HTTP request path.

Returns:

An OutputStream which can be used to send HTTP body as part of the request.

Throws:

java.io.IOException - Throws exception if sending the HTTP header fails.

exchange

public java.io.OutputStream exchange(java.lang.String method,
                                     java.lang.String request)
                              throws java.io.IOException

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

The HTTP method can be GET or POST.

Parameters:

method - HTTP method. e.g. GET or POST.

request - The HTTP request path.

Returns:

An OutputStream which can be used to send HTTP body as part of the request.

Throws:

java.io.IOException - Throws exception if sending the HTTP header fails.

exchange

public java.io.OutputStream exchange(HTTPRequestHeader header,
                                     boolean sendHeader)
                              throws java.io.IOException

Sends a HTTP request with given HTTP header to the host, defined by the create method.

Parameters:

header - The HTTP header.

Returns:

An OutputStream which can be used to send HTTP body as part of the request.

Throws:

java.io.IOException - Throws exception sending HTTP header fails.

sendHeader

public void sendHeader()
                throws java.io.IOException

Throws:

java.io.IOException

getConnection

public TCPConnection getConnection()

getRequestHeader

public HTTPRequestHeader getRequestHeader()

Returns the HTTP request header.

Returns:

the HTTP request header.

getResponseHeader

public HTTPResponseHeader getResponseHeader()
                                     throws java.io.IOException

Returns the HTTP response header.

Returns:

the HTTP response header.

Throws:

java.io.IOException - Throws exception receiving the header fails.

getResponseBody

public java.io.InputStream getResponseBody()

Returns an InputStream which allows to read the HTTP response body.

Returns:

an InputStream which allows to read the HTTP response body.

getResponseBody

public HTTPInputStream getResponseBody(Sync syn)

isKeepAlive

public boolean isKeepAlive()

Returns true if the HTTP connection must stay persistent, false otherwise.

Returns:

true if the HTTP connection must stay persistent, false otherwise.

close

public void close()
           throws java.io.IOException

Closes the HTTP connection between client and server.

Throws:

java.io.IOException - Throws exception

getCredentialInfo

public CredentialInfo getCredentialInfo()