public abstract class

HttpURLConnection

extends URLConnection
java.lang.Object
   ↳ java.net.URLConnection
     ↳ java.net.HttpURLConnection
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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.

See Also

Summary

Constants
int HTTP_ACCEPTED HTTP Status-Code 202: Accepted.
int HTTP_BAD_GATEWAY HTTP Status-Code 502: Bad Gateway.
int HTTP_BAD_METHOD HTTP Status-Code 405: Method Not Allowed.
int HTTP_BAD_REQUEST HTTP Status-Code 400: Bad Request.
int HTTP_CLIENT_TIMEOUT HTTP Status-Code 408: Request Time-Out.
int HTTP_CONFLICT HTTP Status-Code 409: Conflict.
int HTTP_CREATED HTTP Status-Code 201: Created.
int HTTP_ENTITY_TOO_LARGE HTTP Status-Code 413: Request Entity Too Large.
int HTTP_FORBIDDEN HTTP Status-Code 403: Forbidden.
int HTTP_GATEWAY_TIMEOUT HTTP Status-Code 504: Gateway Timeout.
int HTTP_GONE HTTP Status-Code 410: Gone.
int HTTP_INTERNAL_ERROR HTTP Status-Code 500: Internal Server Error.
int HTTP_LENGTH_REQUIRED HTTP Status-Code 411: Length Required.
int HTTP_MOVED_PERM HTTP Status-Code 301: Moved Permanently.
int HTTP_MOVED_TEMP HTTP Status-Code 302: Temporary Redirect.
int HTTP_MULT_CHOICE HTTP Status-Code 300: Multiple Choices.
int HTTP_NOT_ACCEPTABLE HTTP Status-Code 406: Not Acceptable.
int HTTP_NOT_AUTHORITATIVE HTTP Status-Code 203: Non-Authoritative Information.
int HTTP_NOT_FOUND HTTP Status-Code 404: Not Found.
int HTTP_NOT_IMPLEMENTED HTTP Status-Code 501: Not Implemented.
int HTTP_NOT_MODIFIED HTTP Status-Code 304: Not Modified.
int HTTP_NO_CONTENT HTTP Status-Code 204: No Content.
int HTTP_OK HTTP Status-Code 200: OK.
int HTTP_PARTIAL HTTP Status-Code 206: Partial Content.
int HTTP_PAYMENT_REQUIRED HTTP Status-Code 402: Payment Required.
int HTTP_PRECON_FAILED HTTP Status-Code 412: Precondition Failed.
int HTTP_PROXY_AUTH HTTP Status-Code 407: Proxy Authentication Required.
int HTTP_REQ_TOO_LONG HTTP Status-Code 414: Request-URI Too Large.
int HTTP_RESET HTTP Status-Code 205: Reset Content.
int HTTP_SEE_OTHER HTTP Status-Code 303: See Other.
int HTTP_SERVER_ERROR This constant is deprecated. it is misplaced and shouldn't have existed.
int HTTP_UNAUTHORIZED HTTP Status-Code 401: Unauthorized.
int HTTP_UNAVAILABLE HTTP Status-Code 503: Service Unavailable.
int HTTP_UNSUPPORTED_TYPE HTTP Status-Code 415: Unsupported Media Type.
int HTTP_USE_PROXY HTTP Status-Code 305: Use Proxy.
int HTTP_VERSION HTTP Status-Code 505: HTTP Version Not Supported.
Fields
protected int chunkLength The chunk-length when using chunked encoding streaming mode for output.
protected int fixedContentLength The fixed content-length when using fixed-length streaming mode.
protected boolean instanceFollowRedirects If true, the protocol will automatically follow redirects.
protected String method The HTTP method (GET,POST,PUT,etc.).
protected int responseCode An int representing the three digit HTTP Status-Code.
protected String responseMessage The HTTP response message.
[Expand]
Inherited Fields
From class java.net.URLConnection
Protected Constructors
HttpURLConnection(URL u)
Constructor for the HttpURLConnection.
Public Methods
abstract void disconnect()
Indicates that other requests to the server are unlikely in the near future.
InputStream getErrorStream()
Returns the error stream if the connection failed but the server sent useful data nonetheless.
static boolean getFollowRedirects()
Returns a boolean indicating whether or not HTTP redirects (3xx) should be automatically followed.
String getHeaderField(int n)
Returns the value for the nth header field.
long getHeaderFieldDate(String name, long Default)
Returns the value of the named field parsed as date.
String getHeaderFieldKey(int n)
Returns the key for the nth header field.
boolean getInstanceFollowRedirects()
Returns the value of this HttpURLConnection's instanceFollowRedirects field.
Permission getPermission()
Returns a permission object representing the permission necessary to make the connection represented by this object.
String getRequestMethod()
Get the request method.
int getResponseCode()
Gets the status code from an HTTP response message.
String getResponseMessage()
Gets the HTTP response message, if any, returned along with the response code from a server.
void setChunkedStreamingMode(int chunklen)
This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is not known in advance.
void setFixedLengthStreamingMode(int contentLength)
This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is known in advance.
static void setFollowRedirects(boolean set)
Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this class.
void setInstanceFollowRedirects(boolean followRedirects)
Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this HttpURLConnection instance.
void 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.
abstract boolean usingProxy()
Indicates if the connection is going through a proxy.
[Expand]
Inherited Methods
From class java.net.URLConnection
From class java.lang.Object

Constants

public static final int HTTP_ACCEPTED

HTTP Status-Code 202: Accepted.

Constant Value: 202 (0x000000ca)

public static final int HTTP_BAD_GATEWAY

HTTP Status-Code 502: Bad Gateway.

Constant Value: 502 (0x000001f6)

public static final int HTTP_BAD_METHOD

HTTP Status-Code 405: Method Not Allowed.

Constant Value: 405 (0x00000195)

public static final int HTTP_BAD_REQUEST

HTTP Status-Code 400: Bad Request.

Constant Value: 400 (0x00000190)

public static final int HTTP_CLIENT_TIMEOUT

HTTP Status-Code 408: Request Time-Out.

Constant Value: 408 (0x00000198)

public static final int HTTP_CONFLICT

HTTP Status-Code 409: Conflict.

Constant Value: 409 (0x00000199)

public static final int HTTP_CREATED

HTTP Status-Code 201: Created.

Constant Value: 201 (0x000000c9)

public static final int HTTP_ENTITY_TOO_LARGE

HTTP Status-Code 413: Request Entity Too Large.

Constant Value: 413 (0x0000019d)

public static final int HTTP_FORBIDDEN

HTTP Status-Code 403: Forbidden.

Constant Value: 403 (0x00000193)

public static final int HTTP_GATEWAY_TIMEOUT

HTTP Status-Code 504: Gateway Timeout.

Constant Value: 504 (0x000001f8)

public static final int HTTP_GONE

HTTP Status-Code 410: Gone.

Constant Value: 410 (0x0000019a)

public static final int HTTP_INTERNAL_ERROR

HTTP Status-Code 500: Internal Server Error.

Constant Value: 500 (0x000001f4)

public static final int HTTP_LENGTH_REQUIRED

HTTP Status-Code 411: Length Required.

Constant Value: 411 (0x0000019b)

public static final int HTTP_MOVED_PERM

HTTP Status-Code 301: Moved Permanently.

Constant Value: 301 (0x0000012d)

public static final int HTTP_MOVED_TEMP

HTTP Status-Code 302: Temporary Redirect.

Constant Value: 302 (0x0000012e)

public static final int HTTP_MULT_CHOICE

HTTP Status-Code 300: Multiple Choices.

Constant Value: 300 (0x0000012c)

public static final int HTTP_NOT_ACCEPTABLE

HTTP Status-Code 406: Not Acceptable.

Constant Value: 406 (0x00000196)

public static final int HTTP_NOT_AUTHORITATIVE

HTTP Status-Code 203: Non-Authoritative Information.

Constant Value: 203 (0x000000cb)

public static final int HTTP_NOT_FOUND

HTTP Status-Code 404: Not Found.

Constant Value: 404 (0x00000194)

public static final int HTTP_NOT_IMPLEMENTED

HTTP Status-Code 501: Not Implemented.

Constant Value: 501 (0x000001f5)

public static final int HTTP_NOT_MODIFIED

HTTP Status-Code 304: Not Modified.

Constant Value: 304 (0x00000130)

public static final int HTTP_NO_CONTENT

HTTP Status-Code 204: No Content.

Constant Value: 204 (0x000000cc)

public static final int HTTP_OK

HTTP Status-Code 200: OK.

Constant Value: 200 (0x000000c8)

public static final int HTTP_PARTIAL

HTTP Status-Code 206: Partial Content.

Constant Value: 206 (0x000000ce)

public static final int HTTP_PAYMENT_REQUIRED

HTTP Status-Code 402: Payment Required.

Constant Value: 402 (0x00000192)

public static final int HTTP_PRECON_FAILED

HTTP Status-Code 412: Precondition Failed.

Constant Value: 412 (0x0000019c)

public static final int HTTP_PROXY_AUTH

HTTP Status-Code 407: Proxy Authentication Required.

Constant Value: 407 (0x00000197)

public static final int HTTP_REQ_TOO_LONG

HTTP Status-Code 414: Request-URI Too Large.

Constant Value: 414 (0x0000019e)

public static final int HTTP_RESET

HTTP Status-Code 205: Reset Content.

Constant Value: 205 (0x000000cd)

public static final int HTTP_SEE_OTHER

HTTP Status-Code 303: See Other.

Constant Value: 303 (0x0000012f)

public static final int HTTP_SERVER_ERROR

This constant is deprecated.
it is misplaced and shouldn't have existed.

HTTP Status-Code 500: Internal Server Error.

Constant Value: 500 (0x000001f4)

public static final int HTTP_UNAUTHORIZED

HTTP Status-Code 401: Unauthorized.

Constant Value: 401 (0x00000191)

public static final int HTTP_UNAVAILABLE

HTTP Status-Code 503: Service Unavailable.

Constant Value: 503 (0x000001f7)

public static final int HTTP_UNSUPPORTED_TYPE

HTTP Status-Code 415: Unsupported Media Type.

Constant Value: 415 (0x0000019f)

public static final int HTTP_USE_PROXY

HTTP Status-Code 305: Use Proxy.

Constant Value: 305 (0x00000131)

public static final int HTTP_VERSION

HTTP Status-Code 505: HTTP Version Not Supported.

Constant Value: 505 (0x000001f9)

Fields

protected int chunkLength

The chunk-length when using chunked encoding streaming mode for output. A value of -1 means chunked encoding is disabled for output.

protected int fixedContentLength

The fixed content-length when using fixed-length streaming mode. A value of -1 means fixed-length streaming mode is disabled for output.

protected boolean 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.

protected String method

The HTTP method (GET,POST,PUT,etc.).

protected int 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

The HTTP response message.

Protected Constructors

protected HttpURLConnection (URL u)

Constructor for the HttpURLConnection.

Parameters
u the URL

Public Methods

public abstract void 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.

public InputStream 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 the connection was not connected, or if the server did not have an error while connecting or if the server had an error but 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.

public static boolean 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.

public String getHeaderField (int n)

Returns the value for the nth header field. Some implementations may treat the 0th header field as special, i.e. as the status line returned by the HTTP server.

This method can be used in conjunction with the getHeaderFieldKey method to iterate through all the headers in the message.

Parameters
n an index, where n>=0.
Returns
  • the value of the nth header field, or null if the value does not exist.

public long 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.

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.

public String getHeaderFieldKey (int n)

Returns the key for the nth header field. Some implementations may treat the 0th header field as special, i.e. as the status line returned by the HTTP server. In this case, getHeaderField(0) returns the status line, but getHeaderFieldKey(0) returns null.

Parameters
n an index, where n >=0.
Returns
  • the key for the nth header field, or null if the key does not exist.

public boolean getInstanceFollowRedirects ()

Returns the value of this HttpURLConnection's instanceFollowRedirects field.

Returns
  • the value of this HttpURLConnection's instanceFollowRedirects field.

public Permission 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.

Returns
  • the permission object representing the permission necessary to make the connection represented by this URLConnection.
Throws
IOException

public String getRequestMethod ()

Get the request method.

Returns
  • the HTTP request method

public int getResponseCode ()

Gets the status code from an HTTP response message. For example, in the case of the following status lines:

 HTTP/1.0 200 OK
 HTTP/1.0 401 Unauthorized
 
It will return 200 and 401 respectively. Returns -1 if no code can be discerned from the response (i.e., the response is not valid HTTP).

Returns
  • the HTTP Status-Code, or -1
Throws
IOException if an error occurred connecting to the server.

public String 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.

public void setChunkedStreamingMode (int chunklen)

This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is not known in advance. In this mode, chunked transfer encoding is used to send the request body. Note, not all HTTP servers support this mode.

When output streaming is enabled, authentication and redirection cannot be handled automatically. A HttpRetryException will be thrown when reading the response if authentication or redirection are required. This exception can be queried for the details of the error.

This method must be called before the URLConnection is connected.

Parameters
chunklen The number of bytes to write in each chunk. If chunklen is less than or equal to zero, a default value will be used.
Throws
IllegalStateException if URLConnection is already connected or if a different streaming mode is already enabled.

public void setFixedLengthStreamingMode (int contentLength)

This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is known in advance.

An exception will be thrown if the application attempts to write more data than the indicated content-length, or if the application closes the OutputStream before writing the indicated amount.

When output streaming is enabled, authentication and redirection cannot be handled automatically. A HttpRetryException will be thrown when reading the response if authentication or redirection are required. This exception can be queried for the details of the error.

This method must be called before the URLConnection is connected.

Parameters
contentLength The number of bytes which will be written to the OutputStream.
Throws
IllegalStateException if URLConnection is already connected or if a different streaming mode is already enabled.
IllegalArgumentException if a content length less than zero is specified.

public static void 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.

public void 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.

public void 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.

public abstract boolean usingProxy ()

Indicates if the connection is going through a proxy.

Returns
  • a boolean indicating if the connection is using a proxy.