URLConnection is the superclass
of all classes that represent a communications link between the
application and a URL. Instances of this class can be used both to
read from and to write to the resource referenced by the URL. In
general, creating a connection to a URL is a multistep process:
openConnection() | connect() |
|---|---|
| Manipulate parameters that affect the connection to the remote resource. | Interact with the resource; query header fields and contents. |
openConnection method on a URL.
connect method.
The setup parameters are modified using the following methods:
setAllowUserInteraction
setDoInput
setDoOutput
setIfModifiedSince
setUseCaches
and the general request properties are modified using the method:
setRequestProperty
Default values for the AllowUserInteraction and
UseCaches parameters can be set using the methods
setDefaultAllowUserInteraction and
setDefaultUseCaches.
Each of the above set methods has a corresponding
get method to retrieve the value of the parameter or
general request property. The specific parameters and general
request properties that are applicable are protocol specific.
The following methods are used to access the header fields and the contents after the connection is made to the remote object:
getContent
getHeaderField
getInputStream
getOutputStream
Certain header fields are accessed frequently. The methods:
getContentEncoding
getContentLength
getContentType
getDate
getExpiration
getLastModifed
provide convenient access to these fields. The
getContentType method is used by the
getContent method to determine the type of the remote
object; subclasses may find it convenient to override the
getContentType method.
In the common case, all of the pre-connection parameters and
general request properties can be ignored: the pre-connection
parameters and request properties default to sensible values. For
most clients of this interface, there are only two interesting
methods: getInputStream and getContent,
which are mirrored in the URL class by convenience methods.
More information on the request properties and header fields of
an http connection can be found at:
http://www.ietf.org/rfc/rfc2616.txt
Note about fileNameMap: In versions prior to JDK 1.1.6,
field fileNameMap of URLConnection was public.
In JDK 1.1.6 and later, fileNameMap is private; accessor
and mutator methods getFileNameMap and
setFileNameMap are added
to access it. This change is also described on the
Compatibility page.
Invoking the close() methods on the InputStream or OutputStream of an
URLConnection after a request may free network resources associated with this
instance, unless particular protocol specifications specify different behaviours
for it.
URL.openConnection()connect()getContent()getContentEncoding()getContentLength()getContentType()getDate()getExpiration()getHeaderField(int)getHeaderField(java.lang.String)getInputStream()getLastModified()getOutputStream()setAllowUserInteraction(boolean)setDefaultUseCaches(boolean)setDoInput(boolean)setDoOutput(boolean)setIfModifiedSince(long)setRequestProperty(java.lang.String,java.lang.String)setUseCaches(boolean)setDoInput method. Its
value is returned by the getDoInput method.
A URL connection can be used for input and/or output. Setting the
doInput flag to true indicates that
the application intends to read data from the URL connection.
The default value of this field is true.
getDoInput()setDoInput(boolean)setDoOutput method. Its
value is returned by the getDoOutput method.
A URL connection can be used for input and/or output. Setting the
doOutput flag to true indicates
that the application intends to write data to the URL connection.
The default value of this field is false.
getDoOutput()setDoOutput(boolean)true, this URL is being examined in
a context in which it makes sense to allow user interactions such
as popping up an authentication dialog. If false,
then no user interaction is allowed.
The value of this field can be set by the
setAllowUserInteraction method.
Its value is returned by the
getAllowUserInteraction method.
Its default value is the value of the argument in the last invocation
of the setDefaultAllowUserInteraction method.
true, the protocol is allowed to use caching
whenever it can. If false, the protocol must always
try to get a fresh copy of the object.
This field is set by the setUseCaches method. Its
value is returned by the getUseCaches method.
Its default value is the value given in the last invocation of the
setDefaultUseCaches method.
A nonzero value gives a time as the number of milliseconds since January 1, 1970, GMT. The object is fetched only if it has been modified more recently than that time.
This variable is set by the setIfModifiedSince
method. Its value is returned by the
getIfModifiedSince method.
The default value of this field is 0, indicating
that the fetching must always occur.
setFileNameMap(java.net.FileNameMap)
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.
map the FileNameMap to be setjava.lang.SecurityException if a security manager exists and its
checkSetFactory method doesn't allow the operation.java.lang.SecurityManager.checkSetFactory()getFileNameMap()
If the connect method is called when the connection
has already been opened (indicated by the connected
field having the value true), the call is ignored.
URLConnection objects go through two phases: first they are created, then they are connected. After being created, and before being connected, various options can be specified (e.g., doInput and UseCaches). After connecting, it is an error to try to set them. Operations that depend on being connected, like getContentLength, will implicitly perform the connection, if necessary.
SocketTimeoutException if the timeout expires before
the connection can be establishedjava.io.IOException if an I/O error occurs while opening the
connection.connectedgetConnectTimeout()setConnectTimeout(int)Some non-standard implmentation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().
timeout an int that specifies the connect
timeout value in millisecondsjava.lang.IllegalArgumentException if the timeout parameter is negativegetConnectTimeout()connect()0 return implies that the option is disabled (i.e., timeout of infinity).
int that indicates the connect timeout
value in millisecondssetConnectTimeout(int)connect()Some non-standard implementation of this method ignores the specified timeout. To see the read timeout set, please call getReadTimeout().
timeout an int that specifies the timeout
value to be used in millisecondsjava.lang.IllegalArgumentException if the timeout parameter is negativegetReadTimeout()java.io.InputStream.read()int that indicates the read timeout
value in millisecondssetReadTimeout(int)java.io.InputStream.read()URLConnection's URL
field.
URLConnection's URL
field.urlcontent-type header field.
null if not known.getHeaderField(java.lang.String)content-encoding header field.
null if not known.getHeaderField(java.lang.String)expires header field.
getHeaderField(java.lang.String)date header field.
0 if not known. The value returned is the
number of milliseconds since January 1, 1970 GMT.getHeaderField(java.lang.String)last-modified header field.
The result is the number of milliseconds since January 1, 1970 GMT.
URLConnection was last modified, or 0 if not known.getHeaderField(java.lang.String)If called on a connection that sets the same header multiple times with possibly different values, only the last value is returned.
name the name of a header field.null
if there is no such field in the header.
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 the default value.Default value is returned if the field is
missing or malformed.
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.nth header field.
It returns null if there are fewer than
n+1fields.
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>=0nth header field
or null if there are fewer than n+1 fieldsgetHeaderFieldKey(int)
This method first determines the content type of the object by
calling the getContentType method. If this is
the first time that the application has seen that specific content
type, a content handler for that content type is created:
setContentHandlerFactory method, the
createContentHandler method of that instance is called
with the content type as an argument; the result is a content
handler for that content type.
createContentHandler method returns
null, then the application loads the class named:
sun.net.www.content.<contentType>
where <contentType> is formed by taking the
content-type string, replacing all slash characters with a
period ('.'), and all other non-alphanumeric characters
with the underscore character '_'. The alphanumeric
characters are specifically the 26 uppercase ASCII letters
'A' through 'Z', the 26 lowercase ASCII
letters 'a' through 'z', and the 10 ASCII
digits '0' through '9'. If the specified
class does not exist, or is not a subclass of
ContentHandler, then an
UnknownServiceException is thrown.
instanceof operator
should be used to determine the specific kind of object
returned.java.io.IOException if an I/O error occurs while
getting the content.UnknownServiceException if the protocol does not support
the content type.ContentHandlerFactory.createContentHandler(java.lang.String)getContentType()setContentHandlerFactory(java.net.ContentHandlerFactory)classes the Class array
indicating the requested typesinstanceof operator should be used to
determine the specific kind of object returned.java.io.IOException if an I/O error occurs while
getting the content.UnknownServiceException if the protocol does not support
the content type.getContent()ContentHandlerFactory.createContentHandler(java.lang.String)getContent(java.lang.Class[])setContentHandlerFactory(java.net.ContentHandlerFactory)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.
java.io.IOException if the computation of the permission
requires network or file I/O and an exception occurs while
computing it.java.io.IOException if an I/O error occurs while
creating the input stream.UnknownServiceException if the protocol does not support
input.setReadTimeout(int)getReadTimeout()java.io.IOException if an I/O error occurs while
creating the output stream.UnknownServiceException if the protocol does not support
output.doInput field for this
URLConnection to the specified value.
A URL connection can be used for input and/or output. Set the DoInput flag to true if you intend to use the URL connection for input, false if not. The default is true.
doinput the new value.java.lang.IllegalStateException if already connecteddoInputgetDoInput()URLConnection's
doInput flag.
URLConnection's
doInput flag.setDoInput(boolean)doOutput field for this
URLConnection to the specified value.
A URL connection can be used for input and/or output. Set the DoOutput flag to true if you intend to use the URL connection for output, false if not. The default is false.
dooutput the new value.java.lang.IllegalStateException if already connectedgetDoOutput()URLConnection's
doOutput flag.
URLConnection's
doOutput flag.setDoOutput(boolean)allowUserInteraction field of
this URLConnection.
allowuserinteraction the new value.java.lang.IllegalStateException if already connectedgetAllowUserInteraction()allowUserInteraction field for
this object.
allowUserInteraction field for
this object.setAllowUserInteraction(boolean)allowUserInteraction field for all future
URLConnection objects to the specified value.
defaultallowuserinteraction the new value.getDefaultAllowUserInteraction()allowUserInteraction
field.
Ths default is "sticky", being a part of the static state of all URLConnections. This flag applies to the next, and all following URLConnections that are created.
allowUserInteraction
field.setDefaultAllowUserInteraction(boolean)useCaches field of this
URLConnection to the specified value.
Some protocols do caching of documents. Occasionally, it is important to be able to "tunnel through" and ignore the caches (e.g., the "reload" button in a browser). If the UseCaches flag on a connection is true, the connection is allowed to use whatever caches it can. If false, caches are to be ignored. The default value comes from DefaultUseCaches, which defaults to true.
usecaches a boolean indicating whether
or not to allow cachingjava.lang.IllegalStateException if already connectedgetUseCaches()URLConnection's
useCaches field.
URLConnection's
useCaches field.setUseCaches(boolean)ifModifiedSince field of
this URLConnection to the specified value.
ifmodifiedsince the new value.java.lang.IllegalStateException if already connectedgetIfModifiedSince()ifModifiedSince field.
ifModifiedSince field.setIfModifiedSince(long)URLConnection's
useCaches flag.
Ths default is "sticky", being a part of the static state of all URLConnections. This flag applies to the next, and all following URLConnections that are created.
URLConnection's
useCaches flag.setDefaultUseCaches(boolean)useCaches field to the
specified value.
defaultusecaches the new value.getDefaultUseCaches()NOTE: HTTP requires all request properties which can legally have multiple instances with the same key to use a comma-seperated list syntax which enables multiple properties to be appended into a single property.
key the keyword by which the request is known
(e.g., "accept").value the value associated with it.java.lang.IllegalStateException if already connectedjava.lang.NullPointerException if key is nullgetRequestProperty(java.lang.String)key the keyword by which the request is known
(e.g., "accept").value the value associated with it.java.lang.IllegalStateException if already connectedjava.lang.NullPointerException if key is nullgetRequestProperties()key the keyword by which the request is known (e.g., "accept").java.lang.IllegalStateException if already connectedsetRequestProperty(java.lang.String,java.lang.String)java.lang.IllegalStateException if already connectedURLConnection is created, it is initialized with
these properties.
key the keyword by which the request is known
(e.g., "accept").value the value associated with the key.setRequestProperty(java.lang.String,java.lang.String)getDefaultRequestProperty(java.lang.String)key the keyword by which the request is known (e.g., "accept").getRequestProperty(java.lang.String)setDefaultRequestProperty(java.lang.String,java.lang.String)ContentHandlerFactory of an
application. It can be called at most once by an application.
The ContentHandlerFactory instance is used to
construct a content handler from a content type
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.
fac the desired factory.java.lang.Error if the factory has already been defined.java.lang.SecurityException if a security manager exists and its
checkSetFactory method doesn't allow the operation.ContentHandlerFactorygetContent()java.lang.SecurityManager.checkSetFactory()
{package-prefix}.{major}.{minor}
e.g.
YoyoDyne.experimental.text.plain
getContentType method.
fname a filename.getContentType()getContentType method.
Ideally, this routine would not be needed. But many
http servers return the incorrect content type; in
addition, there are many nonstandard extensions. Direct inspection
of the bytes to determine the content type is often more accurate
than believing the content type claimed by the http server.
is an input stream that supports marks.null if none
can be determined.java.io.IOException if an I/O error occurs while reading the
input stream.java.io.InputStream.mark(int)java.io.InputStream.markSupported()getContentType()