public abstract class URLConnection extends Object
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:
Invoking thehttp://www.ietf.org/rfc/rfc2616.txt
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()
,
getHeaderField(int)
,
getHeaderField(java.lang.String)
,
getInputStream()
,
getOutputStream()
,
setAllowUserInteraction(boolean)
,
setDefaultUseCaches(boolean)
,
setDoInput(boolean)
,
setDoOutput(boolean)
,
setRequestProperty(java.lang.String, java.lang.String)
,
setUseCaches(boolean)
Modifier and Type | Field and Description |
---|---|
protected boolean |
allowUserInteraction
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. |
protected boolean |
connected
If
false , this connection object has not created a communications link to the specified URL. |
protected boolean |
doInput
This variable is set by the
setDoInput method. |
protected boolean |
doOutput
This variable is set by the
setDoOutput method. |
protected URL |
url
The URL represents the remote object on the World Wide Web to which this connection is opened.
|
protected boolean |
useCaches
If
true , the protocol is allowed to use caching whenever it can. |
Modifier | Constructor and Description |
---|---|
protected |
URLConnection(URL url)
Constructs a URL connection to the specified URL.
|
Modifier and Type | Method and Description |
---|---|
void |
addRequestProperty(String key,
String value)
Adds a general request property specified by a key-value pair.
|
abstract void |
connect()
Opens a communications link to the resource referenced by this URL, if such a connection has not already been
established.
|
boolean |
getAllowUserInteraction()
Returns the value of the
allowUserInteraction field for this object. |
int |
getConnectTimeout()
Returns setting for connect timeout.
|
Object |
getContent()
Retrieves the contents of this URL connection.
|
Object |
getContent(Class[] classes)
Retrieves the contents of this URL connection.
|
String |
getContentEncoding()
Returns the value of the
content-encoding header field. |
int |
getContentLength()
Returns the value of the
content-length header field. |
long |
getContentLengthLong()
Returns the value of the
content-length header field as a long. |
String |
getContentType()
Returns the value of the
content-type header field. |
static boolean |
getDefaultAllowUserInteraction()
Returns the default value of the
allowUserInteraction field. |
boolean |
getDefaultUseCaches()
Returns the default value of a
URLConnection 's useCaches flag. |
boolean |
getDoInput()
Returns the value of this
URLConnection 's doInput flag. |
boolean |
getDoOutput()
Returns the value of this
URLConnection 's doOutput flag. |
String |
getHeaderField(int n)
Returns the value for the
n th header field. |
String |
getHeaderField(String name)
Returns the value of the named header field.
|
int |
getHeaderFieldInt(String name,
int Default)
Returns the value of the named field parsed as a number.
|
String |
getHeaderFieldKey(int n)
Returns the key for the
n th header field. |
long |
getHeaderFieldLong(String name,
long Default)
Returns the value of the named field parsed as a number.
|
Map<String,List<String>> |
getHeaderFields()
Returns an unmodifiable Map of the header fields.
|
InputStream |
getInputStream()
Returns an input stream that reads from this open connection.
|
OutputStream |
getOutputStream()
Returns an output stream that writes to this connection.
|
int |
getReadTimeout()
Returns setting for read timeout.
|
Map<String,List<String>> |
getRequestProperties()
Returns an unmodifiable Map of general request properties for this connection.
|
String |
getRequestProperty(String key)
Returns the value of the named general request property for this connection.
|
URL |
getURL()
Returns the value of this
URLConnection 's URL field. |
boolean |
getUseCaches()
Returns the value of this
URLConnection 's useCaches field. |
void |
setAllowUserInteraction(boolean allowuserinteraction)
Set the value of the
allowUserInteraction field of this URLConnection . |
void |
setConnectTimeout(int timeout)
Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource
referenced by this URLConnection.
|
static void |
setContentHandlerFactory(ContentHandlerFactory fac)
Sets the
ContentHandlerFactory of an application. |
static void |
setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)
Sets the default value of the
allowUserInteraction field for all future URLConnection objects to
the specified value. |
void |
setDefaultUseCaches(boolean defaultusecaches)
Sets the default value of the
useCaches field to the specified value. |
void |
setDoInput(boolean doinput)
Sets the value of the
doInput field for this URLConnection to the specified value. |
void |
setDoOutput(boolean dooutput)
Sets the value of the
doOutput field for this URLConnection to the specified value. |
void |
setReadTimeout(int timeout)
Sets the read timeout to a specified timeout, in milliseconds.
|
void |
setRequestProperty(String key,
String value)
Sets the general request property.
|
void |
setUseCaches(boolean usecaches)
Sets the value of the
useCaches field of this URLConnection to the specified value. |
String |
toString()
Returns a
String representation of this URL connection. |
protected boolean allowUserInteraction
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.
protected boolean connected
false
, this connection object has not created a communications link to the specified URL. If
true
, the communications link has been established.protected boolean doInput
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)
protected boolean doOutput
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)
protected URL url
The value of this field can be accessed by the getURL
method.
The default value of this variable is the value of the URL argument in the URLConnection
constructor.
protected boolean useCaches
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.
protected URLConnection(URL url)
url
- the specified URL.public void addRequestProperty(String key, String value)
key
- the keyword by which the request is known (e.g., "Accept
").value
- the value associated with it.IllegalStateException
- if already connectedNullPointerException
- if key is nullgetRequestProperties()
public abstract void connect() throws IOException
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.
IOException
- if an I/O error occurs while opening the connection.connected
,
getConnectTimeout()
,
setConnectTimeout(int)
public boolean getAllowUserInteraction()
allowUserInteraction
field for this object.allowUserInteraction
field for this object.setAllowUserInteraction(boolean)
public int getConnectTimeout()
0 return implies that the option is disabled (i.e., timeout of infinity).
int
that indicates the connect timeout value in millisecondssetConnectTimeout(int)
,
connect()
public Object getContent() throws IOException
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: where <contentType> is formed by taking the content-type string, replacing all slash characters with asun.net.www.content.<contentType>
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.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)
@Nullable public Object getContent(Class[] classes) throws IOException
classes
- the Class
array indicating the requested typesinstanceof
operator should be used to determine the
specific kind of object returned.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)
@Nullable public String getContentEncoding()
content-encoding
header field.null
if not known.getHeaderField(java.lang.String)
public int getContentLength()
content-length
header field.
Note: getContentLengthLong()
should be preferred over this method, since
it returns a long
instead and is therefore more portable.
-1
if the content
length is not known, or if the content length is greater than Integer.MAX_VALUE.public long getContentLengthLong()
content-length
header field as a long.-1
if the content
length is not known.@Nullable public String getContentType()
content-type
header field.null
if not known.getHeaderField(java.lang.String)
public static boolean 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)
public boolean getDefaultUseCaches()
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)
public boolean getDoInput()
URLConnection
's doInput
flag.URLConnection
's doInput
flag.setDoInput(boolean)
public boolean getDoOutput()
URLConnection
's doOutput
flag.URLConnection
's doOutput
flag.setDoOutput(boolean)
@Nullable public String getHeaderField(int n)
n
th header field. It returns null
if there are fewer than
n+1
fields.
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 there are fewer than n+1
fieldsgetHeaderFieldKey(int)
@Nullable public String getHeaderField(String name)
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.public int getHeaderFieldInt(String name, int Default)
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.@Nullable public String getHeaderFieldKey(int n)
n
th header field. It returns null
if there are fewer than
n+1
fields.n
- an index, where n>=0
n
th header field, or null
if there are fewer than n+1
fields.public long getHeaderFieldLong(String name, long Default)
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.public Map<String,List<String>> getHeaderFields()
public InputStream getInputStream() throws IOException
IOException
- if an I/O error occurs while creating the input stream.UnknownServiceException
- if the protocol does not support input.setReadTimeout(int)
,
getReadTimeout()
public OutputStream getOutputStream() throws IOException
IOException
- if an I/O error occurs while creating the output stream.UnknownServiceException
- if the protocol does not support output.public int getReadTimeout()
int
that indicates the read timeout value in millisecondssetReadTimeout(int)
,
InputStream.read()
public Map<String,List<String>> getRequestProperties()
IllegalStateException
- if already connected@Nullable public String getRequestProperty(String key)
key
- the keyword by which the request is known (e.g., "Accept").IllegalStateException
- if already connectedsetRequestProperty(java.lang.String, java.lang.String)
public URL getURL()
URLConnection
's URL
field.URLConnection
's URL
field.url
public boolean getUseCaches()
URLConnection
's useCaches
field.URLConnection
's useCaches
field.setUseCaches(boolean)
public void setAllowUserInteraction(boolean allowuserinteraction)
allowUserInteraction
field of this URLConnection
.allowuserinteraction
- the new value.IllegalStateException
- if already connectedgetAllowUserInteraction()
public void setConnectTimeout(int timeout)
Some non-standard implementation 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 millisecondsIllegalArgumentException
- if the timeout parameter is negativegetConnectTimeout()
,
connect()
public static void setContentHandlerFactory(ContentHandlerFactory fac)
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.Error
- if the factory has already been defined.SecurityException
- if a security manager exists and its checkSetFactory
method doesn't allow the operation.ContentHandlerFactory
,
getContent()
public static void setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)
allowUserInteraction
field for all future URLConnection
objects to
the specified value.defaultallowuserinteraction
- the new value.getDefaultAllowUserInteraction()
public void setDefaultUseCaches(boolean defaultusecaches)
useCaches
field to the specified value.defaultusecaches
- the new value.getDefaultUseCaches()
public void setDoInput(boolean doinput)
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.IllegalStateException
- if already connecteddoInput
,
getDoInput()
public void setDoOutput(boolean dooutput)
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.IllegalStateException
- if already connectedgetDoOutput()
public void setReadTimeout(int timeout)
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 millisecondsIllegalArgumentException
- if the timeout parameter is negativegetReadTimeout()
,
InputStream.read()
public void setRequestProperty(String key, String value)
NOTE: HTTP requires all request properties which can legally have multiple instances with the same key to use a comma-separated 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.IllegalStateException
- if already connectedNullPointerException
- if key is null
getRequestProperty(java.lang.String)
public void setUseCaches(boolean usecaches)
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 cachingIllegalStateException
- if already connectedgetUseCaches()