HttpURLConnection

Overview

Package

Class

Tree

Deprecated

Index

Help

Codase Click

search sample or example code,

search definition,

search google

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.net
Class HttpURLConnection

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

public abstract class HttpURLConnection
extends URLConnection
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
`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.
`static int`	`HTTP_ACCEPTED` HTTP Status-Code 202: Accepted.
`static int`	`HTTP_BAD_GATEWAY` HTTP Status-Code 502: Bad Gateway.
`static int`	`HTTP_BAD_METHOD` HTTP Status-Code 405: Method Not Allowed.
`static int`	`HTTP_BAD_REQUEST` HTTP Status-Code 400: Bad Request.
`static int`	`HTTP_CLIENT_TIMEOUT` HTTP Status-Code 408: Request Time-Out.
`static int`	`HTTP_CONFLICT` HTTP Status-Code 409: Conflict.
`static int`	`HTTP_CREATED` HTTP Status-Code 201: Created.
`static int`	`HTTP_ENTITY_TOO_LARGE` HTTP Status-Code 413: Request Entity Too Large.
`static int`	`HTTP_FORBIDDEN` HTTP Status-Code 403: Forbidden.
`static int`	`HTTP_GATEWAY_TIMEOUT` HTTP Status-Code 504: Gateway Timeout.
`static int`	`HTTP_GONE` HTTP Status-Code 410: Gone.
`static int`	`HTTP_INTERNAL_ERROR` HTTP Status-Code 500: Internal Server Error.
`static int`	`HTTP_LENGTH_REQUIRED` HTTP Status-Code 411: Length Required.
`static int`	`HTTP_MOVED_PERM` HTTP Status-Code 301: Moved Permanently.
`static int`	`HTTP_MOVED_TEMP` HTTP Status-Code 302: Temporary Redirect.
`static int`	`HTTP_MULT_CHOICE` HTTP Status-Code 300: Multiple Choices.
`static int`	`HTTP_NO_CONTENT` HTTP Status-Code 204: No Content.
`static int`	`HTTP_NOT_ACCEPTABLE` HTTP Status-Code 406: Not Acceptable.
`static int`	`HTTP_NOT_AUTHORITATIVE` HTTP Status-Code 203: Non-Authoritative Information.
`static int`	`HTTP_NOT_FOUND` HTTP Status-Code 404: Not Found.
`static int`	`HTTP_NOT_IMPLEMENTED` HTTP Status-Code 501: Not Implemented.
`static int`	`HTTP_NOT_MODIFIED` HTTP Status-Code 304: Not Modified.
`static int`	`HTTP_OK` HTTP Status-Code 200: OK.
`static int`	`HTTP_PARTIAL` HTTP Status-Code 206: Partial Content.
`static int`	`HTTP_PAYMENT_REQUIRED` HTTP Status-Code 402: Payment Required.
`static int`	`HTTP_PRECON_FAILED` HTTP Status-Code 412: Precondition Failed.
`static int`	`HTTP_PROXY_AUTH` HTTP Status-Code 407: Proxy Authentication Required.
`static int`	`HTTP_REQ_TOO_LONG` HTTP Status-Code 414: Request-URI Too Large.
`static int`	`HTTP_RESET` HTTP Status-Code 205: Reset Content.
`static int`	`HTTP_SEE_OTHER` HTTP Status-Code 303: See Other.
`static int`	`HTTP_SERVER_ERROR` Deprecated. it is misplaced and shouldn't have existed.
`static int`	`HTTP_UNAUTHORIZED` HTTP Status-Code 401: Unauthorized.
`static int`	`HTTP_UNAVAILABLE` HTTP Status-Code 503: Service Unavailable.
`static int`	`HTTP_UNSUPPORTED_TYPE` HTTP Status-Code 415: Unsupported Media Type.
`static int`	`HTTP_USE_PROXY` HTTP Status-Code 305: Use Proxy.
`static int`	`HTTP_VERSION` HTTP Status-Code 505: HTTP Version Not Supported.
`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.

Fields inherited from class java.net.URLConnection
`allowUserInteraction , connected , doInput , doOutput , ifModifiedSince , url , useCaches`

Constructor Summary
`protected`	`HttpURLConnection (URL u)` Constructor for the HttpURLConnection.

Method Summary
`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 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.

Methods inherited from class java.net.URLConnection
addRequestProperty , connect , getAllowUserInteraction , getConnectTimeout , getContent , getContent , getContentEncoding , getContentLength , getContentType , getDate , getDefaultAllowUserInteraction , getDefaultRequestProperty , getDefaultUseCaches , getDoInput , getDoOutput , getExpiration , getFileNameMap , getHeaderField , getHeaderFieldInt , getHeaderFields , getIfModifiedSince , getInputStream , getLastModified , getOutputStream , getReadTimeout , getRequestProperties , getRequestProperty , getURL , getUseCaches , guessContentTypeFromName , guessContentTypeFromStream , setAllowUserInteraction , setConnectTimeout , setContentHandlerFactory , setDefaultAllowUserInteraction , setDefaultRequestProperty , setDefaultUseCaches , setDoInput , setDoOutput , setFileNameMap , setIfModifiedSince , setReadTimeout , setRequestProperty , setUseCaches , toString

Methods inherited from class java.net.URLConnection

addRequestProperty   , connect   , getAllowUserInteraction   , getConnectTimeout   , getContent   , getContent   , getContentEncoding   , getContentLength   , getContentType   , getDate   , getDefaultAllowUserInteraction   , getDefaultRequestProperty   , getDefaultUseCaches   , getDoInput   , getDoOutput   , getExpiration   , getFileNameMap   , getHeaderField   , getHeaderFieldInt   , getHeaderFields   , getIfModifiedSince   , getInputStream   , getLastModified   , getOutputStream   , getReadTimeout   , getRequestProperties   , getRequestProperty   , getURL   , getUseCaches   , guessContentTypeFromName   , guessContentTypeFromStream   , setAllowUserInteraction   , setConnectTimeout   , setContentHandlerFactory   , setDefaultAllowUserInteraction   , setDefaultRequestProperty   , setDefaultUseCaches   , setDoInput   , setDoOutput   , setFileNameMap   , setIfModifiedSince   , setReadTimeout   , setRequestProperty   , setUseCaches   , toString

Methods inherited from class java.lang.Object
`clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait`

Field Detail

method

protected String    method

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

chunkLength

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.

fixedContentLength

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.

responseCode

protected int responseCode

An int representing the three digit HTTP Status-Code.

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

responseMessage

protected String    responseMessage

The HTTP response message.

instanceFollowRedirects

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.

See Also:: setInstanceFollowRedirects(boolean) , getInstanceFollowRedirects() , setFollowRedirects(boolean)