org.apache.xerces.util
public class URI extends Object implements Serializable
Parsing of a URI specification is done according to the URI syntax described in RFC 2396, and amended by RFC 2732.
Every absolute URI consists of a scheme, followed by a colon (':'), followed by a scheme-specific part. For URIs that follow the "generic URI" syntax, the scheme-specific part begins with two slashes ("//") and may be followed by an authority segment (comprised of user information, host, and port), path segment, query segment and fragment. Note that RFC 2396 no longer specifies the use of the parameters segment and excludes the "user:password" syntax as part of the authority segment. If "user:password" appears in a URI, the entire user/password string is stored as userinfo.
For URIs that do not follow the "generic URI" syntax (e.g. mailto), the entire scheme-specific part is treated as the "path" portion of the URI.
Note that, unlike the java.net.URL class, this class does not provide any built-in network access functionality nor does it provide any scheme-specific functionality (for example, it does not know a default port for a specific scheme). Rather, it only knows the grammar and basic set of operations that can be applied to a URI.
Version: $Id: URI.java,v 1.23 2005/06/24 01:06:07 mrglavas Exp $
Nested Class Summary | |
---|---|
static class | URI.MalformedURIException
MalformedURIExceptions are thrown in the process of building a URI
or setting fields on a URI when an operation would result in an
invalid URI specification.
|
Constructor Summary | |
---|---|
URI()
Construct a new and uninitialized URI. | |
URI(URI p_other)
Construct a new URI from another URI. | |
URI(String p_uriSpec)
Construct a new URI from a URI specification string. | |
URI(String p_uriSpec, boolean allowNonAbsoluteURI)
Construct a new URI from a URI specification string. | |
URI(URI p_base, String p_uriSpec)
Construct a new URI from a base URI and a URI specification string.
| |
URI(URI p_base, String p_uriSpec, boolean allowNonAbsoluteURI)
Construct a new URI from a base URI and a URI specification string.
| |
URI(String p_scheme, String p_schemeSpecificPart)
Construct a new URI that does not follow the generic URI syntax.
| |
URI(String p_scheme, String p_host, String p_path, String p_queryString, String p_fragment)
Construct a new URI that follows the generic URI syntax from its
component parts. | |
URI(String p_scheme, String p_userinfo, String p_host, int p_port, String p_path, String p_queryString, String p_fragment)
Construct a new URI that follows the generic URI syntax from its
component parts. |
Method Summary | |
---|---|
void | absolutize(URI p_base)
Absolutize URI with given base URI.
|
void | appendPath(String p_addToPath)
Append to the end of the path of this URI. |
boolean | equals(Object p_test)
Determines if the passed-in Object is equivalent to this URI.
|
String | getAuthority()
Get the authority for this URI.
|
String | getFragment()
Get the fragment for this URI.
|
String | getHost()
Get the host for this URI.
|
String | getPath(boolean p_includeQueryString, boolean p_includeFragment)
Get the path for this URI (optionally with the query string and
fragment).
|
String | getPath()
Get the path for this URI. |
int | getPort()
Get the port for this URI.
|
String | getQueryString()
Get the query string for this URI.
|
String | getRegBasedAuthority()
Get the registry based authority for this URI.
|
String | getScheme()
Get the scheme for this URI.
|
String | getSchemeSpecificPart()
Get the scheme-specific part for this URI (everything following the
scheme and the first colon). |
String | getUserinfo()
Get the userinfo for this URI.
|
boolean | isAbsoluteURI()
Returns whether this URI represents an absolute URI.
|
static boolean | isConformantSchemeName(String p_scheme)
Determine whether a scheme conforms to the rules for a scheme name.
|
boolean | isGenericURI()
Get the indicator as to whether this URI uses the "generic URI"
syntax.
|
static boolean | isWellFormedAddress(String address)
Determine whether a string is syntactically capable of representing
a valid IPv4 address, IPv6 reference or the domain name of a network host.
|
static boolean | isWellFormedIPv4Address(String address) Determines whether a string is an IPv4 address as defined by RFC 2373, and under the further constraint that it must be a 32-bit address. |
static boolean | isWellFormedIPv6Reference(String address) Determines whether a string is an IPv6 reference as defined by RFC 2732, where IPv6address is defined in RFC 2373. |
void | setFragment(String p_fragment)
Set the fragment for this URI. |
void | setHost(String p_host) Set the host for this URI. |
void | setPath(String p_path)
Set the path for this URI. |
void | setPort(int p_port)
Set the port for this URI. |
void | setQueryString(String p_queryString)
Set the query string for this URI. |
void | setRegBasedAuthority(String authority) Sets the registry based authority for this URI. Note: This method overwrites server based authority if it previously existed in this URI. |
void | setScheme(String p_scheme)
Set the scheme for this URI. |
void | setUserinfo(String p_userinfo)
Set the userinfo for this URI. |
String | toString()
Get the URI as a string specification. |
Parameters: p_other the URI to copy (cannot be null)
Parameters: p_uriSpec the URI specification string (cannot be null or empty)
Throws: MalformedURIException if p_uriSpec violates any syntax rules
Parameters: p_uriSpec the URI specification string (cannot be null or empty) allowNonAbsoluteURI true to permit non-absolute URIs, false otherwise.
Throws: MalformedURIException if p_uriSpec violates any syntax rules
Parameters: p_base the base URI (cannot be null if p_uriSpec is null or empty) p_uriSpec the URI specification string (cannot be null or empty if p_base is null)
Throws: MalformedURIException if p_uriSpec violates any syntax rules
Parameters: p_base the base URI (cannot be null if p_uriSpec is null or empty) p_uriSpec the URI specification string (cannot be null or empty if p_base is null) allowNonAbsoluteURI true to permit non-absolute URIs, false otherwise.
Throws: MalformedURIException if p_uriSpec violates any syntax rules
Parameters: p_scheme the URI scheme (cannot be null or empty) p_schemeSpecificPart the scheme-specific part (cannot be null or empty)
Throws: MalformedURIException if p_scheme violates any syntax rules
Parameters: p_scheme the URI scheme (cannot be null or empty) p_host the hostname, IPv4 address or IPv6 reference for the URI p_path the URI path - if the path contains '?' or '#', then the query string and/or fragment will be set from the path; however, if the query and fragment are specified both in the path and as separate parameters, an exception is thrown p_queryString the URI query string (cannot be specified if path is null) p_fragment the URI fragment (cannot be specified if path is null)
Throws: MalformedURIException if any of the parameters violates syntax rules or semantic rules
Parameters: p_scheme the URI scheme (cannot be null or empty) p_userinfo the URI userinfo (cannot be specified if host is null) p_host the hostname, IPv4 address or IPv6 reference for the URI p_port the URI port (may be -1 for "unspecified"; cannot be specified if host is null) p_path the URI path - if the path contains '?' or '#', then the query string and/or fragment will be set from the path; however, if the query and fragment are specified both in the path and as separate parameters, an exception is thrown p_queryString the URI query string (cannot be specified if path is null) p_fragment the URI fragment (cannot be specified if path is null)
Throws: MalformedURIException if any of the parameters violates syntax rules or semantic rules
Parameters: p_base base URI for absolutization
Parameters: p_addToPath the new segment to be added to the current path
Throws: MalformedURIException if p_addToPath contains syntax errors
Parameters: p_test the Object to test for equality.
Returns: true if p_test is a URI with all values equal to this URI, false otherwise
Returns: the authority
Returns: the fragment for this URI. Null is returned if there was no "#" in the URI spec, empty string if there was a "#" but no fragment following it.
Returns: the host for this URI (null if not specified).
Parameters: p_includeQueryString if true (and query string is not null), then a "?" followed by the query string will be appended p_includeFragment if true (and fragment is not null), then a "#" followed by the fragment will be appended
Returns: the path for this URI possibly including the query string and fragment
Returns: the path for this URI.
Returns: the port for this URI (-1 if not specified).
Returns: the query string for this URI. Null is returned if there was no "?" in the URI spec, empty string if there was a "?" but no query string following it.
Returns: the registry based authority (null if not specified).
Returns: the scheme for this URI
Returns: the scheme-specific part for this URI
Returns: the userinfo for this URI (null if not specified).
Returns: true if this URI represents an absolute URI, false otherwise
Returns: true if the scheme is conformant, false otherwise
Returns: true if this URI uses the "generic URI" syntax, false otherwise
Returns: true if the string is a syntactically valid IPv4 address, IPv6 reference or hostname
Determines whether a string is an IPv4 address as defined by RFC 2373, and under the further constraint that it must be a 32-bit address. Though not expressed in the grammar, in order to satisfy the 32-bit address constraint, each segment of the address cannot be greater than 255 (8 bits of information).
IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
Returns: true if the string is a syntactically valid IPv4 address
Determines whether a string is an IPv6 reference as defined by RFC 2732, where IPv6address is defined in RFC 2373. The IPv6 address is parsed according to Section 2.2 of RFC 2373, with the additional constraint that the address be composed of 128 bits of information.
IPv6reference = "[" IPv6address "]"
Note: The BNF expressed in RFC 2373 Appendix B does not accurately describe section 2.2, and was in fact removed from RFC 3513, the successor of RFC 2373.
Returns: true if the string is a syntactically valid IPv6 reference
Parameters: p_fragment the fragment for this URI
Throws: MalformedURIException if p_fragment is not null and this URI does not conform to the generic URI syntax or if the path is null
Set the host for this URI. If null is passed in, the userinfo field is also set to null and the port is set to -1.
Note: This method overwrites registry based authority if it previously existed in this URI.
Parameters: p_host the host for this URI
Throws: MalformedURIException if p_host is not a valid IP address or DNS hostname.
Parameters: p_path the path for this URI (may be null)
Throws: MalformedURIException if p_path contains invalid characters
Parameters: p_port the port number for this URI
Throws: MalformedURIException if p_port is not -1 and not a valid port number
Parameters: p_queryString the query string for this URI
Throws: MalformedURIException if p_queryString is not null and this URI does not conform to the generic URI syntax or if the path is null
Sets the registry based authority for this URI.
Note: This method overwrites server based authority if it previously existed in this URI.
Parameters: authority the registry based authority for this URI
Throws: MalformedURIException it authority is not a well formed registry based authority
Parameters: p_scheme the scheme for this URI (cannot be null)
Throws: MalformedURIException if p_scheme is not a conformant scheme name
Parameters: p_userinfo the userinfo for this URI
Throws: MalformedURIException if p_userinfo contains invalid characters
Returns: the URI string specification