com.google.gwt.http.client.package-info Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* 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}
*/
package com.google.gwt.http.client;