| java.lang.Object
 java.net.URLStreamHandler
| URLStreamHandler | | abstract public class URLStreamHandler (Code) | | The abstract class URLStreamHandler is the common
superclass for all stream protocol handlers. A stream protocol
handler knows how to make a connection for a particular protocol
type, such as http, ftp, or
gopher.
In most cases, an instance of a URLStreamHandler
subclass is not created directly by an application. Rather, the
first time a protocol name is encountered when constructing a
URL, the appropriate stream protocol handler is
automatically loaded.
author:
James Gosling
version:
1.79, 05/05/07
See Also: java.net.URL.URL(java.lang.Stringjava.lang.Stringintjava.lang.String)
since:
JDK1.0 |
| Method Summary | |
| protected boolean | equals(URL u1, URL u2)
Provides the default equals calculation. | | protected int | getDefaultPort()
Returns the default port for a URL parsed by this handler. | | protected synchronized InetAddress | getHostAddress(URL u)
Get the IP address of our host. | | protected int | hashCode(URL u)
Provides the default hash calculation. | | protected boolean | hostsEqual(URL u1, URL u2)
Compares the host components of two URLs. | | abstract protected URLConnection | openConnection(URL u)
Opens a connection to the object referenced by the
URL argument.
This method should be overridden by a subclass.
If for the handler's protocol (such as HTTP or JAR), there
exists a public, specialized URLConnection subclass belonging
to one of the following packages or one of their subpackages:
java.lang, java.io, java.util, java.net, the connection
returned will be of that subclass. | | protected URLConnection | openConnection(URL u, Proxy p)
Same as openConnection(URL), 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.
Calling this method preempts the system's default ProxySelector
settings.
Parameters:
u - the URL that this connects to.
Parameters:
p - the proxy through which the connection will be made.If direct connection is desired, Proxy.NO_PROXYshould be specified. | | protected void | parseURL(URL u, String spec, int start, int limit)
Parses the string representation of a URL into a
URL object.
If there is any inherited context, then it has already been
copied into the URL argument.
The parseURL method of URLStreamHandler
parses the string representation as if it were an
http specification. | | protected boolean | sameFile(URL u1, URL u2)
Compare two urls to see whether they refer to the same file,
i.e., having the same protocol, host, port, and path.
This method requires that none of its arguments is null. | | protected void | setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)
Sets the fields of the URL argument to the indicated values.
Only classes derived from URLStreamHandler are supposed to be able
to call the set method on a URL.
Parameters:
u - the URL to modify.
Parameters:
protocol - the protocol name.
Parameters:
host - the remote host value for the URL.
Parameters:
port - the port on the remote machine.
Parameters:
authority - the authority part for the URL.
Parameters:
userInfo - the userInfo part of the URL.
Parameters:
path - the path component of the URL. | | protected void | setURL(URL u, String protocol, String host, int port, String file, String ref)
Sets the fields of the URL argument to the indicated values.
Only classes derived from URLStreamHandler are supposed to be able
to call the set method on a URL.
Parameters:
u - the URL to modify.
Parameters:
protocol - the protocol name. | | protected String | toExternalForm(URL u)
Converts a URL of a specific protocol to a
String.
Parameters:
u - the URL. |
| equals | | protected boolean equals(URL u1, URL u2)(Code) | | Provides the default equals calculation. May be overidden by handlers
for other protocols that have different requirements for equals().
This method requires that none of its arguments is null. This is
guaranteed by the fact that it is only called by java.net.URL class.
Parameters:
u1 - a URL object
Parameters:
u2 - a URL object true if the two urls are considered equal, ie. they refer to the same fragment in the same file.
since:
1.3 |
| getDefaultPort | | protected int getDefaultPort()(Code) | | Returns the default port for a URL parsed by this handler. This method
is meant to be overidden by handlers with default port numbers.
the default port for a URL parsed by this handler.
since:
1.3 |
| getHostAddress | | protected synchronized InetAddress getHostAddress(URL u)(Code) | | Get the IP address of our host. An empty host field or a DNS failure
will result in a null return.
Parameters:
u - a URL object an InetAddress representing the hostIP address.
since:
1.3 |
| hashCode | | protected int hashCode(URL u)(Code) | | Provides the default hash calculation. May be overidden by handlers for
other protocols that have different requirements for hashCode
calculation.
Parameters:
u - a URL object an int suitable for hash table indexing
since:
1.3 |
| hostsEqual | | protected boolean hostsEqual(URL u1, URL u2)(Code) | | Compares the host components of two URLs.
Parameters:
u1 - the URL of the first host to compare
Parameters:
u2 - the URL of the second host to compare true if and only if they are equal, false otherwise.
since:
1.3 |
| openConnection | | abstract protected URLConnection openConnection(URL u) throws IOException(Code) | | Opens a connection to the object referenced by the
URL argument.
This method should be overridden by a subclass.
If for the handler's protocol (such as HTTP or JAR), there
exists a public, specialized URLConnection subclass belonging
to one of the following packages or one of their subpackages:
java.lang, java.io, java.util, java.net, the connection
returned will be of that subclass. For example, for HTTP an
HttpURLConnection will be returned, and for JAR a
JarURLConnection will be returned.
Parameters:
u - the URL that this connects to. a URLConnection object for the URL.
exception:
IOException - if an I/O error occurs while opening theconnection. |
| openConnection | | protected URLConnection openConnection(URL u, Proxy p) throws IOException(Code) | | Same as openConnection(URL), 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.
Calling this method preempts the system's default ProxySelector
settings.
Parameters:
u - the URL that this connects to.
Parameters:
p - the proxy through which the connection will be made.If direct connection is desired, Proxy.NO_PROXYshould be specified. a URLConnection object for the URL.
exception:
IOException - if an I/O error occurs while opening theconnection.
exception:
IllegalArgumentException - if either u or p is null,or p has the wrong type.
exception:
UnsupportedOperationException - if the subclass thatimplements the protocol doesn't support this method.
since:
1.5 |
| parseURL | | protected void parseURL(URL u, String spec, int start, int limit)(Code) | | Parses the string representation of a URL into a
URL object.
If there is any inherited context, then it has already been
copied into the URL argument.
The parseURL method of URLStreamHandler
parses the string representation as if it were an
http specification. Most URL protocol families have a
similar parsing. A stream protocol handler for a protocol that has
a different syntax must override this routine.
Parameters:
u - the URL to receive the result of parsingthe spec.
Parameters:
spec - the String representing the URL thatmust be parsed.
Parameters:
start - the character index at which to begin parsing. This isjust past the ':' (if there is one) thatspecifies the determination of the protocol name.
Parameters:
limit - the character position to stop parsing at. This is theend of the string or the position of the"#" character, if present. All informationafter the sharp sign indicates an anchor. |
| sameFile | | protected boolean sameFile(URL u1, URL u2)(Code) | | Compare two urls to see whether they refer to the same file,
i.e., having the same protocol, host, port, and path.
This method requires that none of its arguments is null. This is
guaranteed by the fact that it is only called indirectly
by java.net.URL class.
Parameters:
u1 - a URL object
Parameters:
u2 - a URL object true if u1 and u2 refer to the same file
since:
1.3 |
| setURL | | protected void setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)(Code) | | Sets the fields of the URL argument to the indicated values.
Only classes derived from URLStreamHandler are supposed to be able
to call the set method on a URL.
Parameters:
u - the URL to modify.
Parameters:
protocol - the protocol name.
Parameters:
host - the remote host value for the URL.
Parameters:
port - the port on the remote machine.
Parameters:
authority - the authority part for the URL.
Parameters:
userInfo - the userInfo part of the URL.
Parameters:
path - the path component of the URL.
Parameters:
query - the query part for the URL.
Parameters:
ref - the reference.
exception:
SecurityException - if the protocol handler of the URL is different from this one
See Also: java.net.URL.set(java.lang.Stringjava.lang.Stringintjava.lang.Stringjava.lang.String)
since:
1.3 |
| setURL | | protected void setURL(URL u, String protocol, String host, int port, String file, String ref)(Code) | | Sets the fields of the URL argument to the indicated values.
Only classes derived from URLStreamHandler are supposed to be able
to call the set method on a URL.
Parameters:
u - the URL to modify.
Parameters:
protocol - the protocol name. This value is ignored since 1.2.
Parameters:
host - the remote host value for the URL.
Parameters:
port - the port on the remote machine.
Parameters:
file - the file.
Parameters:
ref - the reference.
exception:
SecurityException - if the protocol handler of the URL is different from this one |
| toExternalForm | | protected String toExternalForm(URL u)(Code) | | Converts a URL of a specific protocol to a
String.
Parameters:
u - the URL. a string representation of the URL argument. |
|
|