| java.lang.Object
 com.sun.perseus.platform.PURL
| PURL | | final public class PURL (Code) | | 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
information on the types of URLs and their formats can be found at:
http://archive.ncsa.uiuc.edu/SDG/Software/Mosaic/Demo/url-primer.html
In general, a URL can be broken into several parts. The previous
example of a URL indicates that the protocol to use is
http (HyperText Transfer Protocol) and that the
information resides on a host machine named
www.ncsa.uiuc.edu. The information on that host
machine is named /SDG/Software/Mosaic/Demo/url-primer.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://archive.ncsa.uiuc.edu:80/SDG/Software/Mosaic/Demo/url-primer.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.
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://java.sun.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://java.sun.com/index.html
contained within it the relative URL:
FAQ.html
it would be a shorthand for:
http://java.sun.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.
|
| Constructor Summary | |
| public | PURL(String spec)
Creates a URL object from the String
representation. | | public | PURL(PURL context, String spec)
Creates a URL by parsing the given spec within a specified context.
The new URL is created from the given context URL and the spec
argument as described in
RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :
<scheme>://<authority><path>?<query>#<fragment>
The reference is parsed into the scheme, authority, path, query and
fragment parts. | | public | PURL(PURL context, String spec, Object handler)
Creates a URL by parsing the given spec with the specified handler
within a specified context. |
| Method Summary | |
| public String | getAuthority()
Gets the authority part of this URL. | | public int | getDefaultPort()
Gets the default port number of the protocol associated
with this URL. | | public String | getFile()
Gets the file name of this URL.
The returned file portion will be
the same as getPath(), plus the concatenation of
the value of getQuery(), if any. | | public String | getHost()
Gets the host name of this URL, if applicable.
The format of the host conforms to RFC 2732, i.e. | | public String | getPath()
Gets the path part of this URL. | | public int | getPort()
Gets the port number of this URL. | | public String | getProtocol()
Gets the protocol name of this URL. | | public String | getQuery()
Gets the query part of this URL. | | public String | getRef()
Gets the anchor (also known as the "reference") of this
URL. | | public String | getUserInfo()
Gets the userInfo part of this URL. | | protected void | set(String protocol, String host, int port, String file, String ref)
Sets the fields of the URL. | | protected void | set(String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)
Sets the specified 8 fields of the URL. | | public String | toExternalForm()
Constructs a string representation of this URL. | | public String | toString()
Constructs a string representation of this URL. |
| hostAddress | | transient Object hostAddress(Code) | | The host's IP address, used in equals and hashCode.
Computed on demand. An uninitialized or unknown hostAddress is null.
|
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| PURL | | public PURL(String spec) throws Error(Code) | | Creates a URL object from the String
representation.
This constructor is equivalent to a call to the two-argument
constructor with a null first argument.
Parameters:
spec - the String to parse as a URL.
exception:
Error - If the string specifies anunknown protocol.
See Also: java.net.URL.URL(java.net.URLjava.lang.String) |
| PURL | | public PURL(PURL context, String spec) throws Error(Code) | | Creates a URL by parsing the given spec within a specified context.
The new URL is created from the given context URL and the spec
argument as described in
RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :
<scheme>://<authority><path>?<query>#<fragment>
The reference is parsed into the scheme, authority, path, query and
fragment parts. If the path component is empty and the scheme,
authority, and query components are undefined, then the new URL is a
reference to the current document. Otherwise, the fragment and query
parts present in the spec are used in the new URL.
If the scheme component is defined in the given spec and does not match
the scheme of the context, then the new URL is created as an absolute
URL based on the spec alone. Otherwise the scheme component is inherited
from the context URL.
If the authority component is present in the spec then the spec is
treated as absolute and the spec authority and path will replace the
context authority and path. If the authority component is absent in the
spec then the authority of the new URL will be inherited from the
context.
If the spec's path component begins with a slash character
"/" then the
path is treated as absolute and the spec path replaces the context path.
Otherwise, the path is treated as a relative path and is appended to the
context path, as described in RFC2396. Also, in this case,
the path is canonicalized through the removal of directory
changes made by occurences of ".." and ".".
For a more detailed description of URL parsing, refer to RFC2396.
Parameters:
context - the context in which to parse the specification.
Parameters:
spec - the String to parse as a URL.
exception:
Error - if no protocol is specified, or anunknown protocol is found.
See Also: java.net.URL.URL(java.lang.Stringjava.lang.Stringintjava.lang.String)
See Also: java.net.URLStreamHandler
See Also: java.net.URLStreamHandler.parseURL(java.net.URLjava.lang.Stringintint) |
| getAuthority | | public String getAuthority()(Code) | | Gets the authority part of this URL.
the authority part of this URL
since:
1.3 |
| getDefaultPort | | public int getDefaultPort()(Code) | | Gets the default port number of the protocol associated
with this URL. If the URL scheme or the URLStreamHandler
for the URL do not define a default port number,
then -1 is returned.
the port number |
| getFile | | public String getFile()(Code) | | Gets the file name of this URL.
The returned file portion will be
the same as getPath(), plus the concatenation of
the value of getQuery(), if any. If there is
no query portion, this method and getPath() will
return identical results.
the file name of this URL,or an empty string if one does not exist |
| getHost | | public String getHost()(Code) | | Gets the host name of this URL, if applicable.
The format of the host conforms to RFC 2732, i.e. for a
literal IPv6 address, this method will return the IPv6 address
enclosed in square brackets ('[' and ']').
the host name of this URL. |
| getPath | | public String getPath()(Code) | | Gets the path part of this URL.
the path part of this URL, or anempty string if one does not exist
since:
1.3 |
| getPort | | public int getPort()(Code) | | Gets the port number of this URL.
the port number, or -1 if the port is not set |
| getProtocol | | public String getProtocol()(Code) | | Gets the protocol name of this URL.
the protocol of this URL. |
| getQuery | | public String getQuery()(Code) | | Gets the query part of this URL.
the query part of this URL, or null if one does not exist
since:
1.3 |
| getRef | | public String getRef()(Code) | | Gets the anchor (also known as the "reference") of this
URL.
the anchor (also known as the "reference") of thisURL, or null if one does not exist |
| getUserInfo | | public String getUserInfo()(Code) | | Gets the userInfo part of this URL.
the userInfo part of this URL, or null if one does not exist |
| set | | protected void set(String protocol, String host, int port, String file, String ref)(Code) | | Sets the fields of the URL. This is not a public method so that
only URLStreamHandlers can modify URL fields. URLs are
otherwise constant.
Parameters:
protocol - the name of the protocol to use
Parameters:
host - the name of the host
Parameters:
port - the port number on the host
Parameters:
file - the file on the host
Parameters:
ref - the internal reference in the URL |
| set | | protected void set(String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref)(Code) | | Sets the specified 8 fields of the URL. This is not a public method so
that only URLStreamHandlers can modify URL fields. URLs are otherwise
constant.
Parameters:
protocol - the name of the protocol to use
Parameters:
host - the name of the host
Parameters:
port - the port number on the host
Parameters:
authority - the authority part for the url
Parameters:
userInfo - the username and password
Parameters:
path - the file on the host
Parameters:
ref - the internal reference in the URL
Parameters:
query - the query part of this URL
since:
1.3 |
|
|