Overview Package Class Tree Deprecated Index Help Legend
PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
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

Untamed: 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:
java.net.HttpURLConnection#disconnect()

Field Summary
private static boolean followRedirects
static int HTTP_ACCEPTED
Enabled: HTTP Status-Code 202: Accepted.
static int HTTP_BAD_GATEWAY
Enabled: HTTP Status-Code 502: Bad Gateway.
static int HTTP_BAD_METHOD
Enabled: HTTP Status-Code 405: Method Not Allowed.
static int HTTP_BAD_REQUEST
Enabled: HTTP Status-Code 400: Bad Request.
static int HTTP_CLIENT_TIMEOUT
Enabled: HTTP Status-Code 408: Request Time-Out.
static int HTTP_CONFLICT
Enabled: HTTP Status-Code 409: Conflict.
static int HTTP_CREATED
Enabled: HTTP Status-Code 201: Created.
static int HTTP_ENTITY_TOO_LARGE
Enabled: HTTP Status-Code 413: Request Entity Too Large.
static int HTTP_FORBIDDEN
Enabled: HTTP Status-Code 403: Forbidden.
static int HTTP_GATEWAY_TIMEOUT
Enabled: HTTP Status-Code 504: Gateway Timeout.
static int HTTP_GONE
Enabled: HTTP Status-Code 410: Gone.
static int HTTP_INTERNAL_ERROR
Enabled: HTTP Status-Code 500: Internal Server Error.
static int HTTP_LENGTH_REQUIRED
Enabled: HTTP Status-Code 411: Length Required.
static int HTTP_MOVED_PERM
Enabled: HTTP Status-Code 301: Moved Permanently.
static int HTTP_MOVED_TEMP
Enabled: HTTP Status-Code 302: Temporary Redirect.
static int HTTP_MULT_CHOICE
Enabled: HTTP Status-Code 300: Multiple Choices.
static int HTTP_NO_CONTENT
Enabled: HTTP Status-Code 204: No Content.
static int HTTP_NOT_ACCEPTABLE
Enabled: HTTP Status-Code 406: Not Acceptable.
static int HTTP_NOT_AUTHORITATIVE
Enabled: HTTP Status-Code 203: Non-Authoritative Information.
static int HTTP_NOT_FOUND
Enabled: HTTP Status-Code 404: Not Found.
static int HTTP_NOT_IMPLEMENTED
Enabled: HTTP Status-Code 501: Not Implemented.
static int HTTP_NOT_MODIFIED
Enabled: HTTP Status-Code 304: Not Modified.
static int HTTP_OK
Enabled: HTTP Status-Code 200: OK.
static int HTTP_PARTIAL
Enabled: HTTP Status-Code 206: Partial Content.
static int HTTP_PAYMENT_REQUIRED
Enabled: HTTP Status-Code 402: Payment Required.
static int HTTP_PRECON_FAILED
Enabled: HTTP Status-Code 412: Precondition Failed.
static int HTTP_PROXY_AUTH
Enabled: HTTP Status-Code 407: Proxy Authentication Required.
static int HTTP_REQ_TOO_LONG
Enabled: HTTP Status-Code 414: Request-URI Too Large.
static int HTTP_RESET
Enabled: HTTP Status-Code 205: Reset Content.
static int HTTP_SEE_OTHER
Enabled: HTTP Status-Code 303: See Other.
static int HTTP_SERVER_ERROR
Deprecated. it is misplaced and shouldn't have existed.
static int HTTP_UNAUTHORIZED
Enabled: HTTP Status-Code 401: Unauthorized.
static int HTTP_UNAVAILABLE
Enabled: HTTP Status-Code 503: Service Unavailable.
static int HTTP_UNSUPPORTED_TYPE
Enabled: HTTP Status-Code 415: Unsupported Media Type.
static int HTTP_USE_PROXY
Enabled: HTTP Status-Code 305: Use Proxy.
static int HTTP_VERSION
Enabled: 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.).
private static String[] methods
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, factory, ifModifiedSince, url, useCaches
Constructor Summary
protected HttpURLConnection(URL u)
Constructor for the HttpURLConnection.
Method Summary
abstract void disconnect()
Enabled: Indicates that other requests to the server are unlikely in the near future.
InputStream getErrorStream()
Enabled: Returns the error stream if the connection failed but the server sent useful data nonetheless.
static boolean getFollowRedirects()
Enabled: Returns a boolean indicating whether or not HTTP redirects (3xx) should be automatically followed.
long getHeaderFieldDate(String name, long Default)
Enabled:
boolean getInstanceFollowRedirects()
Enabled: Returns the value of this HttpURLConnection's instanceFollowRedirects field.
Permission getPermission()
Enabled:
String getRequestMethod()
Enabled: Get the request method.
int getResponseCode()
Enabled: Gets the status code from an HTTP response message.
String getResponseMessage()
Enabled: Gets the HTTP response message, if any, returned along with the response code from a server.
static void setFollowRedirects(boolean set)
Enabled: Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this class.
void setInstanceFollowRedirects(boolean followRedirects)
Enabled: Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this HttpURLConnection instance.
void setRequestMethod(String method)
Enabled: 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()
Enabled: Indicates if the connection is going through a proxy.
Methods inherited from class java.net.URLConnection
addRequestProperty, connect, getAllowUserInteraction, getContent, getContent, getContentEncoding, getContentHandler, getContentLength, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldInt, getHeaderFieldKey, getHeaderFields, getIfModifiedSince, getInputStream, getLastModified, getOutputStream, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, 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.).

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.

followRedirects

private static boolean followRedirects

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:
java.net.HttpURLConnection#setInstanceFollowRedirects(boolean), java.net.HttpURLConnection#getInstanceFollowRedirects(), java.net.HttpURLConnection#setFollowRedirects(boolean)

methods

private static final String[] methods

HTTP_OK

public static final int HTTP_OK
Enabled: HTTP Status-Code 200: OK.

HTTP_CREATED

public static final int HTTP_CREATED
Enabled: HTTP Status-Code 201: Created.

HTTP_ACCEPTED

public static final int HTTP_ACCEPTED
Enabled: HTTP Status-Code 202: Accepted.

HTTP_NOT_AUTHORITATIVE

public static final int HTTP_NOT_AUTHORITATIVE
Enabled: HTTP Status-Code 203: Non-Authoritative Information.

HTTP_NO_CONTENT

public static final int HTTP_NO_CONTENT
Enabled: HTTP Status-Code 204: No Content.

HTTP_RESET

public static final int HTTP_RESET
Enabled: HTTP Status-Code 205: Reset Content.

HTTP_PARTIAL

public static final int HTTP_PARTIAL
Enabled: HTTP Status-Code 206: Partial Content.

HTTP_MULT_CHOICE

public static final int HTTP_MULT_CHOICE
Enabled: HTTP Status-Code 300: Multiple Choices.

HTTP_MOVED_PERM

public static final int HTTP_MOVED_PERM
Enabled: HTTP Status-Code 301: Moved Permanently.

HTTP_MOVED_TEMP

public static final int HTTP_MOVED_TEMP
Enabled: HTTP Status-Code 302: Temporary Redirect.

HTTP_SEE_OTHER

public static final int HTTP_SEE_OTHER
Enabled: HTTP Status-Code 303: See Other.

HTTP_NOT_MODIFIED

public static final int HTTP_NOT_MODIFIED
Enabled: HTTP Status-Code 304: Not Modified.

HTTP_USE_PROXY

public static final int HTTP_USE_PROXY
Enabled: HTTP Status-Code 305: Use Proxy.

HTTP_BAD_REQUEST

public static final int HTTP_BAD_REQUEST
Enabled: HTTP Status-Code 400: Bad Request.

HTTP_UNAUTHORIZED

public static final int HTTP_UNAUTHORIZED
Enabled: HTTP Status-Code 401: Unauthorized.

HTTP_PAYMENT_REQUIRED

public static final int HTTP_PAYMENT_REQUIRED
Enabled: HTTP Status-Code 402: Payment Required.

HTTP_FORBIDDEN

public static final int HTTP_FORBIDDEN
Enabled: HTTP Status-Code 403: Forbidden.

HTTP_NOT_FOUND

public static final int HTTP_NOT_FOUND
Enabled: HTTP Status-Code 404: Not Found.

HTTP_BAD_METHOD

public static final int HTTP_BAD_METHOD
Enabled: HTTP Status-Code 405: Method Not Allowed.

HTTP_NOT_ACCEPTABLE

public static final int HTTP_NOT_ACCEPTABLE
Enabled: HTTP Status-Code 406: Not Acceptable.

HTTP_PROXY_AUTH

public static final int HTTP_PROXY_AUTH
Enabled: HTTP Status-Code 407: Proxy Authentication Required.

HTTP_CLIENT_TIMEOUT

public static final int HTTP_CLIENT_TIMEOUT
Enabled: HTTP Status-Code 408: Request Time-Out.

HTTP_CONFLICT

public static final int HTTP_CONFLICT
Enabled: HTTP Status-Code 409: Conflict.

HTTP_GONE

public static final int HTTP_GONE
Enabled: HTTP Status-Code 410: Gone.

HTTP_LENGTH_REQUIRED

public static final int HTTP_LENGTH_REQUIRED
Enabled: HTTP Status-Code 411: Length Required.

HTTP_PRECON_FAILED

public static final int HTTP_PRECON_FAILED
Enabled: HTTP Status-Code 412: Precondition Failed.

HTTP_ENTITY_TOO_LARGE

public static final int HTTP_ENTITY_TOO_LARGE
Enabled: HTTP Status-Code 413: Request Entity Too Large.

HTTP_REQ_TOO_LONG

public static final int HTTP_REQ_TOO_LONG
Enabled: HTTP Status-Code 414: Request-URI Too Large.

HTTP_UNSUPPORTED_TYPE

public static final int HTTP_UNSUPPORTED_TYPE
Enabled: HTTP Status-Code 415: Unsupported Media Type.

HTTP_SERVER_ERROR

public static final int HTTP_SERVER_ERROR
Deprecated. it is misplaced and shouldn't have existed.

Enabled: HTTP Status-Code 500: Internal Server Error.

HTTP_INTERNAL_ERROR

public static final int HTTP_INTERNAL_ERROR
Enabled: HTTP Status-Code 500: Internal Server Error.

HTTP_NOT_IMPLEMENTED

public static final int HTTP_NOT_IMPLEMENTED
Enabled: HTTP Status-Code 501: Not Implemented.

HTTP_BAD_GATEWAY

public static final int HTTP_BAD_GATEWAY
Enabled: HTTP Status-Code 502: Bad Gateway.

HTTP_UNAVAILABLE

public static final int HTTP_UNAVAILABLE
Enabled: HTTP Status-Code 503: Service Unavailable.

HTTP_GATEWAY_TIMEOUT

public static final int HTTP_GATEWAY_TIMEOUT
Enabled: HTTP Status-Code 504: Gateway Timeout.

HTTP_VERSION

public static final int HTTP_VERSION
Enabled: HTTP Status-Code 505: HTTP Version Not Supported.

Constructor Detail

HttpURLConnection

protected HttpURLConnection(URL u)
Constructor for the HttpURLConnection.

Parameters:
u - the URL
Method Detail

setFollowRedirects

public static void setFollowRedirects(boolean set)
Enabled: 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.
See Also:
SecurityManager.checkSetFactory(), getFollowRedirects()

getFollowRedirects

public static boolean getFollowRedirects()
Enabled: 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.
See Also:
setFollowRedirects(boolean)

setInstanceFollowRedirects

public void setInstanceFollowRedirects(boolean followRedirects)
Enabled: 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.
See Also:
java.net.HttpURLConnection#instanceFollowRedirects, getInstanceFollowRedirects()

getInstanceFollowRedirects

public boolean getInstanceFollowRedirects()
Enabled: Returns the value of this HttpURLConnection's instanceFollowRedirects field.

Returns:
the value of this HttpURLConnection's instanceFollowRedirects field.
See Also:
java.net.HttpURLConnection#instanceFollowRedirects, setInstanceFollowRedirects(boolean)

setRequestMethod

public void setRequestMethod(String method)
 throws ProtocolException
Enabled: 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
ProtocolException
See Also:
getRequestMethod()

getRequestMethod

public String getRequestMethod()
Enabled: Get the request method.

Returns:
the HTTP request method
See Also:
setRequestMethod(java.lang.String)

getResponseCode

public int getResponseCode()
 throws IOException
Enabled: 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.

getResponseMessage

public String getResponseMessage()
 throws IOException
Enabled: 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.

getHeaderFieldDate

public long getHeaderFieldDate(String name,
 long Default)
Enabled:

Overrides:
getHeaderFieldDate in class URLConnection
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.

disconnect

public abstract void disconnect()
Enabled: 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.

usingProxy

public abstract boolean usingProxy()
Enabled: Indicates if the connection is going through a proxy.

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

getPermission

public Permission getPermission()
 throws IOException
Enabled:

Overrides:
getPermission in class URLConnection
Returns:
the permission object representing the permission necessary to make the connection represented by this URLConnection.
IOException

getErrorStream

public InputStream getErrorStream()
Enabled: 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.
Overview Package Class Tree Deprecated Index Help Legend
PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
comments?

AltStyle によって変換されたページ (->オリジナル) /