| com.google.gwt.http.client |
|
Provides the client-side classes and interfaces for making HTTP requests and
processing the associated responses.
Most applications will be interested in the {@link com.google.gwt.http.client.Request}, {@link com.google.gwt.http.client.RequestBuilder},
{@link com.google.gwt.http.client.RequestCallback} and {@link com.google.gwt.http.client.Response} classes.
Caveats
Same-Origin Security Policy
Modern web browsers restrict client-side scripts from accessing items outside
of their source origin. This means that a script loaded from www.foo.com cannot access
content from www.bar.com. For more details please see, Same-Origin Security
Policy.
Pending Request Limit
Modern web browsers are limited to having only two HTTP requests outstanding at
any one time. If your server experiences an error that prevents it from sending
a response, it can tie up your outstanding requests. If you are concerned about
this, you can always set timeouts for the request via {@link com.google.gwt.http.client.RequestBuilder#setTimeoutMillis(int)}.
Required Module
Modules that use the classes and interfaces in this package should inherit
the com.google.gwt.http.HTTP module.
{@gwt.include com/google/gwt/examples/http/InheritsExample.gwt.xml}
Quick Howto's
How should I write a RequestCallback handler class?
The following code shows how a {@link com.google.gwt.http.client.RequestCallback} instance should be written.
{@example com.google.gwt.examples.http.client.RequestCallbackExample}
How do I make a GET request?
The following example demonstrates how to perform an HTTP GET request.
{@example com.google.gwt.examples.http.client.GetExample}
How do I make a POST request?
The following example demonstrates how to perform an HTTP POST request.
{@example com.google.gwt.examples.http.client.PostExample}
How do I use request timeouts?
The following example demonstrates how to use the timeout feature.
{@example com.google.gwt.examples.http.client.TimeoutExample}
How do I construct a string for use in a query or POST body?
The following example demonstrates how to build a x-www-form-urlencoded string that can be used as a query string or as the body of a POST request.
{@example com.google.gwt.examples.http.client.QueryAndFormDataExample}
How can I make a {@link com.google.gwt.http.client.RequestBuilder} send a request other than GET or POST?
The following example demonstrates how to allow an HTTP request other than a GET or a POST to be made. Beware: if you plan on supporting Safari, you cannot use this scheme.
{@example com.google.gwt.examples.http.client.RequestBuilderForAnyHTTPMethodTypeExample}
|
| Java Source File Name | Type | Comment |
| Header.java | Class | Class for describing an HTTP header. |
| Request.java | Class | An HTTP request that is waiting for a response. |
| RequestBuilder.java | Class | Builder for constructing
com.google.gwt.http.client.Request objects. |
| RequestBuilderTest.java | Class | Test cases for the
RequestBuilder class. |
| RequestCallback.java | Interface | The primary interface a caller must implement to receive a response to a
com.google.gwt.http.client.Request . |
| RequestException.java | Class | RequestException is the superclass for the HTTP request related exceptions. |
| RequestPermissionException.java | Class | Exception thrown when the
RequestBuilder attempts to make a request
to a URL which violates the Same-Origin Security
Policy. |
| RequestTest.java | Class | TODO: document me. |
| RequestTimeoutException.java | Class | Thrown to indicate that an HTTP request has timed out. |
| Response.java | Class | Wrapper which provides access to the components of an HTTP response. |
| ResponseTest.java | Class | |
| StringValidator.java | Class | Utility class for validating strings. |
| URL.java | Class | Utility class for the encoding and decoding URLs in their entirety or by
their individual components. |
| URLTest.java | Class | Tests for the URL utility class. |
| XMLHTTPRequest.java | Class | Utility class that serves as the one place where we interact with the
JavaScript XmlHttpRequest object. |