| java.lang.Object
 org.apache.xml.utils.URI
| URI | | public class URI implements Serializable(Code) | | A class to represent a Uniform Resource Identifier (URI). This class
is designed to handle the parsing of URIs and provide access to
the various components (scheme, host, port, userinfo, path, query
string and fragment) that may constitute a URI.
Parsing of a URI specification is done according to the URI
syntax described in RFC 2396
. Every 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.
|
| Inner Class :public static class MalformedURIException extends IOException | |
| Constructor Summary | |
| public | URI()
Construct a new and uninitialized URI. | | public | URI(URI p_other)
Construct a new URI from another URI. | | public | URI(String p_uriSpec)
Construct a new URI from a URI specification string. | | public | URI(URI p_base, String p_uriSpec)
Construct a new URI from a base URI and a URI specification string. | | public | URI(String p_scheme, String p_schemeSpecificPart)
Construct a new URI that does not follow the generic URI syntax. | | public | 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. | | public | 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 | |
| public void | appendPath(String p_addToPath)
Append to the end of the path of this URI. | | public boolean | equals(Object p_test)
Determines if the passed-in Object is equivalent to this URI.
Parameters:
p_test - the Object to test for equality. | | public String | getFragment()
Get the fragment for this URI.
the fragment for this URI. | | public String | getHost()
Get the host for this URI. | | public String | getPath(boolean p_includeQueryString, boolean p_includeFragment)
Get the path for this URI (optionally with the query string and
fragment). | | public String | getPath()
Get the path for this URI. | | public int | getPort()
Get the port for this URI. | | public String | getQueryString()
Get the query string for this URI.
the query string for this URI. | | public String | getScheme()
Get the scheme for this URI. | | public String | getSchemeSpecificPart()
Get the scheme-specific part for this URI (everything following the
scheme and the first colon). | | public String | getUserinfo()
Get the userinfo for this URI. | | public static boolean | isConformantSchemeName(String p_scheme)
Determine whether a scheme conforms to the rules for a scheme name. | | public boolean | isGenericURI()
Get the indicator as to whether this URI uses the "generic URI"
syntax. | | public static boolean | isWellFormedAddress(String p_address)
Determine whether a string is syntactically capable of representing
a valid IPv4 address or the domain name of a network host. | | public void | setFragment(String p_fragment)
Set the fragment for this URI. | | public void | setHost(String p_host)
Set the host for this URI. | | public void | setPath(String p_path)
Set the path for this URI. | | public void | setPort(int p_port)
Set the port for this URI. | | public void | setQueryString(String p_queryString)
Set the query string for this URI. | | public void | setScheme(String p_scheme)
Set the scheme for this URI. | | public void | setUserinfo(String p_userinfo)
Set the userinfo for this URI. | | public String | toString()
Get the URI as a string specification. |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| URI | | public URI()(Code) | | Construct a new and uninitialized URI.
|
| URI | | public URI(URI p_other)(Code) | | Construct a new URI from another URI. All fields for this URI are
set equal to the fields of the URI passed in.
Parameters:
p_other - the URI to copy (cannot be null) |
| URI | | public URI(String p_uriSpec) throws MalformedURIException(Code) | | Construct a new URI from a URI specification string. If the
specification follows the "generic URI" syntax, (two slashes
following the first colon), the specification will be parsed
accordingly - setting the scheme, userinfo, host,port, path, query
string and fragment fields as necessary. If the specification does
not follow the "generic URI" syntax, the specification is parsed
into a scheme and scheme-specific part (stored as the path) only.
Parameters:
p_uriSpec - the URI specification string (cannot be null orempty)
throws:
MalformedURIException - if p_uriSpec violates any syntaxrules |
| URI | | public URI(URI p_base, String p_uriSpec) throws MalformedURIException(Code) | | Construct a new URI from a base URI and a URI specification string.
The URI specification string may be a relative URI.
Parameters:
p_base - the base URI (cannot be null if p_uriSpec is null orempty)
Parameters:
p_uriSpec - the URI specification string (cannot be null orempty if p_base is null)
throws:
MalformedURIException - if p_uriSpec violates any syntaxrules |
| URI | | public URI(String p_scheme, String p_schemeSpecificPart) throws MalformedURIException(Code) | | Construct a new URI that does not follow the generic URI syntax.
Only the scheme and scheme-specific part (stored as the path) are
initialized.
Parameters:
p_scheme - the URI scheme (cannot be null or empty)
Parameters:
p_schemeSpecificPart - the scheme-specific part (cannot benull or empty)
throws:
MalformedURIException - if p_scheme violates anysyntax rules |
| URI | | public URI(String p_scheme, String p_host, String p_path, String p_queryString, String p_fragment) throws MalformedURIException(Code) | | Construct a new URI that follows the generic URI syntax from its
component parts. Each component is validated for syntax and some
basic semantic checks are performed as well. See the individual
setter methods for specifics.
Parameters:
p_scheme - the URI scheme (cannot be null or empty)
Parameters:
p_host - the hostname or IPv4 address for the URI
Parameters:
p_path - the URI path - if the path contains '?' or '#',then the query string and/or fragment will beset from the path; however, if the query andfragment are specified both in the path and asseparate parameters, an exception is thrown
Parameters:
p_queryString - the URI query string (cannot be specifiedif path is null)
Parameters:
p_fragment - the URI fragment (cannot be specified if pathis null)
throws:
MalformedURIException - if any of the parameters violatessyntax rules or semantic rules |
| URI | | public URI(String p_scheme, String p_userinfo, String p_host, int p_port, String p_path, String p_queryString, String p_fragment) throws MalformedURIException(Code) | | Construct a new URI that follows the generic URI syntax from its
component parts. Each component is validated for syntax and some
basic semantic checks are performed as well. See the individual
setter methods for specifics.
Parameters:
p_scheme - the URI scheme (cannot be null or empty)
Parameters:
p_userinfo - the URI userinfo (cannot be specified if hostis null)
Parameters:
p_host - the hostname or IPv4 address for the URI
Parameters:
p_port - the URI port (may be -1 for "unspecified"; cannotbe specified if host is null)
Parameters:
p_path - the URI path - if the path contains '?' or '#',then the query string and/or fragment will beset from the path; however, if the query andfragment are specified both in the path and asseparate parameters, an exception is thrown
Parameters:
p_queryString - the URI query string (cannot be specifiedif path is null)
Parameters:
p_fragment - the URI fragment (cannot be specified if pathis null)
throws:
MalformedURIException - if any of the parameters violatessyntax rules or semantic rules |
| appendPath | | public void appendPath(String p_addToPath) throws MalformedURIException(Code) | | Append to the end of the path of this URI. If the current path does
not end in a slash and the path to be appended does not begin with
a slash, a slash will be appended to the current path before the
new segment is added. Also, if the current path ends in a slash
and the new segment begins with a slash, the extra slash will be
removed before the new segment is appended.
Parameters:
p_addToPath - the new segment to be added to the current path
throws:
MalformedURIException - if p_addToPath contains syntaxerrors |
| equals | | public boolean equals(Object p_test)(Code) | | Determines if the passed-in Object is equivalent to this URI.
Parameters:
p_test - the Object to test for equality. true if p_test is a URI with all values equal to thisURI, false otherwise |
| getFragment | | public String getFragment()(Code) | | Get the fragment for this URI.
the fragment for this URI. Null is returned if therewas no "#" in the URI spec, empty string if there was a"#" but no fragment following it. |
| getHost | | public String getHost()(Code) | | Get the host for this URI.
the host for this URI (null if not specified). |
| getPath | | public String getPath(boolean p_includeQueryString, boolean p_includeFragment)(Code) | | Get the path for this URI (optionally with the query string and
fragment).
Parameters:
p_includeQueryString - if true (and query string is not null),then a "?" followed by the query stringwill be appended
Parameters:
p_includeFragment - if true (and fragment is not null),then a "#" followed by the fragmentwill be appended the path for this URI possibly including the query stringand fragment |
| getPath | | public String getPath()(Code) | | Get the path for this URI. Note that the value returned is the path
only and does not include the query string or fragment.
the path for this URI. |
| getPort | | public int getPort()(Code) | | Get the port for this URI.
the port for this URI (-1 if not specified). |
| getQueryString | | public String getQueryString()(Code) | | Get the query string for this URI.
the query string for this URI. Null is returned if therewas no "?" in the URI spec, empty string if there was a"?" but no query string following it. |
| getScheme | | public String getScheme()(Code) | | Get the scheme for this URI.
the scheme for this URI |
| getSchemeSpecificPart | | public String getSchemeSpecificPart()(Code) | | Get the scheme-specific part for this URI (everything following the
scheme and the first colon). See RFC 2396 Section 5.2 for spec.
the scheme-specific part for this URI |
| getUserinfo | | public String getUserinfo()(Code) | | Get the userinfo for this URI.
the userinfo for this URI (null if not specified). |
| isConformantSchemeName | | public static boolean isConformantSchemeName(String p_scheme)(Code) | | Determine whether a scheme conforms to the rules for a scheme name.
A scheme is conformant if it starts with an alphanumeric, and
contains only alphanumerics, '+','-' and '.'.
Parameters:
p_scheme - The sheme name to check true if the scheme is conformant, false otherwise |
| isGenericURI | | public boolean isGenericURI()(Code) | | Get the indicator as to whether this URI uses the "generic URI"
syntax.
true if this URI uses the "generic URI" syntax, falseotherwise |
| isWellFormedAddress | | public static boolean isWellFormedAddress(String p_address)(Code) | | Determine whether a string is syntactically capable of representing
a valid IPv4 address or the domain name of a network host. A valid
IPv4 address consists of four decimal digit groups separated by a
'.'. A hostname consists of domain labels (each of which must
begin and end with an alphanumeric but may contain '-') separated
& by a '.'. See RFC 2396 Section 3.2.2.
Parameters:
p_address - The address string to check true if the string is a syntactically valid IPv4 addressor hostname |
| setFragment | | public void setFragment(String p_fragment) throws MalformedURIException(Code) | | Set the fragment for this URI. A non-null value is valid only
if this is a URI conforming to the generic URI syntax and
the path value is not null.
Parameters:
p_fragment - the fragment for this URI
throws:
MalformedURIException - if p_fragment is not null and thisURI does not conform to the genericURI syntax or if the path is null |
| setHost | | public void setHost(String p_host) throws MalformedURIException(Code) | | 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.
Parameters:
p_host - the host for this URI
throws:
MalformedURIException - if p_host is not a valid IPaddress or DNS hostname. |
| setPath | | public void setPath(String p_path) throws MalformedURIException(Code) | | Set the path for this URI. If the supplied path is null, then the
query string and fragment are set to null as well. If the supplied
path includes a query string and/or fragment, these fields will be
parsed and set as well. Note that, for URIs following the "generic
URI" syntax, the path specified should start with a slash.
For URIs that do not follow the generic URI syntax, this method
sets the scheme-specific part.
Parameters:
p_path - the path for this URI (may be null)
throws:
MalformedURIException - if p_path contains invalidcharacters |
| setPort | | public void setPort(int p_port) throws MalformedURIException(Code) | | Set the port for this URI. -1 is used to indicate that the port is
not specified, otherwise valid port numbers are between 0 and 65535.
If a valid port number is passed in and the host field is null,
an exception is thrown.
Parameters:
p_port - the port number for this URI
throws:
MalformedURIException - if p_port is not -1 and not avalid port number |
| setQueryString | | public void setQueryString(String p_queryString) throws MalformedURIException(Code) | | Set the query string for this URI. A non-null value is valid only
if this is an URI conforming to the generic URI syntax and
the path value is not null.
Parameters:
p_queryString - the query string for this URI
throws:
MalformedURIException - if p_queryString is not null and thisURI does not conform to the genericURI syntax or if the path is null |
| setScheme | | public void setScheme(String p_scheme) throws MalformedURIException(Code) | | Set the scheme for this URI. The scheme is converted to lowercase
before it is set.
Parameters:
p_scheme - the scheme for this URI (cannot be null)
throws:
MalformedURIException - if p_scheme is not a conformantscheme name |
| setUserinfo | | public void setUserinfo(String p_userinfo) throws MalformedURIException(Code) | | Set the userinfo for this URI. If a non-null value is passed in and
the host value is null, then an exception is thrown.
Parameters:
p_userinfo - the userinfo for this URI
throws:
MalformedURIException - if p_userinfo contains invalidcharacters |
| toString | | public String toString()(Code) | | Get the URI as a string specification. See RFC 2396 Section 5.2.
the URI string specification |
|
|