Class URLConnection
- java.lang.Object
-
- java.net.URLConnection
-
- Direct Known Subclasses:
HttpURLConnection
public abstract class URLConnection extends Object
The abstract classURLConnectionis 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.
time- The connection object is created by invoking the
openConnectionmethod on a URL. - The setup parameters and general request properties are manipulated.
- The actual connection to the remote object is made, using the
connectmethod. - The remote object becomes available. The header fields and the contents of the remote object can be accessed.
The setup parameters are modified using the following methods:
setAllowUserInteractionsetDoInputsetDoOutputsetIfModifiedSincesetUseCaches
and the general request properties are modified using the method:
setRequestProperty
Default values for the
AllowUserInteractionandUseCachesparameters can be set using the methodssetDefaultAllowUserInteractionandsetDefaultUseCaches.Each of the above
setmethods has a correspondinggetmethod 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:
getContentgetHeaderFieldgetInputStreamgetOutputStream
Certain header fields are accessed frequently. The methods:
getContentEncodinggetContentLengthgetContentTypegetDategetExpirationgetLastModifed
provide convenient access to these fields. The
getContentTypemethod is used by thegetContentmethod to determine the type of the remote object; subclasses may find it convenient to override thegetContentTypemethod.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:
getInputStreamandgetContent, which are mirrored in theURLclass by convenience methods.More information on the request properties and header fields of an
httpconnection can be found at:
Invoking thehttp://www.ietf.org/rfc/rfc2616.txt
close()methods on theInputStreamorOutputStreamof anURLConnectionafter a request may free network resources associated with this instance, unless particular protocol specifications specify different behaviours for it.- Since:
- JDK1.0
- See Also:
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)
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanallowUserInteractionIftrue, thisURLis being examined in a context in which it makes sense to allow user interactions such as popping up an authentication dialog.protected booleanconnectedIffalse, this connection object has not created a communications link to the specified URL.protected booleandoInputThis variable is set by thesetDoInputmethod.protected booleandoOutputThis variable is set by thesetDoOutputmethod.protected URLurlThe URL represents the remote object on the World Wide Web to which this connection is opened.protected booleanuseCachesIftrue, the protocol is allowed to use caching whenever it can.
-
Constructor Summary
Constructors Modifier Constructor Description protectedURLConnection(URL url)Constructs a URL connection to the specified URL.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddRequestProperty(String key, String value)Adds a general request property specified by a key-value pair.abstract voidconnect()Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.booleangetAllowUserInteraction()Returns the value of theallowUserInteractionfield for this object.intgetConnectTimeout()Returns setting for connect timeout.ObjectgetContent()Retrieves the contents of this URL connection.ObjectgetContent(Class[] classes)Retrieves the contents of this URL connection.StringgetContentEncoding()Returns the value of thecontent-encodingheader field.intgetContentLength()Returns the value of thecontent-lengthheader field.longgetContentLengthLong()Returns the value of thecontent-lengthheader field as a long.StringgetContentType()Returns the value of thecontent-typeheader field.static booleangetDefaultAllowUserInteraction()Returns the default value of theallowUserInteractionfield.booleangetDefaultUseCaches()Returns the default value of aURLConnection'suseCachesflag.booleangetDoInput()Returns the value of thisURLConnection'sdoInputflag.booleangetDoOutput()Returns the value of thisURLConnection'sdoOutputflag.StringgetHeaderField(int n)Returns the value for thenth header field.StringgetHeaderField(String name)Returns the value of the named header field.intgetHeaderFieldInt(String name, int Default)Returns the value of the named field parsed as a number.StringgetHeaderFieldKey(int n)Returns the key for thenth header field.longgetHeaderFieldLong(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.InputStreamgetInputStream()Returns an input stream that reads from this open connection.OutputStreamgetOutputStream()Returns an output stream that writes to this connection.intgetReadTimeout()Returns setting for read timeout.Map<String,List<String>>getRequestProperties()Returns an unmodifiable Map of general request properties for this connection.StringgetRequestProperty(String key)Returns the value of the named general request property for this connection.URLgetURL()Returns the value of thisURLConnection'sURLfield.booleangetUseCaches()Returns the value of thisURLConnection'suseCachesfield.voidsetAllowUserInteraction(boolean allowuserinteraction)Set the value of theallowUserInteractionfield of thisURLConnection.voidsetConnectTimeout(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 voidsetContentHandlerFactory(ContentHandlerFactory fac)Sets theContentHandlerFactoryof an application.static voidsetDefaultAllowUserInteraction(boolean defaultallowuserinteraction)Sets the default value of theallowUserInteractionfield for all futureURLConnectionobjects to the specified value.voidsetDefaultUseCaches(boolean defaultusecaches)Sets the default value of theuseCachesfield to the specified value.voidsetDoInput(boolean doinput)Sets the value of thedoInputfield for thisURLConnectionto the specified value.voidsetDoOutput(boolean dooutput)Sets the value of thedoOutputfield for thisURLConnectionto the specified value.voidsetReadTimeout(int timeout)Sets the read timeout to a specified timeout, in milliseconds.voidsetRequestProperty(String key, String value)Sets the general request property.voidsetUseCaches(boolean usecaches)Sets the value of theuseCachesfield of thisURLConnectionto the specified value.StringtoString()Returns aStringrepresentation of this URL connection.
-
-
-
Field Detail
-
url
protected URL url
The URL represents the remote object on the World Wide Web to which this connection is opened.The value of this field can be accessed by the
getURLmethod.The default value of this variable is the value of the URL argument in the
URLConnectionconstructor.
-
doInput
protected boolean doInput
This variable is set by thesetDoInputmethod. Its value is returned by thegetDoInputmethod.A URL connection can be used for input and/or output. Setting the
doInputflag totrueindicates that the application intends to read data from the URL connection.The default value of this field is
true.- See Also:
getDoInput(),setDoInput(boolean)
-
doOutput
protected boolean doOutput
This variable is set by thesetDoOutputmethod. Its value is returned by thegetDoOutputmethod.A URL connection can be used for input and/or output. Setting the
doOutputflag totrueindicates that the application intends to write data to the URL connection.The default value of this field is
false.- See Also:
getDoOutput(),setDoOutput(boolean)
-
allowUserInteraction
protected boolean allowUserInteraction
Iftrue, thisURLis being examined in a context in which it makes sense to allow user interactions such as popping up an authentication dialog. Iffalse, then no user interaction is allowed.The value of this field can be set by the
setAllowUserInteractionmethod. Its value is returned by thegetAllowUserInteractionmethod. Its default value is the value of the argument in the last invocation of thesetDefaultAllowUserInteractionmethod.
-
useCaches
protected boolean useCaches
Iftrue, the protocol is allowed to use caching whenever it can. Iffalse, the protocol must always try to get a fresh copy of the object.This field is set by the
setUseCachesmethod. Its value is returned by thegetUseCachesmethod.Its default value is the value given in the last invocation of the
setDefaultUseCachesmethod.
-
connected
protected boolean connected
Iffalse, this connection object has not created a communications link to the specified URL. Iftrue, the communications link has been established.
-
-
Constructor Detail
-
URLConnection
protected URLConnection(URL url)
Constructs a URL connection to the specified URL. A connection to the object referenced by the URL is not created.- Parameters:
url- the specified URL.
-
-
Method Detail
-
connect
public abstract void connect() throws IOExceptionOpens a communications link to the resource referenced by this URL, if such a connection has not already been established.If the
connectmethod is called when the connection has already been opened (indicated by theconnectedfield having the valuetrue), 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.
- Throws:
IOException- if an I/O error occurs while opening the connection.- See Also:
connected,getConnectTimeout(),setConnectTimeout(int)
-
setConnectTimeout
public 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. 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 implementation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().
- Parameters:
timeout- anintthat specifies the connect timeout value in milliseconds- Throws:
IllegalArgumentException- if the timeout parameter is negative- Since:
- 1.5
- See Also:
getConnectTimeout(),connect()
-
getConnectTimeout
public int getConnectTimeout()
Returns setting for connect timeout.0 return implies that the option is disabled (i.e., timeout of infinity).
- Returns:
- an
intthat indicates the connect timeout value in milliseconds - Since:
- 1.5
- See Also:
setConnectTimeout(int),connect()
-
setReadTimeout
public void setReadTimeout(int timeout)
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().
- Parameters:
timeout- anintthat specifies the timeout value to be used in milliseconds- Throws:
IllegalArgumentException- if the timeout parameter is negative- Since:
- 1.5
- See Also:
getReadTimeout(),InputStream.read()
-
getReadTimeout
public int getReadTimeout()
Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).- Returns:
- an
intthat indicates the read timeout value in milliseconds - Since:
- 1.5
- See Also:
setReadTimeout(int),InputStream.read()
-
getURL
public URL getURL()
Returns the value of thisURLConnection'sURLfield.- Returns:
- the value of this
URLConnection'sURLfield. - See Also:
url
-
getContentLength
public int getContentLength()
Returns the value of thecontent-lengthheader field.Note:
getContentLengthLong()should be preferred over this method, since it returns alonginstead and is therefore more portable.- Returns:
- the content length of the resource that this connection's URL references,
-1if the content length is not known, or if the content length is greater than Integer.MAX_VALUE.
-
getContentLengthLong
public long getContentLengthLong()
Returns the value of thecontent-lengthheader field as a long.- Returns:
- the content length of the resource that this connection's URL references, or
-1if the content length is not known. - Since:
- 7.0
-
getContentType
@Nullable public String getContentType()
Returns the value of thecontent-typeheader field.- Returns:
- the content type of the resource that the URL references, or
nullif not known. - See Also:
getHeaderField(java.lang.String)
-
getContentEncoding
@Nullable public String getContentEncoding()
Returns the value of thecontent-encodingheader field.- Returns:
- the content encoding of the resource that the URL references, or
nullif not known. - See Also:
getHeaderField(java.lang.String)
-
getHeaderField
@Nullable public String getHeaderField(String name)
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.
- Parameters:
name- the name of a header field.- Returns:
- the value of the named header field, or
nullif there is no such field in the header.
-
getHeaderFields
public Map<String,List<String>> getHeaderFields()
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.- Returns:
- a Map of header fields
- Since:
- 1.4
-
getHeaderFieldInt
public int getHeaderFieldInt(String name, int Default)
Returns the value of the named field parsed as a number.This form of
getHeaderFieldexists 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.- Parameters:
name- the name of the header field.Default- the default value.- Returns:
- the value of the named field, parsed as an integer. The
Defaultvalue is returned if the field is missing or malformed.
-
getHeaderFieldLong
public long getHeaderFieldLong(String name, long Default)
Returns the value of the named field parsed as a number.This form of
getHeaderFieldexists 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.- Parameters:
name- the name of the header field.Default- the default value.- Returns:
- the value of the named field, parsed as a long. The
Defaultvalue is returned if the field is missing or malformed. - Since:
- 7.0
-
getHeaderFieldKey
@Nullable public String getHeaderFieldKey(int n)
Returns the key for thenth header field. It returnsnullif there are fewer thann+1fields.- Parameters:
n- an index, wheren>=0- Returns:
- the key for the
nth header field, ornullif there are fewer thann+1fields.
-
getHeaderField
@Nullable public String getHeaderField(int n)
Returns the value for thenth header field. It returnsnullif there are fewer thann+1fields.This method can be used in conjunction with the
getHeaderFieldKeymethod to iterate through all the headers in the message.- Parameters:
n- an index, wheren>=0- Returns:
- the value of the
nth header field ornullif there are fewer thann+1fields - See Also:
getHeaderFieldKey(int)
-
getContent
public Object getContent() throws IOException
Retrieves the contents of this URL connection.This method first determines the content type of the object by calling the
getContentTypemethod. If this is the first time that the application has seen that specific content type, a content handler for that content type is created:- If the application has set up a content handler factory instance using the
setContentHandlerFactorymethod, thecreateContentHandlermethod of that instance is called with the content type as an argument; the result is a content handler for that content type. - If no content handler factory has yet been set up, or if the factory's
createContentHandlermethod returnsnull, 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 ofContentHandler, then anUnknownServiceExceptionis thrown.
- Returns:
- the object fetched. The
instanceofoperator should be used to determine the specific kind of object returned. - Throws:
IOException- if an I/O error occurs while getting the content.UnknownServiceException- if the protocol does not support the content type.- See Also:
ContentHandlerFactory.createContentHandler(java.lang.String),getContentType(),setContentHandlerFactory(java.net.ContentHandlerFactory)
- If the application has set up a content handler factory instance using the
-
getContent
@Nullable public Object getContent(Class[] classes) throws IOException
Retrieves the contents of this URL connection.- Parameters:
classes- theClassarray indicating the requested types- Returns:
- the object fetched that is the first match of the type specified in the classes array. null if none of
the requested types are supported. The
instanceofoperator should be used to determine the specific kind of object returned. - Throws:
IOException- if an I/O error occurs while getting the content.UnknownServiceException- if the protocol does not support the content type.- Since:
- 1.3
- See Also:
getContent(),ContentHandlerFactory.createContentHandler(java.lang.String),getContent(java.lang.Class[]),setContentHandlerFactory(java.net.ContentHandlerFactory)
-
getInputStream
public InputStream getInputStream() throws IOException
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.- Returns:
- an input stream that reads from this open connection.
- Throws:
IOException- if an I/O error occurs while creating the input stream.UnknownServiceException- if the protocol does not support input.- See Also:
setReadTimeout(int),getReadTimeout()
-
getOutputStream
public OutputStream getOutputStream() throws IOException
Returns an output stream that writes to this connection.- Returns:
- an output stream that writes to this connection.
- Throws:
IOException- if an I/O error occurs while creating the output stream.UnknownServiceException- if the protocol does not support output.
-
toString
public String toString()
Returns aStringrepresentation of this URL connection.
-
setDoInput
public void setDoInput(boolean doinput)
Sets the value of thedoInputfield for thisURLConnectionto 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.
- Parameters:
doinput- the new value.- Throws:
IllegalStateException- if already connected- See Also:
doInput,getDoInput()
-
getDoInput
public boolean getDoInput()
Returns the value of thisURLConnection'sdoInputflag.- Returns:
- the value of this
URLConnection'sdoInputflag. - See Also:
setDoInput(boolean)
-
setDoOutput
public void setDoOutput(boolean dooutput)
Sets the value of thedoOutputfield for thisURLConnectionto 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.
- Parameters:
dooutput- the new value.- Throws:
IllegalStateException- if already connected- See Also:
getDoOutput()
-
getDoOutput
public boolean getDoOutput()
Returns the value of thisURLConnection'sdoOutputflag.- Returns:
- the value of this
URLConnection'sdoOutputflag. - See Also:
setDoOutput(boolean)
-
setAllowUserInteraction
public void setAllowUserInteraction(boolean allowuserinteraction)
Set the value of theallowUserInteractionfield of thisURLConnection.- Parameters:
allowuserinteraction- the new value.- Throws:
IllegalStateException- if already connected- See Also:
getAllowUserInteraction()
-
getAllowUserInteraction
public boolean getAllowUserInteraction()
Returns the value of theallowUserInteractionfield for this object.- Returns:
- the value of the
allowUserInteractionfield for this object. - See Also:
setAllowUserInteraction(boolean)
-
setDefaultAllowUserInteraction
public static void setDefaultAllowUserInteraction(boolean defaultallowuserinteraction)
Sets the default value of theallowUserInteractionfield for all futureURLConnectionobjects to the specified value.- Parameters:
defaultallowuserinteraction- the new value.- See Also:
getDefaultAllowUserInteraction()
-
getDefaultAllowUserInteraction
public static boolean getDefaultAllowUserInteraction()
Returns the default value of theallowUserInteractionfield.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.
- Returns:
- the default value of the
allowUserInteractionfield. - See Also:
setDefaultAllowUserInteraction(boolean)
-
setUseCaches
public void setUseCaches(boolean usecaches)
Sets the value of theuseCachesfield of thisURLConnectionto 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.
- Parameters:
usecaches- abooleanindicating whether or not to allow caching- Throws:
IllegalStateException- if already connected- See Also:
getUseCaches()
-
getUseCaches
public boolean getUseCaches()
Returns the value of thisURLConnection'suseCachesfield.- Returns:
- the value of this
URLConnection'suseCachesfield. - See Also:
setUseCaches(boolean)
-
getDefaultUseCaches
public boolean getDefaultUseCaches()
Returns the default value of aURLConnection'suseCachesflag.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.
- Returns:
- the default value of a
URLConnection'suseCachesflag. - See Also:
setDefaultUseCaches(boolean)
-
setDefaultUseCaches
public void setDefaultUseCaches(boolean defaultusecaches)
Sets the default value of theuseCachesfield to the specified value.- Parameters:
defaultusecaches- the new value.- See Also:
getDefaultUseCaches()
-
setRequestProperty
public void setRequestProperty(String key, String value)
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-separated list syntax which enables multiple properties to be appended into a single property.
- Parameters:
key- the keyword by which the request is known (e.g., "Accept").value- the value associated with it.- Throws:
IllegalStateException- if already connectedNullPointerException- if key isnull- See Also:
getRequestProperty(java.lang.String)
-
addRequestProperty
public void addRequestProperty(String key, String value)
Adds a general request property specified by a key-value pair. This method will not overwrite existing values associated with the same key.- Parameters:
key- the keyword by which the request is known (e.g., "Accept").value- the value associated with it.- Throws:
IllegalStateException- if already connectedNullPointerException- if key is null- Since:
- 1.4
- See Also:
getRequestProperties()
-
getRequestProperty
@Nullable public String getRequestProperty(String key)
Returns the value of the named general request property for this connection.- Parameters:
key- the keyword by which the request is known (e.g., "Accept").- Returns:
- the value of the named general request property for this connection. If key is null, then null is returned.
- Throws:
IllegalStateException- if already connected- See Also:
setRequestProperty(java.lang.String, java.lang.String)
-
getRequestProperties
public Map<String,List<String>> getRequestProperties()
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.- Returns:
- a Map of the general request properties for this connection.
- Throws:
IllegalStateException- if already connected- Since:
- 1.4
-
setContentHandlerFactory
public static void setContentHandlerFactory(ContentHandlerFactory fac)
Sets theContentHandlerFactoryof an application. It can be called at most once by an application.The
ContentHandlerFactoryinstance is used to construct a content handler from a content typeIf there is a security manager, this method first calls the security manager's
checkSetFactorymethod to ensure the operation is allowed. This could result in a SecurityException.- Parameters:
fac- the desired factory.- Throws:
Error- if the factory has already been defined.SecurityException- if a security manager exists and itscheckSetFactorymethod doesn't allow the operation.- See Also:
ContentHandlerFactory,getContent()
-
-