APIdia Launch Partner
Top Description Inners Fields Constructors Methods
java.net

public final Class URL

Additional top-level class in compilation unit: UrlDeserializedState.

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@AOTSafeClassInitializer
Imports
java.io.File, .IOException, .InputStream, .InvalidObjectException, .ObjectStreamException, .ObjectStreamField, .ObjectInputStream.GetField, java.net.spi.URLStreamHandlerProvider, java.nio.file.Path, java.util.Hashtable, .Iterator, .Locale, .ServiceLoader, jdk.internal.access.JavaNetURLAccess, .SharedSecrets, jdk.internal.misc.VM, jdk.internal.vm.annotation.AOTSafeClassInitializer, sun.net.util.IPAddressUtil

Class URL represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. A resource can be something as simple as a file or a directory, or it can be a reference to a more complicated object, such as a query to a database or to a search engine. More

In general, a URL can be broken into several parts. Consider the following example:

http://www.example.com/docs/resource1.html
http://www.example.com/docs/resource1.html

The URL above indicates that the protocol to use is http (HyperText Transfer Protocol) and that the information resides on a host machine named www.example.com. The information on that host machine is named /docs/resource1.html. The exact meaning of this name on the host machine is both protocol dependent and host dependent. The information normally resides in a file, but it could be generated on the fly. This component of the URL is called the path component.

A URL can optionally specify a "port", which is the port number to which the TCP connection is made on the remote host machine. If the port is not specified, the default port for the protocol is used instead. For example, the default port for http is 80. An alternative port could be specified as:

http://www.example.com:1080/docs/resource1.html
http://www.example.com:1080/docs/resource1.html

The syntax of URL is defined by RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax, amended by RFC 2732: Format for Literal IPv6 Addresses in URLs. The Literal IPv6 address format also supports scope_ids. The syntax and usage of scope_ids is described here.

A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example,

http://www.example.com/index.html#chapter1
http://www.example.com/index.html#chapter1

This fragment is not technically part of the URL. Rather, it indicates that after the specified resource is retrieved, the application is specifically interested in that part of the document that has the tag chapter1 attached to it. The meaning of a tag is resource specific.

An application can also specify a "relative URL", which contains only enough information to reach the resource relative to another URL. Relative URLs are frequently used within HTML pages. For example, if the contents of the URL:

http://www.example.com/index.html
http://www.example.com/index.html
contained within it the relative URL:
FAQ.html
FAQ.html
it would be a shorthand for:
http://www.example.com/FAQ.html
http://www.example.com/FAQ.html

The relative URL need not specify all the components of a URL. If the protocol, host name, or port number is missing, the value is inherited from the fully specified URL. The file component must be specified. The optional fragment is not inherited.

Constructing instances of URL

The java.net.URL constructors are deprecated. Developers are encouraged to use java.net.URI to parse or construct a URL. In cases where an instance of java.net.URL is needed to open a connection, URI can be used to construct or parse the URL string, possibly calling URI#parseServerAuthority() to validate that the authority component can be parsed as a server-based authority, and then calling URI#toURL() to create the URL instance.

The URL constructors are specified to throw MalformedURLException but the actual parsing/validation that is performed is implementation dependent. Some parsing/validation may be delayed until later, when the underlying stream handler's implementation is called. Being able to construct an instance of URL doesn't provide any guarantee about its conformance to the URL syntax specification.

The URL class does not itself encode or decode any URL components according to the escaping mechanism defined in RFC 2396. It is the responsibility of the caller to encode any fields, which need to be escaped prior to calling URL, and also to decode any escaped fields, that are returned from URL. Furthermore, because URL has no knowledge of URL escaping, it does not recognise equivalence between the encoded or decoded form of the same URL. For example, the two URLs: http://foo.com/hello%20world and http://foo.com/hello world/ would be considered not equal to each other.

Note, the java.net.URI class does perform escaping of its component fields in certain circumstances. The recommended way to manage the encoding and decoding of URLs is to use java.net.URI, and to convert between these two classes using toURI() and URI#toURL().

The URLEncoder and URLDecoder classes can also be used, but only for HTML form encoding, which is not the same as the encoding scheme defined in RFC 2396.

API Note

Applications working with file paths and file URIs should take great care to use the appropriate methods to convert between the two. The Path#of(URI) factory method and the File#File(URI) constructor can be used to create Path or File objects from a file URI. Path#toUri() and File#toURI() can be used to create a URI from a file path, which can be converted to URL using URI#toURL(). Applications should never try to construct or parse a URL from the direct string representation of a File or Path instance.

Before constructing a URL from a URI, and depending on the protocol involved, applications should consider validating whether the URI authority can be parsed as server-based.

Some components of a URL or URI, such as userinfo, may be abused to construct misleading URLs or URIs. Applications that deal with URLs or URIs should take into account the recommendations advised in RFC 3986, Section 7, Security Considerations.

All URL constructors may throw MalformedURLException. In particular, if the underlying URLStreamHandler implementation rejects, or is known to reject, any of the parameters, MalformedURLException may be thrown. Typically, a constructor that calls the stream handler's parseURL method may throw MalformedURLException if the underlying stream handler implementation of that method throws IllegalArgumentException. However, which checks are performed, or not, by the stream handlers is implementation dependent, and callers should not rely on such checks for full URL validation.

Author
James Gosling
Since
1.0
External Specification
https://www.rfc-editor.org/info/rfc2396, https://www.rfc-editor.org/info/rfc2732, https://www.rfc-editor.org/info/rfc3986

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private String
authority

The authority part of this URL.

pack-priv static final String
private static final URLStreamHandlerFactory
private static volatile URLStreamHandlerFactory
factory

The URLStreamHandler factory.

private String
file

The specified file name on that host.

pack-priv transient URLStreamHandler
handler

The URLStreamHandler for this URL.

private static final Hashtable<String, URLStreamHandler>
handlers

A table of protocol handlers.

private int
private String
host

The host name to connect to.

private transient InetAddress
hostAddress

The host's IP address, used in equals and hashCode.

private static final ScopedValue<Boolean>
private transient String
path

The path part of this URL.

private int
port

The protocol port to connect to.

private String
protocol

The protocol to use (ftp, http, nntp, ...

private static final String
protocolPathProp

The property which specifies the package prefix list to be scanned for protocol handlers.

private transient String
query

The query part of this URL.

private String
ref

# reference.

private static final ObjectStreamField[]
pack-priv static final long
private static final Object
private transient UrlDeserializedState
private transient String
userInfo

The userinfo part of this URL.

Constructor Summary

AccessConstructor and Description
public
URL(String
the name of the protocol to use.
protocol
,
String
the name of the host.
host
,
int
the port number on the host.
port
,
String
the file on the host
file
)
Deprecated since 20. Use URI#toURL() to construct an instance of URL.

Creates a URL object from the specified protocol, host, port number, and file.

public
URL(String
the name of the protocol to use.
protocol
,
String
the name of the host.
host
,
String
the file on the host.
file
)
Deprecated since 20. Use URI#toURL() to construct an instance of URL.

Creates a URL from the specified protocol name, host name, and file name.

public
URL(String
the name of the protocol to use.
protocol
,
String
the name of the host.
host
,
int
the port number on the host.
port
,
String
the file on the host
file
,
URLStreamHandler
the stream handler for the URL.
handler
)
Deprecated since 20. Use of(URI, URLStreamHandler) to construct an instance of URL associated with a custom protocol handler.

Creates a URL object from the specified protocol, host, port number, file, and handler.

public
URL(String
the String to parse as a URL.
spec
)
Deprecated since 20. Use URI#toURL() to construct an instance of URL.

Creates a URL object from the String representation.

public
URL(URL
the context in which to parse the specification.
context
,
String
the String to parse as a URL.
spec
)
Deprecated since 20. Use URI#toURL() to construct an instance of URL.

Creates a URL by parsing the given spec within a specified context.

public
URL(URL
the context in which to parse the specification.
context
,
String
the String to parse as a URL.
spec
,
URLStreamHandler
the stream handler for the URL.
handler
)
Deprecated since 20. Use of(URI, URLStreamHandler) to construct an instance of URL associated with a custom protocol handler.

Creates a URL by parsing the given spec with the specified handler within a specified context.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the objects are the same; false otherwise.
equals
(Object
the URL to compare against.
obj
)

Overrides java.lang.Object.equals.

Compares this URL for equality with another object.

private URL
public String

Returns:

the authority part of this URL
getAuthority
()

Gets the authority part of this URL.

public final Object

Returns:

the contents of this URL.
getContent
()

Gets the contents of this URL.

public final Object

Returns:

the content object of this URL that is the first match of the types specified in the classes array. null if none of the requested types are supported.
getContent
(Class<?>[]
an array of Java types
classes
)

Gets the contents of this URL.

public int

Returns:

the port number
getDefaultPort
()

Gets the default port number of the protocol associated with this URL.

public String

Returns:

the file name of this URL, or an empty string if one does not exist
getFile
()

Gets the file name of this URL.

public String

Returns:

the host name of this URL.
getHost
()

Gets the host name of this URL, if applicable.

pack-priv synchronized InetAddress

Returns:

an InetAddress representing the host
getHostAddress
()

Returns the address of the host represented by this URL.

public String

Returns:

the path part of this URL, or an empty string if one does not exist
getPath
()

Gets the path part of this URL.

public int

Returns:

the port number, or -1 if the port is not set
getPort
()

Gets the port number of this URL.

public String

Returns:

the protocol of this URL.
getProtocol
()

Gets the protocol name of this URL.

public String

Returns:

the query part of this URL, or null if one does not exist
getQuery
()

Gets the query part of this URL.

public String

Returns:

the anchor (also known as the "reference") of this URL, or null if one does not exist
getRef
()

Gets the anchor (also known as the "reference") of this URL.

pack-priv static URLStreamHandler
getURLStreamHandler(String
the protocol to use
protocol
)

Returns the Stream Handler.

public String

Returns:

the userInfo part of this URL, or null if one does not exist
getUserInfo
()

Gets the userInfo part of this URL.

public synchronized int

Returns:

a hash code for this URL.
hashCode
()

Overrides java.lang.Object.hashCode.

Creates an integer suitable for hash table indexing.

pack-priv boolean
private boolean
isBuiltinStreamHandler(String handlerClassName)

pack-priv static boolean
isOverrideable(String protocol)

Non-overrideable protocols: "jrt" and "file" Character-based comparison for performance reasons; also ensures case-insensitive comparison in a locale-independent fashion.

private boolean
private static URLStreamHandler
private static URLStreamHandler
lookupViaProviders(final String protocol)

pack-priv static String
lowerCaseProtocol(String protocol)

Returns the protocol in lower case.

public static URL

Returns:

a new URL instance created from the given URI and associated with the given URLStreamHandler, if any
of
(URI
the URI from which the returned URL should be built
uri
,
URLStreamHandler
a custom protocol stream handler for the returned URL. Can be null, in which case the default stream handler for the protocol if any, will be used.
handler
)

Creates a URL from a URI, as if by invoking uri.toURL(), but associating it with the given URLStreamHandler, if allowed.

public URLConnection

Returns:

a URLConnection linking to the URL.
openConnection
()

Returns a URLConnection instance that represents a connection to the remote object referred to by the URL.

public URLConnection

Returns:

a URLConnection to the URL.
openConnection
(Proxy
the Proxy through which this connection will be made. If direct connection is desired, Proxy.NO_PROXY should be specified.
proxy
)

Same as openConnection(), except that the connection will be made through the specified proxy; Protocol handlers that do not support proxying will ignore the proxy parameter and make a normal connection.

public final InputStream

Returns:

an input stream for reading from the URL connection.
openStream
()

Opens a connection to this URL and returns an InputStream for reading from that connection.

private synchronized void
readObject(ObjectInputStream
the ObjectInputStream from which data is read
s
)

readObject is called to restore the state of the URL from the stream.

private Object

Returns:

a newly created object from deserialized data
readResolve
()

Replaces the de-serialized object with an URL object.

private void
public boolean

Returns:

true if they reference the same remote object; false otherwise.
sameFile
(URL
the URL to compare against.
other
)

Compares two URLs, excluding the fragment component.

pack-priv void
set(String
the name of the protocol to use
protocol
,
String
the name of the host
host
,
int
the port number on the host
port
,
String
the authority part for the url
authority
,
String
the username and password
userInfo
,
String
the file on the host
path
,
String
the query part of this URL
query
,
String
the internal reference in the URL
ref
)

Sets the specified 8 fields of the URL.

private URL
private void
public static void
setURLStreamHandlerFactory(URLStreamHandlerFactory
the desired factory.
fac
)

Sets an application's URLStreamHandlerFactory.

public String

Returns:

a string representation of this object.
toExternalForm
()

Constructs a string representation of this URL.

public String

Returns:

a string representation of this object.
toString
()

Overrides java.lang.Object.toString.

Constructs a string representation of this URL.

public URI

Returns:

a URI instance equivalent to this URL.
toURI
()

Returns a java.net.URI equivalent to this URL.

private synchronized void
writeObject(ObjectOutputStream
the ObjectOutputStream to which data is written
s
)

WriteObject is called to save the state of the URL to an ObjectOutputStream.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait