java.lang.Object | ||
↳ | java.net.URLConnection | |
↳ | java.net.HttpURLConnection |
![]() |
![]() |
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.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
chunkLength | The chunk-length when using chunked encoding streaming mode for output. | ||||||||||
fixedContentLength | The fixed content-length when using fixed-length streaming mode. | ||||||||||
instanceFollowRedirects | If true , the protocol will automatically follow redirects. |
||||||||||
method | The HTTP method (GET,POST,PUT,etc.). | ||||||||||
responseCode | An int representing the three digit HTTP Status-Code. |
||||||||||
responseMessage | The HTTP response message. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor for the HttpURLConnection.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Indicates that other requests to the server
are unlikely in the near future.
| |||||||||||
Returns the error stream if the connection failed
but the server sent useful data nonetheless.
| |||||||||||
Returns a
boolean indicating
whether or not HTTP redirects (3xx) should
be automatically followed. | |||||||||||
Returns the value for the
n th header field. | |||||||||||
Returns the value of the named field parsed as date.
| |||||||||||
Returns the key for the
n th header field. | |||||||||||
Returns the value of this
HttpURLConnection 's
instanceFollowRedirects field. | |||||||||||
Returns a permission object representing the permission
necessary to make the connection represented by this
object.
| |||||||||||
Get the request method.
| |||||||||||
Gets the status code from an HTTP response message.
| |||||||||||
Gets the HTTP response message, if any, returned along with the
response code from a server.
| |||||||||||
This method is used to enable streaming of a HTTP request body
without internal buffering, when the content length is not
known in advance.
| |||||||||||
This method is used to enable streaming of a HTTP request body
without internal buffering, when the content length is known in
advance.
| |||||||||||
Sets whether HTTP redirects (requests with response code 3xx) should
be automatically followed by this class.
| |||||||||||
Sets whether HTTP redirects (requests with response code 3xx) should
be automatically followed by this
HttpURLConnection
instance. | |||||||||||
Set the method for the URL request, one of:
| |||||||||||
Indicates if the connection is going through a proxy.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
HTTP Status-Code 202: Accepted.
HTTP Status-Code 502: Bad Gateway.
HTTP Status-Code 405: Method Not Allowed.
HTTP Status-Code 400: Bad Request.
HTTP Status-Code 408: Request Time-Out.
HTTP Status-Code 409: Conflict.
HTTP Status-Code 201: Created.
HTTP Status-Code 413: Request Entity Too Large.
HTTP Status-Code 403: Forbidden.
HTTP Status-Code 504: Gateway Timeout.
HTTP Status-Code 410: Gone.
HTTP Status-Code 500: Internal Server Error.
HTTP Status-Code 411: Length Required.
HTTP Status-Code 301: Moved Permanently.
HTTP Status-Code 302: Temporary Redirect.
HTTP Status-Code 300: Multiple Choices.
HTTP Status-Code 406: Not Acceptable.
HTTP Status-Code 203: Non-Authoritative Information.
HTTP Status-Code 404: Not Found.
HTTP Status-Code 501: Not Implemented.
HTTP Status-Code 304: Not Modified.
HTTP Status-Code 204: No Content.
HTTP Status-Code 200: OK.
HTTP Status-Code 206: Partial Content.
HTTP Status-Code 402: Payment Required.
HTTP Status-Code 412: Precondition Failed.
HTTP Status-Code 407: Proxy Authentication Required.
HTTP Status-Code 414: Request-URI Too Large.
HTTP Status-Code 205: Reset Content.
HTTP Status-Code 303: See Other.
This constant is deprecated.
it is misplaced and shouldn't have existed.
HTTP Status-Code 500: Internal Server Error.
HTTP Status-Code 401: Unauthorized.
HTTP Status-Code 503: Service Unavailable.
HTTP Status-Code 415: Unsupported Media Type.
HTTP Status-Code 305: Use Proxy.
HTTP Status-Code 505: HTTP Version Not Supported.
The chunk-length when using chunked encoding streaming mode for output.
A value of -1
means chunked encoding is disabled for output.
The fixed content-length when using fixed-length streaming mode.
A value of -1
means fixed-length streaming mode is disabled
for output.
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.
An int
representing the three digit HTTP Status-Code.
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.
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 a boolean
indicating
whether or not HTTP redirects (3xx) should
be automatically followed.
true
if HTTP redirects should
be automatically followed, false if not.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.
n | an index, where n>=0. |
---|
n
th header field,
or null
if the value does not exist.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.
name | the name of the header field. |
---|---|
Default | a default value. |
Default
argument is returned if the field is
missing or malformed.
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.
n | an index, where n >=0. |
---|
n
th header field,
or null
if the key does not exist.
Returns the value of this HttpURLConnection
's
instanceFollowRedirects
field.
HttpURLConnection
's
instanceFollowRedirects
field.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.
IOException |
---|
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 UnauthorizedIt 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).
IOException | if an error occurred connecting to the server. |
---|
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 FoundExtracts the Strings "OK" and "Not Found" respectively. Returns null if none could be discerned from the responses (the result was not valid HTTP).
null
IOException | if an error occurred connecting to the server. |
---|
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.
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. |
---|
IllegalStateException | if URLConnection is already connected or if a different streaming mode is already enabled. |
---|
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.
contentLength | The number of bytes which will be written to the OutputStream. |
---|
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. |
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.
set | a boolean indicating whether or not
to follow HTTP redirects. |
---|
SecurityException | if a security manager exists and its
checkSetFactory method doesn't
allow the operation. |
---|
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.
followRedirects | a boolean indicating
whether or not to follow HTTP redirects. |
---|
Set the method for the URL request, one of:
method | the HTTP method |
---|
ProtocolException | if the method cannot be reset or if the requested method isn't valid for HTTP. |
---|
Indicates if the connection is going through a proxy.