java.net
Class HttpURLConnection

java.lang.Object
  |
  +--java.net.URLConnection
        |
        +--java.net.HttpURLConnection

public abstract class HttpURLConnection
extends URLConnection

A URLConnection with support for HTTP-specific features. See the spec for details.

Each HttpURLConnection instance is used to make a single request but the underlying network connection to the HTTP server may be transparently shared by other instances. Calling the close() methods on the InputStream or OutputStream of an HttpURLConnection after a request may free network resources associated with this instance but has no effect on any shared persistent connection. Calling the disconnect() method may close the underlying socket if a persistent connection is otherwise idle at that time.

Since:
JDK1.1
See Also:
disconnect()

Field Summary
static int HTTP_ACCEPTED
copy->  HTTP_ACCEPTED
HTTP Status-Code 202: Accepted.
static int HTTP_BAD_GATEWAY
copy->  HTTP_BAD_GATEWAY
HTTP Status-Code 502: Bad Gateway.
static int HTTP_BAD_METHOD
copy->  HTTP_BAD_METHOD
HTTP Status-Code 405: Method Not Allowed.
static int HTTP_BAD_REQUEST
copy->  HTTP_BAD_REQUEST
HTTP Status-Code 400: Bad Request.
static int HTTP_CLIENT_TIMEOUT
copy->  HTTP_CLIENT_TIMEOUT
HTTP Status-Code 408: Request Time-Out.
static int HTTP_CONFLICT
copy->  HTTP_CONFLICT
HTTP Status-Code 409: Conflict.
static int HTTP_CREATED
copy->  HTTP_CREATED
HTTP Status-Code 201: Created.
static int HTTP_ENTITY_TOO_LARGE
copy->  HTTP_ENTITY_TOO_LARGE
HTTP Status-Code 413: Request Entity Too Large.
static int HTTP_FORBIDDEN
copy->  HTTP_FORBIDDEN
HTTP Status-Code 403: Forbidden.
static int HTTP_GATEWAY_TIMEOUT
copy->  HTTP_GATEWAY_TIMEOUT
HTTP Status-Code 504: Gateway Timeout.
static int HTTP_GONE
copy->  HTTP_GONE
HTTP Status-Code 410: Gone.
static int HTTP_INTERNAL_ERROR
copy->  HTTP_INTERNAL_ERROR
HTTP Status-Code 500: Internal Server Error.
static int HTTP_LENGTH_REQUIRED
copy->  HTTP_LENGTH_REQUIRED
HTTP Status-Code 411: Length Required.
static int HTTP_MOVED_PERM
copy->  HTTP_MOVED_PERM
HTTP Status-Code 301: Moved Permanently.
static int HTTP_MOVED_TEMP
copy->  HTTP_MOVED_TEMP
HTTP Status-Code 302: Temporary Redirect.
static int HTTP_MULT_CHOICE
copy->  HTTP_MULT_CHOICE
HTTP Status-Code 300: Multiple Choices.
static int HTTP_NO_CONTENT
copy->  HTTP_NO_CONTENT
HTTP Status-Code 204: No Content.
static int HTTP_NOT_ACCEPTABLE
copy->  HTTP_NOT_ACCEPTABLE
HTTP Status-Code 406: Not Acceptable.
static int HTTP_NOT_AUTHORITATIVE
copy->  HTTP_NOT_AUTHORITATIVE
HTTP Status-Code 203: Non-Authoritative Information.
static int HTTP_NOT_FOUND
copy->  HTTP_NOT_FOUND
HTTP Status-Code 404: Not Found.
static int HTTP_NOT_IMPLEMENTED
copy->  HTTP_NOT_IMPLEMENTED
HTTP Status-Code 501: Not Implemented.
static int HTTP_NOT_MODIFIED
copy->  HTTP_NOT_MODIFIED
HTTP Status-Code 304: Not Modified.
static int HTTP_OK
copy->  HTTP_OK
HTTP Status-Code 200: OK.
static int HTTP_PARTIAL
copy->  HTTP_PARTIAL
HTTP Status-Code 206: Partial Content.
static int HTTP_PAYMENT_REQUIRED
copy->  HTTP_PAYMENT_REQUIRED
HTTP Status-Code 402: Payment Required.
static int HTTP_PRECON_FAILED
copy->  HTTP_PRECON_FAILED
HTTP Status-Code 412: Precondition Failed.
static int HTTP_PROXY_AUTH
copy->  HTTP_PROXY_AUTH
HTTP Status-Code 407: Proxy Authentication Required.
static int HTTP_REQ_TOO_LONG
copy->  HTTP_REQ_TOO_LONG
HTTP Status-Code 414: Request-URI Too Large.
static int HTTP_RESET
copy->  HTTP_RESET
HTTP Status-Code 205: Reset Content.
static int HTTP_SEE_OTHER
copy->  HTTP_SEE_OTHER
HTTP Status-Code 303: See Other.
static int HTTP_SERVER_ERROR
copy->  HTTP_SERVER_ERROR
Deprecated. it is misplaced and shouldn't have existed.

static int HTTP_UNAUTHORIZED
copy->  HTTP_UNAUTHORIZED
HTTP Status-Code 401: Unauthorized.
static int HTTP_UNAVAILABLE
copy->  HTTP_UNAVAILABLE
HTTP Status-Code 503: Service Unavailable.
static int HTTP_UNSUPPORTED_TYPE
copy->  HTTP_UNSUPPORTED_TYPE
HTTP Status-Code 415: Unsupported Media Type.
static int HTTP_USE_PROXY
copy->  HTTP_USE_PROXY
HTTP Status-Code 305: Use Proxy.
static int HTTP_VERSION
copy->  HTTP_VERSION
HTTP Status-Code 505: HTTP Version Not Supported.
protected  boolean instanceFollowRedirects
copy->  instanceFollowRedirects
If true, the protocol will automatically follow redirects. If false, the protocol will not automatically follow redirects.

This field is set by the setInstanceFollowRedirects method. Its value is returned by the getInstanceFollowRedirects method.

Its default value is based on the value of the static followRedirects at HttpURLConnection construction time.

See Also:
setInstanceFollowRedirects(boolean), getInstanceFollowRedirects(), setFollowRedirects(boolean)
protected  String method
copy->  method
The HTTP method (GET,POST,PUT,etc.).
protected  int responseCode
copy->  responseCode
An int representing the three digit HTTP Status-Code.
  • 1xx: Informational
  • 2xx: Success
  • 3xx: Redirection
  • 4xx: Client Error
  • 5xx: Server Error
protected  String responseMessage
copy->  responseMessage
The HTTP response message.
 
Fields inherited from class java.net.URLConnection
allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches
 
Constructor Summary
protected HttpURLConnection
copy->  new HttpURLConnection( )
copy->  <HttpURLConnection var> = new HttpURLConnection(<URL u>);
Constructor for the URLStreamHandler.
Parameters:
u - the URL
 
Method Summary
abstract  void disconnect()
copy->  .disconnect()
copy->  <HttpURLConnection>.disconnect();
Indicates that other requests to the server are unlikely in the near future. Calling disconnect() should not imply that this HttpURLConnection instance can be reused for other requests.
 InputStream getErrorStream()
copy->  .getErrorStream()
copy->  <InputStream var>=<HttpURLConnection>.getErrorStream();
Returns the error stream if the connection failed but the server sent useful data nonetheless. The typical example is when an HTTP server responds with a 404, which will cause a FileNotFoundException to be thrown in connect, but the server sent an HTML help page with suggestions as to what to do.

This method will not cause a connection to be initiated. If there the connection was not connected, or if the server did not have an error while connecting or if the server did have an error but there no error data was sent, this method will return null. This is the default.

Returns:
an error stream if any, null if there have been no errors, the connection is not connected or the server sent no useful data.
static boolean getFollowRedirects()
copy->  HttpURLConnection.getFollowRedirects()
copy->  <boolean var>=HttpURLConnection.getFollowRedirects();
Returns a boolean indicating whether or not HTTP redirects (3xx) should be automatically followed.
Returns:
true if HTTP redirects should be automatically followed, false if not.
See Also:
setFollowRedirects(boolean)
 long getHeaderFieldDate(String name, long Default)
copy->  .getHeaderFieldDate(, )
copy->  <long var>=<HttpURLConnection>.getHeaderFieldDate(<String name>, <long Default>);
Returns the value of the named field parsed as date. The result is the number of milliseconds since January 1, 1970 GMT represented by the named field.

This form of getHeaderField exists because some connection types (e.g., http-ng) have pre-parsed headers. Classes for that connection type can override this method and short-circuit the parsing.

Overrides:
getHeaderFieldDate in class URLConnection
Following copied from class: java.net.URLConnection
Parameters:
name - the name of the header field.
Default - a default value.
Returns:
the value of the field, parsed as a date. The value of the Default argument is returned if the field is missing or malformed.
 boolean getInstanceFollowRedirects()
copy->  .getInstanceFollowRedirects()
copy->  <boolean var>=<HttpURLConnection>.getInstanceFollowRedirects();
Returns the value of this HttpURLConnection's instanceFollowRedirects field.
Returns:
the value of this HttpURLConnection's instanceFollowRedirects field.
See Also:
instanceFollowRedirects, setInstanceFollowRedirects(boolean)
 Permission getPermission()
copy->  .getPermission()
copy->  <Permission var>=<HttpURLConnection>.getPermission();
Returns a permission object representing the permission necessary to make the connection represented by this object. This method returns null if no permission is required to make the connection. By default, this method returns java.security.AllPermission. Subclasses should override this method and return the permission that best represents the permission required to make a a connection to the URL. For example, a URLConnection representing a file: URL would return a java.io.FilePermission object.

The permission returned may dependent upon the state of the connection. For example, the permission before connecting may be different from that after connecting. For example, an HTTP sever, say foo.com, may redirect the connection to a different host, say bar.com. Before connecting the permission returned by the connection will represent the permission needed to connect to foo.com, while the permission returned after connecting will be to bar.com.

Permissions are generally used for two purposes: to protect caches of objects obtained through URLConnections, and to check the right of a recipient to learn about a particular URL. In the first case, the permission should be obtained after the object has been obtained. For example, in an HTTP connection, this will represent the permission to connect to the host from which the data was ultimately fetched. In the second case, the permission should be obtained and tested before connecting.

Overrides:
getPermission in class URLConnection
Following copied from class: java.net.URLConnection
Returns:
the permission object representing the permission necessary to make the connection represented by this URLConnection.
Throws:
IOException - if the computation of the permission requires network or file I/O and an exception occurs while computing it.
 String getRequestMethod()
copy->  .getRequestMethod()
copy->  <String var>=<HttpURLConnection>.getRequestMethod();
Get the request method.
Returns:
the HTTP request method
See Also:
setRequestMethod(java.lang.String)
 int getResponseCode()
copy->  .getResponseCode()
copy->  <int var>=<HttpURLConnection>.getResponseCode();
Gets HTTP response status from responses like:
 HTTP/1.0 200 OK
 HTTP/1.0 401 Unauthorized
 
Extracts the ints 200 and 401 respectively. Returns -1 if none can be discerned from the response (i.e., the response is not valid HTTP).
Returns:
the HTTP Status-Code
Throws:
IOException - if an error occurred connecting to the server.
 String getResponseMessage()
copy->  .getResponseMessage()
copy->  <String var>=<HttpURLConnection>.getResponseMessage();
Gets the HTTP response message, if any, returned along with the response code from a server. From responses like:
 HTTP/1.0 200 OK
 HTTP/1.0 404 Not Found
 
Extracts the Strings "OK" and "Not Found" respectively. Returns null if none could be discerned from the responses (the result was not valid HTTP).
Returns:
the HTTP response message, or null
Throws:
IOException - if an error occurred connecting to the server.
static void setFollowRedirects(boolean set)
copy->  HttpURLConnection.setFollowRedirects( )
copy->  HttpURLConnection.setFollowRedirects(<boolean set>);
Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this class. True by default. Applets cannot change this variable.

If there is a security manager, this method first calls the security manager's checkSetFactory method to ensure the operation is allowed. This could result in a SecurityException.

Parameters:
set - a boolean indicating whether or not to follow HTTP redirects.
Throws:
SecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation.
See Also:
SecurityManager.checkSetFactory(), getFollowRedirects()
 void setInstanceFollowRedirects(boolean followRedirects)
copy->  .setInstanceFollowRedirects( )
copy->  <HttpURLConnection>.setInstanceFollowRedirects(<boolean followRedirects>);
Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this HttpURLConnection instance.

The default value comes from followRedirects, which defaults to true.

Parameters:
followRedirects - a boolean indicating whether or not to follow HTTP redirects.
See Also:
instanceFollowRedirects, getInstanceFollowRedirects()
 void setRequestMethod(String method)
copy->  .setRequestMethod( )
copy->  <HttpURLConnection>.setRequestMethod(<String method>);
Set the method for the URL request, one of:
  • GET
  • POST
  • HEAD
  • OPTIONS
  • PUT
  • DELETE
  • TRACE
are legal, subject to protocol restrictions. The default method is GET.
Parameters:
method - the HTTP method
Throws:
ProtocolException - if the method cannot be reset or if the requested method isn't valid for HTTP.
See Also:
getRequestMethod()
abstract  boolean usingProxy()
copy->  .usingProxy()
copy->  <boolean var>=<HttpURLConnection>.usingProxy();
Indicates if the connection is going through a proxy.
Returns:
a boolean indicating if the connection is using a proxy.
 
Methods inherited from class java.net.URLConnection
connect, getAllowUserInteraction, getContent, getContent, getContentEncoding, getContentLength, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldInt, getHeaderFieldKey, getIfModifiedSince, getInputStream, getLastModified, getOutputStream, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setRequestProperty, setUseCaches, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait