| public abstract class java.net HttpURLConnection
|
Java SE 6 |
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() |
| Fields | |||
|---|---|---|---|
| protected String | method The HTTP method (GET,POST,PUT,etc.). | ||
| protected int | chunkLength Details
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 Details
The fixed content-length when using fixed-length streaming mode.
A value of -1 means fixed-length streaming mode is disabled
for output.
| ||
| protected int | responseCode An int representing the three digit HTTP Status-Code.
| ||
| protected String | responseMessage The HTTP response message. | ||
| protected boolean | instanceFollowRedirects Details
If true, the protocol will automatically follow redirects.
If false, the protocol will not automatically follow
redirects.
This field is set by the Its default value is based on the value of the static followRedirects at HttpURLConnection construction time.
| ||
| final public static int | HTTP_OK HTTP Status-Code 200: OK. | ||
| final public static int | HTTP_CREATED HTTP Status-Code 201: Created. | ||
| final public static int | HTTP_ACCEPTED HTTP Status-Code 202: Accepted. | ||
| final public static int | HTTP_NOT_AUTHORITATIVE HTTP Status-Code 203: Non-Authoritative Information. | ||
| final public static int | HTTP_NO_CONTENT HTTP Status-Code 204: No Content. | ||
| final public static int | HTTP_RESET HTTP Status-Code 205: Reset Content. | ||
| final public static int | HTTP_PARTIAL HTTP Status-Code 206: Partial Content. | ||
| final public static int | HTTP_MULT_CHOICE HTTP Status-Code 300: Multiple Choices. | ||
| final public static int | HTTP_MOVED_PERM HTTP Status-Code 301: Moved Permanently. | ||
| final public static int | HTTP_MOVED_TEMP HTTP Status-Code 302: Temporary Redirect. | ||
| final public static int | HTTP_SEE_OTHER HTTP Status-Code 303: See Other. | ||
| final public static int | HTTP_NOT_MODIFIED HTTP Status-Code 304: Not Modified. | ||
| final public static int | HTTP_USE_PROXY HTTP Status-Code 305: Use Proxy. | ||
| final public static int | HTTP_BAD_REQUEST HTTP Status-Code 400: Bad Request. | ||
| final public static int | HTTP_UNAUTHORIZED HTTP Status-Code 401: Unauthorized. | ||
| final public static int | HTTP_PAYMENT_REQUIRED HTTP Status-Code 402: Payment Required. | ||
| final public static int | HTTP_FORBIDDEN HTTP Status-Code 403: Forbidden. | ||
| final public static int | HTTP_NOT_FOUND HTTP Status-Code 404: Not Found. | ||
| final public static int | HTTP_BAD_METHOD HTTP Status-Code 405: Method Not Allowed. | ||
| final public static int | HTTP_NOT_ACCEPTABLE HTTP Status-Code 406: Not Acceptable. | ||
| final public static int | HTTP_PROXY_AUTH HTTP Status-Code 407: Proxy Authentication Required. | ||
| final public static int | HTTP_CLIENT_TIMEOUT HTTP Status-Code 408: Request Time-Out. | ||
| final public static int | HTTP_CONFLICT HTTP Status-Code 409: Conflict. | ||
| final public static int | HTTP_GONE HTTP Status-Code 410: Gone. | ||
| final public static int | HTTP_LENGTH_REQUIRED HTTP Status-Code 411: Length Required. | ||
| final public static int | HTTP_PRECON_FAILED HTTP Status-Code 412: Precondition Failed. | ||
| final public static int | HTTP_ENTITY_TOO_LARGE HTTP Status-Code 413: Request Entity Too Large. | ||
| final public static int | HTTP_REQ_TOO_LONG HTTP Status-Code 414: Request-URI Too Large. | ||
| final public static int | HTTP_UNSUPPORTED_TYPE HTTP Status-Code 415: Unsupported Media Type. | ||
| final public static int | HTTP_SERVER_ERROR Details
HTTP Status-Code 500: Internal Server Error.
| ||
| final public static int | HTTP_INTERNAL_ERROR HTTP Status-Code 500: Internal Server Error. | ||
| final public static int | HTTP_NOT_IMPLEMENTED HTTP Status-Code 501: Not Implemented. | ||
| final public static int | HTTP_BAD_GATEWAY HTTP Status-Code 502: Bad Gateway. | ||
| final public static int | HTTP_UNAVAILABLE HTTP Status-Code 503: Service Unavailable. | ||
| final public static int | HTTP_GATEWAY_TIMEOUT HTTP Status-Code 504: Gateway Timeout. | ||
| final public static int | HTTP_VERSION HTTP Status-Code 505: HTTP Version Not Supported. | ||
| Constructors | |||
|---|---|---|---|
| protected | HttpURLConnection(URL u) Details
Constructor for the HttpURLConnection.
| ||
| Methods | |||
|---|---|---|---|
| abstract public 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. | ||
| abstract public boolean | usingProxy() Details
Indicates if the connection is going through a proxy.
| ||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | setChunkedStreamingMode(int chunklen) Details
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.
| ||||||||||
| public InputStream | getErrorStream() Details
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.
| ||||||||||
| public void | setFixedLengthStreamingMode(int contentLength) Details
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.
| ||||||||||
| public static void | setFollowRedirects(boolean set) Details
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
| ||||||||||
| public static boolean | getFollowRedirects() Details
Returns a boolean indicating
whether or not HTTP redirects (3xx) should
be automatically followed.
| ||||||||||
| public String | getHeaderField(int n) Details
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
| ||||||||||
| public long | getHeaderFieldDate(String name, long Default) | ||||||||||
| public String | getHeaderFieldKey(int n) Details
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.
| ||||||||||
| public void | setInstanceFollowRedirects(boolean followRedirects) Details
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.
| ||||||||||
| public boolean | getInstanceFollowRedirects() Details
Returns the value of this HttpURLConnection's
instanceFollowRedirects field.
| ||||||||||
| public Permission | getPermission() throws IOException | ||||||||||
| public void | setRequestMethod(String method) throws ProtocolException Details
Set the method for the URL request, one of:
| ||||||||||
| public String | getRequestMethod() Details
Get the request method.
| ||||||||||
| public int | getResponseCode() throws IOException Details
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).
| ||||||||||
| public String | getResponseMessage() throws IOException Details
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).
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|