| public abstract class java.net URLConnection
|
Java SE 6 |
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:
Note abouthttp://www.ietf.org/rfc/rfc2068.txt
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.
| Fields | |||
|---|---|---|---|
| protected URL | url Details
| ||
| protected boolean | doInput Details
This variable is set by the setDoInput method. Its
value is returned by the getDoInput method.
A URL connection can be used for input and/or output. Setting the
The default value of this field is
| ||
| protected boolean | doOutput Details
This variable is set by the setDoOutput method. Its
value is returned by the getDoOutput method.
A URL connection can be used for input and/or output. Setting the
The default value of this field is
| ||
| protected boolean | allowUserInteraction Details
If 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
| ||
| protected boolean | useCaches Details
If 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
Its default value is the value given in the last invocation of the
| ||
| protected long | ifModifiedSince Details
Some protocols support skipping the fetching of the object unless
the object has been modified more recently than a certain time.
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
The default value of this field is
| ||
| protected boolean | connected If false, this connection object has not created a
communications link to the specified URL. If true,
the communications link has been established.
| ||
| Constructors | |||
|---|---|---|---|
| protected | URLConnection(URL url) Details
Constructs a URL connection to the specified URL. A connection to
the object referenced by the URL is not created.
| ||
| Methods | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | addRequestProperty(String key, String value) Details
Adds a general request property specified by a
key-value pair. This method will not overwrite
existing values associated with the same key.
| ||||||||||||
| abstract public void | connect() throws IOException Details
Opens a communications link to the resource referenced by this
URL, if such a connection has not already been established.
If the 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.
| ||||||||||||
| public static String | guessContentTypeFromName(String fname) Details
Tries to determine the content type of an object, based
on the specified "file" component of a URL.
This is a convenience method that can be used by
subclasses that override the getContentType method.
| ||||||||||||
| public static String | guessContentTypeFromStream(InputStream is) throws IOException Details
Tries to determine the type of an input stream based on the
characters at the beginning of the input stream. This method can
be used by subclasses that override the
getContentType method.
Ideally, this routine would not be needed. But many
| ||||||||||||
| public String | toString() Details
Returns a String representation of this URL connection.
| ||||||||||||
| Properties | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | setAllowUserInteraction(boolean allowuserinteraction) Details
Set the value of the allowUserInteraction field of
this URLConnection.
| ||||||||||||
| public boolean | getAllowUserInteraction() Details
Returns the value of the allowUserInteraction field for
this object.
| ||||||||||||
| public void | setConnectTimeout(int timeout) Details
Sets a specified timeout value, in milliseconds, to be used
when opening a communications link to the resource referenced
by this URLConnection. If the timeout expires before the
connection can be established, a
java.net.SocketTimeoutException is raised. A timeout of zero is
interpreted as an infinite timeout.
Some non-standard implmentation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().
| ||||||||||||
| public int | getConnectTimeout() Details
Returns setting for connect timeout.
0 return implies that the option is disabled (i.e., timeout of infinity).
| ||||||||||||
| public Object | getContent() throws IOException Details
Retrieves the contents of this URL connection.
This method first determines the content type of the object by
calling the
| ||||||||||||
| public Object | getContent(Class[] classes) throws IOException Details
Retrieves the contents of this URL connection.
| ||||||||||||
| public String | getContentEncoding() Details
Returns the value of the content-encoding header field.
| ||||||||||||
| public static void | setContentHandlerFactory(ContentHandlerFactory fac) Details
Sets the ContentHandlerFactory of an
application. It can be called at most once by an application.
The
If there is a security manager, this method first calls
the security manager's
| ||||||||||||
| public int | getContentLength() Details
Returns the value of the content-length header field.
| ||||||||||||
| public String | getContentType() Details
Returns the value of the content-type header field.
| ||||||||||||
| public long | getDate() Details
Returns the value of the date header field.
| ||||||||||||
| public static void | setDefaultAllowUserInteraction(boolean defaultallowuserinteraction) Details
Sets the default value of the
allowUserInteraction field for all future
URLConnection objects to the specified value.
| ||||||||||||
| public static boolean | getDefaultAllowUserInteraction() Details
Returns the default value of the 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.
| ||||||||||||
| public static void | Details
Sets the default value of a general request property. When a
URLConnection is created, it is initialized with
these properties.
| ||||||||||||
| public static String | getDefaultRequestProperty(String key) Details
Returns the value of the default request property. Default request
properties are set for every connection.
| ||||||||||||
| public void | setDefaultUseCaches(boolean defaultusecaches) Details
Sets the default value of the useCaches field to the
specified value.
| ||||||||||||
| public boolean | getDefaultUseCaches() Details
Returns the default value of a 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.
| ||||||||||||
| public void | setDoInput(boolean doinput) Details
Sets the value of the 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.
| ||||||||||||
| public boolean | getDoInput() Details
Returns the value of this URLConnection's
doInput flag.
| ||||||||||||
| public void | setDoOutput(boolean dooutput) Details
Sets the value of the 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.
| ||||||||||||
| public boolean | getDoOutput() Details
Returns the value of this URLConnection's
doOutput flag.
| ||||||||||||
| public long | getExpiration() Details
Returns the value of the expires header field.
| ||||||||||||
| public static void | setFileNameMap(FileNameMap map) Details
Sets the FileNameMap.
If there is a security manager, this method first calls
the security manager's
| ||||||||||||
| public static FileNameMap | getFileNameMap() Details
Loads filename map (a mimetable) from a data file. It will
first try to load the user-specific table, defined
by "content.types.user.table" property. If that fails,
it tries to load the default built-in table at
lib/content-types.properties under java home.
| ||||||||||||
| public String | getHeaderField(String name) Details
Returns the value of the named header field.
If called on a connection that sets the same header multiple times with possibly different values, only the last value is returned.
| ||||||||||||
| public String | getHeaderField(int n) Details
Returns the value for the nth header field.
It returns null if there are fewer than
n+1fields.
This method can be used in conjunction with the
| ||||||||||||
| public long | getHeaderFieldDate(String name, long Default) Details
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
| ||||||||||||
| public int | getHeaderFieldInt(String name, int Default) Details
Returns the value of the named field parsed as a number.
This form of
| ||||||||||||
| public String | getHeaderFieldKey(int n) Details
Returns the key for the nth header field.
It returns null if there are fewer than n+1 fields.
| ||||||||||||
| public Map | getHeaderFields() Details
Returns an unmodifiable Map of the header fields.
The Map keys are Strings that represent the
response-header field names. Each Map value is an
unmodifiable List of Strings that represents
the corresponding field values.
| ||||||||||||
| public void | setIfModifiedSince(long ifmodifiedsince) Details
Sets the value of the ifModifiedSince field of
this URLConnection to the specified value.
| ||||||||||||
| public long | getIfModifiedSince() Details
Returns the value of this object's ifModifiedSince field.
| ||||||||||||
| public InputStream | getInputStream() throws IOException Details
Returns an input stream that reads from this open connection.
A SocketTimeoutException can be thrown when reading from the
returned input stream if the read timeout expires before data
is available for read.
| ||||||||||||
| public long | getLastModified() Details
Returns the value of the last-modified header field.
The result is the number of milliseconds since January 1, 1970 GMT.
| ||||||||||||
| public OutputStream | getOutputStream() throws IOException Details
Returns an output stream that writes to this connection.
| ||||||||||||
| public Permission | getPermission() throws IOException Details
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.
| ||||||||||||
| public void | setReadTimeout(int timeout) Details
Sets the read timeout to a specified timeout, in
milliseconds. A non-zero value specifies the timeout when
reading from Input stream when a connection is established to a
resource. If the timeout expires before there is data available
for read, a java.net.SocketTimeoutException is raised. A
timeout of zero is interpreted as an infinite timeout.
Some non-standard implementation of this method ignores the specified timeout. To see the read timeout set, please call getReadTimeout().
| ||||||||||||
| public int | getReadTimeout() Details
Returns setting for read timeout. 0 return implies that the
option is disabled (i.e., timeout of infinity).
| ||||||||||||
| public Map | getRequestProperties() Details
Returns an unmodifiable Map of general request
properties for this connection. The Map keys
are Strings that represent the request-header
field names. Each Map value is a unmodifiable List
of Strings that represents the corresponding
field values.
| ||||||||||||
| public void | setRequestProperty(String key, String value) Details
Sets the general request property. If a property with the key already
exists, overwrite its value with the new value.
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.
| ||||||||||||
| public String | getRequestProperty(String key) Details
Returns the value of the named general request property for this
connection.
| ||||||||||||
| public URL | getURL() Details
Returns the value of this URLConnection's URL
field.
| ||||||||||||
| public void | setUseCaches(boolean usecaches) Details
Sets the value of the 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.
| ||||||||||||
| public boolean | getUseCaches() Details
Returns the value of this URLConnection's
useCaches field.
| ||||||||||||
| 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 |
![]() |
![]() |
|