| java.lang.Object
 com.oreilly.servlet.HttpMessage
All known Subclasses: com.oreilly.servlet.HttpsMessage,
| HttpMessage | | public class HttpMessage (Code) | | A class to simplify HTTP applet-server communication. It abstracts
the communication into messages, which can be either GET or POST.
It can be used like this:
URL url = new URL(getCodeBase(), "/servlet/ServletName");
HttpMessage msg = new HttpMessage(url);
// Parameters may optionally be set using java.util.Properties
Properties props = new Properties();
props.put("name", "value");
// Headers, cookies, and authorization may be set as well
msg.setHeader("Accept", "image/png"); // optional
msg.setCookie("JSESSIONID", "9585155923883872"); // optional
msg.setAuthorization("guest", "try2gueSS"); // optional
InputStream in = msg.sendGetMessage(props);
This class is loosely modeled after the ServletMessage class written
by Rod McChesney of JavaSoft.
author:
Jason Hunter, Copyright © 1998
version:
1.3, 2000/10/24, fixed headers NPE bug
version:
1.2, 2000/10/15, changed uploaded object MIME type to
version:
application/x-java-serialized-object
version:
1.1, 2000/06/11, added ability to set headers, cookies,
version:
and authorization
version:
1.0, 1998/09/18 |
| Constructor Summary | |
| public | HttpMessage(URL servlet)
Constructs a new HttpMessage that can be used to communicate with the
servlet at the specified URL. |
| HttpMessage | | public HttpMessage(URL servlet)(Code) | | Constructs a new HttpMessage that can be used to communicate with the
servlet at the specified URL.
Parameters:
servlet - the server resource (typically a servlet) with whichto communicate |
| sendGetMessage | | public InputStream sendGetMessage() throws IOException(Code) | | Performs a GET request to the servlet, with no query string.
an InputStream to read the response
exception:
IOException - if an I/O error occurs |
| sendGetMessage | | public InputStream sendGetMessage(Properties args) throws IOException(Code) | | Performs a GET request to the servlet, building
a query string from the supplied properties list.
Parameters:
args - the properties list from which to build a query string an InputStream to read the response
exception:
IOException - if an I/O error occurs |
| sendPostMessage | | public InputStream sendPostMessage() throws IOException(Code) | | Performs a POST request to the servlet, with no query string.
an InputStream to read the response
exception:
IOException - if an I/O error occurs |
| sendPostMessage | | public InputStream sendPostMessage(Properties args) throws IOException(Code) | | Performs a POST request to the servlet, building
post data from the supplied properties list.
Parameters:
args - the properties list from which to build the post data an InputStream to read the response
exception:
IOException - if an I/O error occurs |
| sendPostMessage | | public InputStream sendPostMessage(Serializable obj) throws IOException(Code) | | Performs a POST request to the servlet, uploading a serialized object.
The servlet can receive the object in its doPost() method
like this:
ObjectInputStream objin =
new ObjectInputStream(req.getInputStream());
Object obj = objin.readObject();
The type of the uploaded object can be determined through introspection.
Parameters:
obj - the serializable object to upload an InputStream to read the response
exception:
IOException - if an I/O error occurs |
| setAuthorization | | public void setAuthorization(String name, String password)(Code) | | Sets the authorization information for the request (using BASIC
authentication via the HTTP Authorization header). The authorization
persists across multiple requests.
Parameters:
name - the user name
Parameters:
name - the user password |
| setCookie | | public void setCookie(String name, String value)(Code) | | Sets a request cookie with the given name and value. The cookie
persists across multiple requests. The caller is responsible for
ensuring there are no illegal characters in the name and value.
Parameters:
name - the header name
Parameters:
value - the header value |
| setHeader | | public void setHeader(String name, String value)(Code) | | Sets a request header with the given name and value. The header
persists across multiple requests. The caller is responsible for
ensuring there are no illegal characters in the name and value.
Parameters:
name - the header name
Parameters:
value - the header value |
|
|