Most visited

Recently visited

Results for

Added in API level 1

HttpURLConnection

public abstract class HttpURLConnection
extends URLConnection

java.lang.Object
↳	java.net.URLConnection
	↳	java.net.HttpURLConnection

Known Direct Subclasses

HttpsURLConnection

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

Uses of this class follow a pattern:

Obtain a new HttpURLConnection by calling URL.openConnection() and casting the result to HttpURLConnection.
Prepare the request. The primary property of a request is its URI. Request headers may also include metadata such as credentials, preferred content types, and session cookies.
Optionally upload a request body. Instances must be configured with setDoOutput(true) if they include a request body. Transmit data by writing to the stream returned by getOutputStream().
Read the response. Response headers typically include metadata such as the response body's content type and length, modified dates and session cookies. The response body may be read from the stream returned by getInputStream(). If the response has no body, that method returns an empty stream.
Disconnect. Once the response body has been read, the HttpURLConnection should be closed by calling disconnect(). Disconnecting releases the resources held by a connection so they may be closed or reused.

For example, to retrieve the webpage at http://www.android.com/:

   URL url = new URL("http://www.android.com/");
   HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
   try {
     InputStream in = new BufferedInputStream(urlConnection.getInputStream());
     readStream(in);
   } finally {
     urlConnection.disconnect();
   }

Secure Communication with HTTPS

Calling openConnection() on a URL with the "https" scheme will return an HttpsURLConnection, which allows for overriding the default HostnameVerifier and SSLSocketFactory. An application-supplied SSLSocketFactory created from an SSLContext can provide a custom X509TrustManager for verifying certificate chains and a custom X509KeyManager for supplying client certificates. See HttpsURLConnection for more details.

Response Handling

HttpURLConnection will follow up to five HTTP redirects. It will follow redirects from one origin server to another. This implementation doesn't follow redirects from HTTPS to HTTP or vice versa.

If the HTTP response indicates that an error occurred, getInputStream() will throw an IOException. Use getErrorStream() to read the error response. The headers can be read in the normal way using getHeaderFields(),

Posting Content

To upload data to a web server, configure the connection for output using setDoOutput(true).

For best performance, you should call either setFixedLengthStreamingMode(int) when the body length is known in advance, or setChunkedStreamingMode(int) when it is not. Otherwise HttpURLConnection will be forced to buffer the complete request body in memory before it is transmitted, wasting (and possibly exhausting) heap and increasing latency.

For example, to perform an upload:

   HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
   try {
     urlConnection.setDoOutput(true);
     urlConnection.setChunkedStreamingMode(0);

     OutputStream out = new BufferedOutputStream(urlConnection.getOutputStream());
     writeStream(out);

     InputStream in = new BufferedInputStream(urlConnection.getInputStream());
     readStream(in);
   } finally {
     urlConnection.disconnect();
   }

Performance

The input and output streams returned by this class are not buffered. Most callers should wrap the returned streams with BufferedInputStream or BufferedOutputStream. Callers that do only bulk reads or writes may omit buffering.

When transferring large amounts of data to or from a server, use streams to limit how much data is in memory at once. Unless you need the entire body to be in memory at once, process it as a stream (rather than storing the complete body as a single byte array or string).

To reduce latency, this class may reuse the same underlying Socket for multiple request/response pairs. As a result, HTTP connections may be held open longer than necessary. Calls to disconnect() may return the socket to a pool of connected sockets. This behavior can be disabled by setting the http.keepAlive system property to false before issuing any HTTP requests. The http.maxConnections property may be used to control how many idle connections to each server will be held.

By default, this implementation of HttpURLConnection requests that servers use gzip compression and it automatically decompresses the data for callers of getInputStream(). The Content-Encoding and Content-Length response headers are cleared in this case. Gzip compression can be disabled by setting the acceptable encodings in the request header:

   urlConnection.setRequestProperty("Accept-Encoding", "identity");

Setting the Accept-Encoding request header explicitly disables automatic decompression and leaves the response headers intact; callers must handle decompression as needed, according to the Content-Encoding header of the response.

getContentLength() returns the number of bytes transmitted and cannot be used to predict how many bytes can be read from getInputStream() for compressed streams. Instead, read that stream until it is exhausted, i.e. when read() returns -1.

Handling Network Sign-On

Some Wi-Fi networks block Internet access until the user clicks through a sign-on page. Such sign-on pages are typically presented by using HTTP redirects. You can use getURL() to test if your connection has been unexpectedly redirected. This check is not valid until after the response headers have been received, which you can trigger by calling getHeaderFields() or getInputStream(). For example, to check that a response was not redirected to an unexpected host:

   HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
   try {
     InputStream in = new BufferedInputStream(urlConnection.getInputStream());
     if (!url.getHost().equals(urlConnection.getURL().getHost())) {
       // we were redirected! Kick the user out to the browser to sign on?
     }
     ...
   } finally {
     urlConnection.disconnect();
   }

HTTP Authentication

HttpURLConnection supports HTTP basic authentication. Use Authenticator to set the VM-wide authentication handler:

   Authenticator.setDefault(new Authenticator() {
     protected PasswordAuthentication getPasswordAuthentication() {
       return new PasswordAuthentication(username, password.toCharArray());
     }
   });

Unless paired with HTTPS, this is not a secure mechanism for user authentication. In particular, the username, password, request and response are all transmitted over the network without encryption.

Sessions with Cookies

To establish and maintain a potentially long-lived session between client and server, HttpURLConnection includes an extensible cookie manager. Enable VM-wide cookie management using CookieHandler and CookieManager:

   CookieManager cookieManager = new CookieManager();
   CookieHandler.setDefault(cookieManager);

By default, CookieManager accepts cookies from the origin server only. Two other policies are included: ACCEPT_ALL and ACCEPT_NONE. Implement CookiePolicy to define a custom policy.

The default CookieManager keeps all accepted cookies in memory. It will forget these cookies when the VM exits. Implement CookieStore to define a custom cookie store.

In addition to the cookies set by HTTP responses, you may set cookies programmatically. To be included in HTTP request headers, cookies must have the domain and path properties set.

By default, new instances of HttpCookie work only with servers that support RFC 2965 cookies. Many web servers support only the older specification, RFC 2109. For compatibility with the most web servers, set the cookie version to 0.

For example, to receive www.twitter.com in French:

   HttpCookie cookie = new HttpCookie("lang", "fr");
   cookie.setDomain("twitter.com");
   cookie.setPath("/");
   cookie.setVersion(0);
   cookieManager.getCookieStore().add(new URI("http://twitter.com/"), cookie);

HTTP Methods

HttpURLConnection uses the GET method by default. It will use POST if setDoOutput(true) has been called. Other HTTP methods (OPTIONS, HEAD, PUT, DELETE and TRACE) can be used with setRequestMethod(String).

Proxies

By default, this class will connect directly to the origin server. It can also connect via an HTTP or SOCKS proxy. To use a proxy, use URL.openConnection(Proxy) when creating the connection.

IPv6 Support

This class includes transparent support for IPv6. For hosts with both IPv4 and IPv6 addresses, it will attempt to connect to each of a host's addresses until a connection is established.

Response Caching

Android 4.0 (Ice Cream Sandwich, API level 15) includes a response cache. See android.net.http.HttpResponseCache for instructions on enabling HTTP caching in your application.

Avoiding Bugs In Earlier Releases

Prior to Android 2.2 (Froyo), this class had some frustrating bugs. In particular, calling close() on a readable InputStream could poison the connection pool. Work around this by disabling connection pooling:

   private void disableConnectionReuseIfNecessary() {
   // Work around pre-Froyo bugs in HTTP connection reuse.
   if (Integer.parseInt(Build.VERSION.SDK) < Build.VERSION_CODES.FROYO) {
     System.setProperty("http.keepAlive", "false");
   }
 }

Each instance of HttpURLConnection may be used for one request/response pair. Instances of this class are not thread safe.

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 was deprecated in API level 1. 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 long`	`fixedContentLengthLong` 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.

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 `n`^th 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 `n`^th header field.
`boolean`	`getInstanceFollowRedirects()` Returns the value of this `HttpURLConnection`'s `instanceFollowRedirects` field.
`Permission`	`getPermission()` Returns a `SocketPermission` object representing the permission necessary to connect to the destination host and port.
`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.
`void`	`setFixedLengthStreamingMode(long 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.

Inherited methods

From class


  
    java.net.URLConnection

`void`	`addRequestProperty(String key, String value)` Adds a general request property specified by a key-value pair.
`abstract void`	`connect()` Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.
`boolean`	`getAllowUserInteraction()` Returns the value of the `allowUserInteraction` field for this object.
`int`	`getConnectTimeout()` Returns setting for connect timeout.
`Object`	`getContent()` Retrieves the contents of this URL connection.
`Object`	`getContent(Class[] classes)` Retrieves the contents of this URL connection.
`String`	`getContentEncoding()` Returns the value of the `content-encoding` header field.
`int`	`getContentLength()` Returns the value of the `content-length` header field.
`long`	`getContentLengthLong()` Returns the value of the `content-length` header field as a long.
`String`	`getContentType()` Returns the value of the `content-type` header field.
`long`	`getDate()` Returns the value of the `date` header field.
`static boolean`	`getDefaultAllowUserInteraction()` Returns the default value of the `allowUserInteraction` field.
`static String`	`getDefaultRequestProperty(String key)` This method was deprecated in API level 1. The instance specific getRequestProperty method should be used after an appropriate instance of URLConnection is obtained.
`boolean`	`getDefaultUseCaches()` Returns the default value of a `URLConnection`'s `useCaches` flag.
`boolean`	`getDoInput()` Returns the value of this `URLConnection`'s `doInput` flag.
`boolean`	`getDoOutput()` Returns the value of this `URLConnection`'s `doOutput` flag.
`long`	`getExpiration()` Returns the value of the `expires` header field.
`static FileNameMap`	`getFileNameMap()` Loads filename map (a mimetable) from a data file.
`String`	`getHeaderField(String name)` Returns the value of the named header field.
`String`	`getHeaderField(int n)` Returns the value for the `n`^th header field.
`long`	`getHeaderFieldDate(String name, long Default)` Returns the value of the named field parsed as date.
`int`	`getHeaderFieldInt(String name, int Default)` Returns the value of the named field parsed as a number.
`String`	`getHeaderFieldKey(int n)` Returns the key for the `n`^th header field.
`long`	`getHeaderFieldLong(String name, long Default)` Returns the value of the named field parsed as a number.
`Map<String, List<String>>`	`getHeaderFields()` Returns an unmodifiable Map of the header fields.
`long`	`getIfModifiedSince()` Returns the value of this object's `ifModifiedSince` field.
`InputStream`	`getInputStream()` Returns an input stream that reads from this open connection.
`long`	`getLastModified()` Returns the value of the `last-modified` header field.
`OutputStream`	`getOutputStream()` Returns an output stream that writes to this connection.
`Permission`	`getPermission()` Returns a permission object representing the permission necessary to make the connection represented by this object.
`int`	`getReadTimeout()` Returns setting for read timeout.
`Map<String, List<String>>`	`getRequestProperties()` Returns an unmodifiable Map of general request properties for this connection.
`String`	`getRequestProperty(String key)` Returns the value of the named general request property for this connection.
`URL`	`getURL()` Returns the value of this `URLConnection`'s `URL` field.
`boolean`	`getUseCaches()` Returns the value of this `URLConnection`'s `useCaches` field.
`static String`	`guessContentTypeFromName(String fname)` Tries to determine the content type of an object, based on the specified "file" component of a URL.
`static String`	`guessContentTypeFromStream(InputStream is)` Tries to determine the type of an input stream based on the characters at the beginning of the input stream.
`void`	`setAllowUserInteraction(boolean allowuserinteraction)` Set the value of the `allowUserInteraction` field of this `URLConnection`.
`void`	`setConnectTimeout(int timeout)` Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
`static void`	`setContentHandlerFactory(ContentHandlerFactory fac)` Sets the `ContentHandlerFactory` of an application.
`static void`	`setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)` Sets the default value of the `allowUserInteraction` field for all future `URLConnection` objects to the specified value.
`static void`	`setDefaultRequestProperty(String key, String value)` This method was deprecated in API level 1. The instance specific setRequestProperty method should be used after an appropriate instance of URLConnection is obtained. Invoking this method will have no effect.
`void`	`setDefaultUseCaches(boolean defaultusecaches)` Sets the default value of the `useCaches` field to the specified value.
`void`	`setDoInput(boolean doinput)` Sets the value of the `doInput` field for this `URLConnection` to the specified value.
`void`	`setDoOutput(boolean dooutput)` Sets the value of the `doOutput` field for this `URLConnection` to the specified value.
`static void`	`setFileNameMap(FileNameMap map)` Sets the FileNameMap.
`void`	`setIfModifiedSince(long ifmodifiedsince)` Sets the value of the `ifModifiedSince` field of this `URLConnection` to the specified value.
`void`	`setReadTimeout(int timeout)` Sets the read timeout to a specified timeout, in milliseconds.
`void`	`setRequestProperty(String key, String value)` Sets the general request property.
`void`	`setUseCaches(boolean usecaches)` Sets the value of the `useCaches` field of this `URLConnection` to the specified value.
`String`	`toString()` Returns a `String` representation of this URL connection.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

HTTP_ACCEPTED

Added in API level 1

int HTTP_ACCEPTED

HTTP Status-Code 202: Accepted.

Constant Value: 202 (0x000000ca)

HTTP_BAD_GATEWAY

Added in API level 1

int HTTP_BAD_GATEWAY

HTTP Status-Code 502: Bad Gateway.

Constant Value: 502 (0x000001f6)

HTTP_BAD_METHOD

Added in API level 1

int HTTP_BAD_METHOD

HTTP Status-Code 405: Method Not Allowed.

Constant Value: 405 (0x00000195)

HTTP_BAD_REQUEST

Added in API level 1

int HTTP_BAD_REQUEST

HTTP Status-Code 400: Bad Request.

Constant Value: 400 (0x00000190)

HTTP_CLIENT_TIMEOUT

Added in API level 1

int HTTP_CLIENT_TIMEOUT

HTTP Status-Code 408: Request Time-Out.

Constant Value: 408 (0x00000198)

HTTP_CONFLICT

Added in API level 1

int HTTP_CONFLICT

HTTP Status-Code 409: Conflict.

Constant Value: 409 (0x00000199)

HTTP_CREATED

Added in API level 1

int HTTP_CREATED

HTTP Status-Code 201: Created.

Constant Value: 201 (0x000000c9)

HTTP_ENTITY_TOO_LARGE

Added in API level 1

int HTTP_ENTITY_TOO_LARGE

HTTP Status-Code 413: Request Entity Too Large.

Constant Value: 413 (0x0000019d)

HTTP_FORBIDDEN

Added in API level 1

int HTTP_FORBIDDEN

HTTP Status-Code 403: Forbidden.

Constant Value: 403 (0x00000193)

HTTP_GATEWAY_TIMEOUT

Added in API level 1

int HTTP_GATEWAY_TIMEOUT

HTTP Status-Code 504: Gateway Timeout.

Constant Value: 504 (0x000001f8)

HTTP_GONE

Added in API level 1

int HTTP_GONE

HTTP Status-Code 410: Gone.

Constant Value: 410 (0x0000019a)

HTTP_INTERNAL_ERROR

Added in API level 1

int HTTP_INTERNAL_ERROR

HTTP Status-Code 500: Internal Server Error.

Constant Value: 500 (0x000001f4)

HTTP_LENGTH_REQUIRED

Added in API level 1

int HTTP_LENGTH_REQUIRED

HTTP Status-Code 411: Length Required.

Constant Value: 411 (0x0000019b)

HTTP_MOVED_PERM

Added in API level 1

int HTTP_MOVED_PERM

HTTP Status-Code 301: Moved Permanently.

Constant Value: 301 (0x0000012d)

HTTP_MOVED_TEMP

Added in API level 1

int HTTP_MOVED_TEMP

HTTP Status-Code 302: Temporary Redirect.

Constant Value: 302 (0x0000012e)

HTTP_MULT_CHOICE

Added in API level 1

int HTTP_MULT_CHOICE

HTTP Status-Code 300: Multiple Choices.

Constant Value: 300 (0x0000012c)

HTTP_NOT_ACCEPTABLE

Added in API level 1

int HTTP_NOT_ACCEPTABLE

HTTP Status-Code 406: Not Acceptable.

Constant Value: 406 (0x00000196)

HTTP_NOT_AUTHORITATIVE

Added in API level 1

int HTTP_NOT_AUTHORITATIVE

HTTP Status-Code 203: Non-Authoritative Information.

Constant Value: 203 (0x000000cb)

HTTP_NOT_FOUND

Added in API level 1

int HTTP_NOT_FOUND

HTTP Status-Code 404: Not Found.

Constant Value: 404 (0x00000194)

HTTP_NOT_IMPLEMENTED

Added in API level 1

int HTTP_NOT_IMPLEMENTED

HTTP Status-Code 501: Not Implemented.

Constant Value: 501 (0x000001f5)

HTTP_NOT_MODIFIED

Added in API level 1

int HTTP_NOT_MODIFIED

HTTP Status-Code 304: Not Modified.

Constant Value: 304 (0x00000130)

HTTP_NO_CONTENT

Added in API level 1

int HTTP_NO_CONTENT

HTTP Status-Code 204: No Content.

Constant Value: 204 (0x000000cc)

HTTP_OK

Added in API level 1

int HTTP_OK

HTTP Status-Code 200: OK.

Constant Value: 200 (0x000000c8)

HTTP_PARTIAL

Added in API level 1

int HTTP_PARTIAL

HTTP Status-Code 206: Partial Content.

Constant Value: 206 (0x000000ce)

HTTP_PAYMENT_REQUIRED

Added in API level 1

int HTTP_PAYMENT_REQUIRED

HTTP Status-Code 402: Payment Required.

Constant Value: 402 (0x00000192)

HTTP_PRECON_FAILED

Added in API level 1

int HTTP_PRECON_FAILED

HTTP Status-Code 412: Precondition Failed.

Constant Value: 412 (0x0000019c)

HTTP_PROXY_AUTH

Added in API level 1

int HTTP_PROXY_AUTH

HTTP Status-Code 407: Proxy Authentication Required.

Constant Value: 407 (0x00000197)

HTTP_REQ_TOO_LONG

Added in API level 1

int HTTP_REQ_TOO_LONG

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

Constant Value: 414 (0x0000019e)

HTTP_RESET

Added in API level 1

int HTTP_RESET

HTTP Status-Code 205: Reset Content.

Constant Value: 205 (0x000000cd)

HTTP_SEE_OTHER

Added in API level 1

int HTTP_SEE_OTHER

HTTP Status-Code 303: See Other.

Constant Value: 303 (0x0000012f)

HTTP_SERVER_ERROR

Added in API level 1

int HTTP_SERVER_ERROR

This constant was deprecated in API level 1.
it is misplaced and shouldn't have existed.

HTTP Status-Code 500: Internal Server Error.

Constant Value: 500 (0x000001f4)

HTTP_UNAUTHORIZED

Added in API level 1

int HTTP_UNAUTHORIZED

HTTP Status-Code 401: Unauthorized.

Constant Value: 401 (0x00000191)

HTTP_UNAVAILABLE

Added in API level 1

int HTTP_UNAVAILABLE

HTTP Status-Code 503: Service Unavailable.

Constant Value: 503 (0x000001f7)

HTTP_UNSUPPORTED_TYPE

Added in API level 1

int HTTP_UNSUPPORTED_TYPE

HTTP Status-Code 415: Unsupported Media Type.

Constant Value: 415 (0x0000019f)

HTTP_USE_PROXY

Added in API level 1

int HTTP_USE_PROXY

HTTP Status-Code 305: Use Proxy.

Constant Value: 305 (0x00000131)

HTTP_VERSION

Added in API level 1

int HTTP_VERSION

HTTP Status-Code 505: HTTP Version Not Supported.

Constant Value: 505 (0x000001f9)

Fields

chunkLength

Added in API level 1

int chunkLength

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

fixedContentLength

Added in API level 1

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.

NOTE: fixedContentLengthLong is recommended instead of this field, as it allows larger content lengths to be set.

fixedContentLengthLong

Added in API level 19

long fixedContentLengthLong

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

instanceFollowRedirects

Added in API level 1

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.

See also:

method

Added in API level 1

String method

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

responseCode

Added in API level 1

int responseCode

An int representing the three digit HTTP Status-Code.

1xx: Informational
2xx: Success
3xx: Redirection
4xx: Client Error
5xx: Server Error

responseMessage

Added in API level 1

String responseMessage

The HTTP response message.

Protected constructors

HttpURLConnection

Added in API level 1

HttpURLConnection (URL u)

Constructor for the HttpURLConnection.

Parameters
`u`	`URL`: the URL

Public methods

disconnect

Added in API level 1

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.

getErrorStream

Added in API level 1

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
`InputStream`	an error stream if any, null if there have been no errors, the connection is not connected or the server sent no useful data.

getFollowRedirects

Added in API level 1

boolean getFollowRedirects ()

Returns a boolean indicating whether or not HTTP redirects (3xx) should be automatically followed.

Returns
`boolean`	`true` if HTTP redirects should be automatically followed, `false` if not.

See also:

setFollowRedirects(boolean)

getHeaderField

Added in API level 1

String getHeaderField (int n)

Returns the value for the n^th header field. Some implementations may treat the 0^th 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`	`int`: an index, where n>=0.

Returns
`String`	the value of the `n`^th header field, or `null` if the value does not exist.

See also:

getHeaderFieldKey(int)

getHeaderFieldDate

Added in API level 1

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`	`String`: the name of the header field.
`Default`	`long`: a default value.

Returns
`long`	the value of the field, parsed as a date. The value of the `Default` argument is returned if the field is missing or malformed.

getHeaderFieldKey

Added in API level 1

String getHeaderFieldKey (int n)

Returns the key for the n^th header field. Some implementations may treat the 0^th 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`	`int`: an index, where n >=0.

Returns
`String`	the key for the `n`^th header field, or `null` if the key does not exist.

getInstanceFollowRedirects

Added in API level 1

boolean getInstanceFollowRedirects ()

Returns the value of this HttpURLConnection's instanceFollowRedirects field.

Returns
`boolean`	the value of this `HttpURLConnection`'s `instanceFollowRedirects` field.

See also:

getPermission

Added in API level 1

Permission getPermission ()

Returns a SocketPermission object representing the permission necessary to connect to the destination host and port.

Returns
`Permission`	a `SocketPermission` object representing the permission necessary to connect to the destination host and port.

Throws
`IOException`	if an error occurs while computing the permission.

getRequestMethod

Added in API level 1

String getRequestMethod ()

Get the request method.

Returns
`String`	the HTTP request method

See also:

setRequestMethod(java.lang.String)

getResponseCode

Added in API level 1

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
`int`	the HTTP Status-Code, or -1

Throws
`IOException`	if an error occurred connecting to the server.

getResponseMessage

Added in API level 1

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
`String`	the HTTP response message, or `null`

Throws
`IOException`	if an error occurred connecting to the server.

setChunkedStreamingMode

Added in API level 1

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`	`int`: 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.

See also:

setFixedLengthStreamingMode(int)

setFixedLengthStreamingMode

Added in API level 1

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.

This method must be called before the URLConnection is connected.

NOTE: setFixedLengthStreamingMode(long) is recommended instead of this method as it allows larger content lengths to be set.

Parameters
`contentLength`	`int`: 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.

See also:

setChunkedStreamingMode(int)

setFixedLengthStreamingMode

Added in API level 19

void setFixedLengthStreamingMode (long 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.

This method must be called before the URLConnection is connected.

The content length set by invoking this method takes precedence over any value set by setFixedLengthStreamingMode(int).

Parameters
`contentLength`	`long`: 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.

setFollowRedirects

Added in API level 1

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`	`boolean`: 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:

setInstanceFollowRedirects

Added in API level 1

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`	`boolean`: a `boolean` indicating whether or not to follow HTTP redirects.

See also:

setRequestMethod

Added in API level 1

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`	`String`: the HTTP method

Throws
`ProtocolException`	if the method cannot be reset or if the requested method isn't valid for HTTP.
`SecurityException`	if a security manager is set and the method is "TRACE", but the "allowHttpTrace" NetPermission is not granted.

See also:

getRequestMethod()

usingProxy

Added in API level 1

boolean usingProxy ()

Indicates if the connection is going through a proxy.

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