Top Description Inners Fields Constructors Methods
org.apache.xerces.util

public Class URI

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.IOException, .Serializable, java.util.Locale
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, 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 1226507 2012-01-02 18:45:01Z mrglavas $

Nested and Inner Type Summary

Modifier and TypeClass and Description
public 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.

Field Summary

Modifier and TypeField and Description
private static final int
ASCII_ALPHA_CHARACTERS

ASCII letter characters

private static final int
ASCII_DIGIT_CHARACTERS

ASCII digit characters

private static final int
ASCII_HEX_CHARACTERS

ASCII hex characters

private static final byte[]
fgLookupTable

private String
m_fragment

If specified, stores the fragment for this URI; otherwise null

private String
m_host

If specified, stores the host for this URI; otherwise null

private String
m_path

If specified, stores the path for this URI; otherwise null

private int
m_port

If specified, stores the port for this URI; otherwise -1

private String
m_queryString

If specified, stores the query string for this URI; otherwise null.

private String
m_regAuthority

If specified, stores the registry based authority for this URI; otherwise -1

private String
m_scheme

Stores the scheme (usually the protocol) for this URI.

private String
m_userinfo

If specified, stores the userinfo for this URI; otherwise null

private static final int
MARK_CHARACTERS

URI punctuation mark characters: -_.!~*'() - these, combined with alphanumerics, constitute the "unreserved" characters

private static final int
MASK_ALPHA_NUMERIC

Mask for alpha-numeric characters

private static final int
MASK_PATH_CHARACTER

Mask for path characters

private static final int
MASK_SCHEME_CHARACTER

Mask for scheme characters

private static final int
MASK_UNRESERVED_MASK

Mask for unreserved characters

private static final int
MASK_URI_CHARACTER

Mask for URI allowable characters except for %

private static final int
MASK_USERINFO_CHARACTER

Mask for userinfo characters

private static final int
PATH_CHARACTERS

Path characters

private static final int
RESERVED_CHARACTERS

reserved characters ;/?:@&=+$,[]

private static final int
SCHEME_CHARACTERS

scheme can be composed of alphanumerics and these characters: +-.

pack-priv static final long
serialVersionUID

Serialization version.

private static final int
USERINFO_CHARACTERS

userinfo can be composed of unreserved, escaped and these characters: ;:&=+$,

Constructor Summary

AccessConstructor and Description
public
URI()

Construct a new and uninitialized URI.

public
URI(URI
the URI to copy (cannot be null)
p_other)

Construct a new URI from another URI.

public
URI(String
the URI specification string (cannot be null or empty)
p_uriSpec)

Construct a new URI from a URI specification string.

public
URI(String
the URI specification string (cannot be null or empty)
p_uriSpec, boolean
true to permit non-absolute URIs, false otherwise.
allowNonAbsoluteURI)

Construct a new URI from a URI specification string.

public
URI(URI
the base URI (cannot be null if p_uriSpec is null or empty)
p_base, String
the URI specification string (cannot be null or empty if p_base is null)
p_uriSpec)

Construct a new URI from a base URI and a URI specification string.

public
URI(URI
the base URI (cannot be null if p_uriSpec is null or empty)
p_base, String
the URI specification string (cannot be null or empty if p_base is null)
p_uriSpec, boolean
true to permit non-absolute URIs, false otherwise.
allowNonAbsoluteURI)

Construct a new URI from a base URI and a URI specification string.

public
URI(String
the URI scheme (cannot be null or empty)
p_scheme, String
the scheme-specific part (cannot be null or empty)
p_schemeSpecificPart)

Construct a new URI that does not follow the generic URI syntax.

public
URI(String
the URI scheme (cannot be null or empty)
p_scheme, String
the hostname, IPv4 address or IPv6 reference for the URI
p_host, String
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_path, String
the URI query string (cannot be specified if path is null)
p_queryString, String
the URI fragment (cannot be specified if path is null)
p_fragment)

Construct a new URI that follows the generic URI syntax from its component parts.

public
URI(String
the URI scheme (cannot be null or empty)
p_scheme, String
the URI userinfo (cannot be specified if host is null)
p_userinfo, String
the hostname, IPv4 address or IPv6 reference for the URI
p_host, int
the URI port (may be -1 for "unspecified"; cannot be specified if host is null)
p_port, String
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_path, String
the URI query string (cannot be specified if path is null)
p_queryString, String
the URI fragment (cannot be specified if path is null)
p_fragment)

Construct a new URI that follows the generic URI syntax from its component parts.

Method Summary

Modifier and TypeMethod and Description
public void
absolutize(URI
base URI for absolutization
p_base)

Absolutize URI with given base URI.

public void
appendPath(String
the new segment to be added to the current path
p_addToPath)

Append to the end of the path of this URI.

public boolean

Returns:

true if p_test is a URI with all values equal to this URI, false otherwise
equals(Object
the Object to test for equality.
p_test)

Overrides java.lang.Object.equals.

Determines if the passed-in Object is equivalent to this URI.
public String

Returns:

the authority
getAuthority()

Get the authority for this URI.

public String

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.
getFragment()

Get the fragment for this URI.

public String

Returns:

the host for this URI (null if not specified).
getHost()

Get the host for this URI.

public String

Returns:

the path for this URI possibly including the query string and fragment
getPath(boolean
if true (and query string is not null), then a "?" followed by the query string will be appended
p_includeQueryString, boolean
if true (and fragment is not null), then a "#" followed by the fragment will be appended
p_includeFragment)

Get the path for this URI (optionally with the query string and fragment).

public String

Returns:

the path for this URI.
getPath()

Get the path for this URI.

public int

Returns:

the port for this URI (-1 if not specified).
getPort()

Get the port for this URI.

public String

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.
getQueryString()

Get the query string for this URI.

public String

Returns:

the registry based authority (null if not specified).
getRegBasedAuthority()

Get the registry based authority for this URI.

public String

Returns:

the scheme for this URI
getScheme()

Get the scheme for this URI.

public String

Returns:

the scheme-specific part for this URI
getSchemeSpecificPart()

Get the scheme-specific part for this URI (everything following the scheme and the first colon).

public String

Returns:

the userinfo for this URI (null if not specified).
getUserinfo()

Get the userinfo for this URI.

private void
initialize(URI
the URI to copy (cannot be null)
p_other)

Initialize all fields of this URI from another URI.

private void
initialize(URI
the base URI (may be null if p_uriSpec is an absolute URI)
p_base, String
the URI spec string which may be an absolute or relative URI (can only be null/empty if p_base is not null)
p_uriSpec, boolean
true to permit non-absolute URIs, in case of relative URI, false otherwise.
allowNonAbsoluteURI)

Initializes this URI from a base URI and a URI specification string.

private void
initialize(URI
the base URI (may be null if p_uriSpec is an absolute URI)
p_base, String
the URI spec string which may be an absolute or relative URI (can only be null/empty if p_base is not null)
p_uriSpec)

Initializes this URI from a base URI and a URI specification string.

private boolean

Returns:

true if the given string matched server or registry based authority
initializeAuthority(String
the URI specification (cannot be null)
p_uriSpec)

Initialize the authority (either server or registry based) for this URI from a URI string spec.

private void
initializePath(String
the URI specification (cannot be null)
p_uriSpec, int
the index to begin scanning from
p_nStartIndex)

Initialize the path for this URI from a URI string spec.

private void
initializeScheme(String
the URI specification (cannot be null)
p_uriSpec)

Initialize the scheme for this URI from a URI string spec.

public boolean

Returns:

true if this URI represents an absolute URI, false otherwise
isAbsoluteURI()

Returns whether this URI represents an absolute URI.

private static boolean

Returns:

true if the char is alphabetic, false otherwise
isAlpha(char p_char)

Determine whether a char is an alphabetic character: a-z or A-Z

private static boolean

Returns:

true if the char is alphanumeric, false otherwise
isAlphanum(char p_char)

Determine whether a char is an alphanumeric: 0-9, a-z or A-Z

public static boolean

Returns:

true if the scheme is conformant, false otherwise
isConformantSchemeName(String p_scheme)

Determine whether a scheme conforms to the rules for a scheme name.

private static boolean

Returns:

true if the char is betweeen '0' and '9', false otherwise
isDigit(char p_char)

Determine whether a char is a digit.

public boolean

Returns:

true if this URI uses the "generic URI" syntax, false otherwise
isGenericURI()

Get the indicator as to whether this URI uses the "generic URI" syntax.

private static boolean

Returns:

true if the char is betweeen '0' and '9', 'a' and 'f' or 'A' and 'F', false otherwise
isHex(char p_char)

Determine whether a character is a hexadecimal character.

private static boolean

Returns:

true if the char is a path character, false otherwise
isPathCharacter(char p_char)

Determine whether a char is a path character.

private static boolean

Returns:

true if the string contains any reserved characters
isReservedCharacter(char p_char)

Determine whether a character is a reserved character: ';', '/', '?', ':', '@', '&', '=', '+', '$', ',', '[', or ']'

private static boolean

Returns:

true if the char is a scheme character, false otherwise
isSchemeCharacter(char p_char)

Determine whether a char is a scheme character.

private static boolean

Returns:

true if the char is unreserved, false otherwise
isUnreservedCharacter(char p_char)

Determine whether a char is an unreserved character.

private static boolean

Returns:

true if the char is a URI character, false otherwise
isURICharacter(char p_char)

Determine whether a char is a URI character (reserved or unreserved, not including '%' for escaped octets).

private static boolean

Returns:

true if the string is comprised of uric, false otherwise
isURIString(String p_uric)

Determine whether a given string contains only URI characters (also called "uric" in RFC 2396).

private static boolean

Returns:

true if the char is a userinfo character, false otherwise
isUserinfoCharacter(char p_char)

Determine whether a char is a userinfo character.

private boolean

Returns:

true if the given string is a registry based authority
isValidRegistryBasedAuthority(String
the authority component of a URI
authority)

Determines whether the given string is a registry based authority.

private boolean

Returns:

true if the given host, port, and userinfo compose a valid server authority
isValidServerBasedAuthority(String
the host component of authority
host, int
the port number component of authority
port, String
the user info component of authority
userinfo)

Determines whether the components host, port, and user info are valid as a server authority.

public static boolean

Returns:

true if the string is a syntactically valid IPv4 address, IPv6 reference or hostname
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.

public static boolean

Returns:

true if the string is a syntactically valid IPv4 address
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.

public static boolean

Returns:

true if the string is a syntactically valid IPv6 reference
isWellFormedIPv6Reference(String address)

Determines whether a string is an IPv6 reference as defined by RFC 2732, where IPv6address is defined in RFC 2373.

private static int

Returns:

the index of the next character to scan, or -1 if the string cannot match a valid IPv6 address
scanHexSequence(String
the string to be scanned
address, int
the beginning index (inclusive)
index, int
the ending index (exclusive)
end, int[]
a counter for the number of 16-bit sections read in the address
counter)

Helper method for isWellFormedIPv6Reference which scans the hex sequences of an IPv6 address.

public void
setFragment(String
the fragment for this URI
p_fragment)

Set the fragment for this URI.

public void
setHost(String
the host for this URI
p_host)

Set the host for this URI.

public void
setPath(String
the path for this URI (may be null)
p_path)

Set the path for this URI.

public void
setPort(int
the port number for this URI
p_port)

Set the port for this URI.

public void
setQueryString(String
the query string for this URI
p_queryString)

Set the query string for this URI.

public void
setRegBasedAuthority(String
the registry based authority for this URI
authority)

Sets the registry based authority for this URI.

public void
setScheme(String
the scheme for this URI (cannot be null)
p_scheme)

Set the scheme for this URI.

public void
setUserinfo(String
the userinfo for this URI
p_userinfo)

Set the userinfo for this URI.

public String

Returns:

the URI string specification
toString()

Overrides java.lang.Object.toString.

Get the URI as a string specification.
Inherited from java.lang.Object:
clonefinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

ASCII_ALPHA_CHARACTERSback to summary
private static final int ASCII_ALPHA_CHARACTERS

ASCII letter characters

ASCII_DIGIT_CHARACTERSback to summary
private static final int ASCII_DIGIT_CHARACTERS

ASCII digit characters

ASCII_HEX_CHARACTERSback to summary
private static final int ASCII_HEX_CHARACTERS

ASCII hex characters

fgLookupTableback to summary
private static final byte[] fgLookupTable
m_fragmentback to summary
private String m_fragment

If specified, stores the fragment for this URI; otherwise null

m_hostback to summary
private String m_host

If specified, stores the host for this URI; otherwise null

m_pathback to summary
private String m_path

If specified, stores the path for this URI; otherwise null

m_portback to summary
private int m_port

If specified, stores the port for this URI; otherwise -1

m_queryStringback to summary
private String m_queryString

If specified, stores the query string for this URI; otherwise null.

m_regAuthorityback to summary
private String m_regAuthority

If specified, stores the registry based authority for this URI; otherwise -1

m_schemeback to summary
private String m_scheme

Stores the scheme (usually the protocol) for this URI.

m_userinfoback to summary
private String m_userinfo

If specified, stores the userinfo for this URI; otherwise null

MARK_CHARACTERSback to summary
private static final int MARK_CHARACTERS

URI punctuation mark characters: -_.!~*'() - these, combined with alphanumerics, constitute the "unreserved" characters

MASK_ALPHA_NUMERICback to summary
private static final int MASK_ALPHA_NUMERIC

Mask for alpha-numeric characters

MASK_PATH_CHARACTERback to summary
private static final int MASK_PATH_CHARACTER

Mask for path characters

MASK_SCHEME_CHARACTERback to summary
private static final int MASK_SCHEME_CHARACTER

Mask for scheme characters

MASK_UNRESERVED_MASKback to summary
private static final int MASK_UNRESERVED_MASK

Mask for unreserved characters

MASK_URI_CHARACTERback to summary
private static final int MASK_URI_CHARACTER

Mask for URI allowable characters except for %

MASK_USERINFO_CHARACTERback to summary
private static final int MASK_USERINFO_CHARACTER

Mask for userinfo characters

PATH_CHARACTERSback to summary
private static final int PATH_CHARACTERS

Path characters

RESERVED_CHARACTERSback to summary
private static final int RESERVED_CHARACTERS

reserved characters ;/?:@&=+$,[]

SCHEME_CHARACTERSback to summary
private static final int SCHEME_CHARACTERS

scheme can be composed of alphanumerics and these characters: +-.

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Serialization version.

USERINFO_CHARACTERSback to summary
private static final int USERINFO_CHARACTERS

userinfo can be composed of unreserved, escaped and these characters: ;:&=+$,

Constructor Detail

URIback to summary
public URI()

Construct a new and uninitialized URI.

URIback to summary
public URI(URI p_other)

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:URI

the URI to copy (cannot be null)

URIback to summary
public URI(String p_uriSpec) throws MalformedURIException

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:String

the URI specification string (cannot be null or empty)

Exceptions
MalformedURIException:
if p_uriSpec violates any syntax rules
URIback to summary
public URI(String p_uriSpec, boolean allowNonAbsoluteURI) throws MalformedURIException

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. Construct a relative URI if boolean is assigned to "true" and p_uriSpec is not valid absolute URI, instead of throwing an exception.

Parameters
p_uriSpec:String

the URI specification string (cannot be null or empty)

allowNonAbsoluteURI:boolean

true to permit non-absolute URIs, false otherwise.

Exceptions
MalformedURIException:
if p_uriSpec violates any syntax rules
URIback to summary
public URI(URI p_base, String p_uriSpec) throws MalformedURIException

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:URI

the base URI (cannot be null if p_uriSpec is null or empty)

p_uriSpec:String

the URI specification string (cannot be null or empty if p_base is null)

Exceptions
MalformedURIException:
if p_uriSpec violates any syntax rules
URIback to summary
public URI(URI p_base, String p_uriSpec, boolean allowNonAbsoluteURI) throws MalformedURIException

Construct a new URI from a base URI and a URI specification string. The URI specification string may be a relative URI. Construct a relative URI if boolean is assigned to "true" and p_uriSpec is not valid absolute URI and p_base is null instead of throwing an exception.

Parameters
p_base:URI

the base URI (cannot be null if p_uriSpec is null or empty)

p_uriSpec:String

the URI specification string (cannot be null or empty if p_base is null)

allowNonAbsoluteURI:boolean

true to permit non-absolute URIs, false otherwise.

Exceptions
MalformedURIException:
if p_uriSpec violates any syntax rules
URIback to summary
public URI(String p_scheme, String p_schemeSpecificPart) throws MalformedURIException

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:String

the URI scheme (cannot be null or empty)

p_schemeSpecificPart:String

the scheme-specific part (cannot be null or empty)

Exceptions
MalformedURIException:
if p_scheme violates any syntax rules
URIback to summary
public URI(String p_scheme, String p_host, String p_path, String p_queryString, String p_fragment) throws MalformedURIException

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:String

the URI scheme (cannot be null or empty)

p_host:String

the hostname, IPv4 address or IPv6 reference for the URI

p_path:String

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:String

the URI query string (cannot be specified if path is null)

p_fragment:String

the URI fragment (cannot be specified if path is null)

Exceptions
MalformedURIException:
if any of the parameters violates syntax rules or semantic rules
URIback to summary
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

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:String

the URI scheme (cannot be null or empty)

p_userinfo:String

the URI userinfo (cannot be specified if host is null)

p_host:String

the hostname, IPv4 address or IPv6 reference for the URI

p_port:int

the URI port (may be -1 for "unspecified"; cannot be specified if host is null)

p_path:String

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:String

the URI query string (cannot be specified if path is null)

p_fragment:String

the URI fragment (cannot be specified if path is null)

Exceptions
MalformedURIException:
if any of the parameters violates syntax rules or semantic rules

Method Detail

absolutizeback to summary
public void absolutize(URI p_base)

Absolutize URI with given base URI.

Parameters
p_base:URI

base URI for absolutization

appendPathback to summary
public void appendPath(String p_addToPath) throws MalformedURIException

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:String

the new segment to be added to the current path

Exceptions
MalformedURIException:
if p_addToPath contains syntax errors
equalsback to summary
public boolean equals(Object p_test)

Overrides java.lang.Object.equals.

Determines if the passed-in Object is equivalent to this URI.

Parameters
p_test:Object

the Object to test for equality.

Returns:boolean

true if p_test is a URI with all values equal to this URI, false otherwise

getAuthorityback to summary
public String getAuthority()

Get the authority for this URI.

Returns:String

the authority

getFragmentback to summary
public String getFragment()

Get the fragment for this URI.

Returns:String

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.

getHostback to summary
public String getHost()

Get the host for this URI.

Returns:String

the host for this URI (null if not specified).

getPathback to summary
public String getPath(boolean p_includeQueryString, boolean p_includeFragment)

Get the path for this URI (optionally with the query string and fragment).

Parameters
p_includeQueryString:boolean

if true (and query string is not null), then a "?" followed by the query string will be appended

p_includeFragment:boolean

if true (and fragment is not null), then a "#" followed by the fragment will be appended

Returns:String

the path for this URI possibly including the query string and fragment

getPathback to summary
public String getPath()

Get the path for this URI. Note that the value returned is the path only and does not include the query string or fragment.

Returns:String

the path for this URI.

getPortback to summary
public int getPort()

Get the port for this URI.

Returns:int

the port for this URI (-1 if not specified).

getQueryStringback to summary
public String getQueryString()

Get the query string for this URI.

Returns:String

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.

getRegBasedAuthorityback to summary
public String getRegBasedAuthority()

Get the registry based authority for this URI.

Returns:String

the registry based authority (null if not specified).

getSchemeback to summary
public String getScheme()

Get the scheme for this URI.

Returns:String

the scheme for this URI

getSchemeSpecificPartback to summary
public String getSchemeSpecificPart()

Get the scheme-specific part for this URI (everything following the scheme and the first colon). See RFC 2396 Section 5.2 for spec.

Returns:String

the scheme-specific part for this URI

getUserinfoback to summary
public String getUserinfo()

Get the userinfo for this URI.

Returns:String

the userinfo for this URI (null if not specified).

initializeback to summary
private void initialize(URI p_other)

Initialize all fields of this URI from another URI.

Parameters
p_other:URI

the URI to copy (cannot be null)

initializeback to summary
private void initialize(URI p_base, String p_uriSpec, boolean allowNonAbsoluteURI) throws MalformedURIException

Initializes this URI from a base URI and a URI specification string. See RFC 2396 Section 4 and Appendix B for specifications on parsing the URI and Section 5 for specifications on resolving relative URIs and relative paths.

Parameters
p_base:URI

the base URI (may be null if p_uriSpec is an absolute URI)

p_uriSpec:String

the URI spec string which may be an absolute or relative URI (can only be null/empty if p_base is not null)

allowNonAbsoluteURI:boolean

true to permit non-absolute URIs, in case of relative URI, false otherwise.

Exceptions
MalformedURIException:
if p_base is null and p_uriSpec is not an absolute URI or if p_uriSpec violates syntax rules
initializeback to summary
private void initialize(URI p_base, String p_uriSpec) throws MalformedURIException

Initializes this URI from a base URI and a URI specification string. See RFC 2396 Section 4 and Appendix B for specifications on parsing the URI and Section 5 for specifications on resolving relative URIs and relative paths.

Parameters
p_base:URI

the base URI (may be null if p_uriSpec is an absolute URI)

p_uriSpec:String

the URI spec string which may be an absolute or relative URI (can only be null/empty if p_base is not null)

Exceptions
MalformedURIException:
if p_base is null and p_uriSpec is not an absolute URI or if p_uriSpec violates syntax rules
initializeAuthorityback to summary
private boolean initializeAuthority(String p_uriSpec)

Initialize the authority (either server or registry based) for this URI from a URI string spec.

Parameters
p_uriSpec:String

the URI specification (cannot be null)

Returns:boolean

true if the given string matched server or registry based authority

initializePathback to summary
private void initializePath(String p_uriSpec, int p_nStartIndex) throws MalformedURIException

Initialize the path for this URI from a URI string spec.

Parameters
p_uriSpec:String

the URI specification (cannot be null)

p_nStartIndex:int

the index to begin scanning from

Exceptions
MalformedURIException:
if p_uriSpec violates syntax rules
initializeSchemeback to summary
private void initializeScheme(String p_uriSpec) throws MalformedURIException

Initialize the scheme for this URI from a URI string spec.

Parameters
p_uriSpec:String

the URI specification (cannot be null)

Exceptions
MalformedURIException:
if URI does not have a conformant scheme
isAbsoluteURIback to summary
public boolean isAbsoluteURI()

Returns whether this URI represents an absolute URI.

Returns:boolean

true if this URI represents an absolute URI, false otherwise

isAlphaback to summary
private static boolean isAlpha(char p_char)

Determine whether a char is an alphabetic character: a-z or A-Z

Returns:boolean

true if the char is alphabetic, false otherwise

isAlphanumback to summary
private static boolean isAlphanum(char p_char)

Determine whether a char is an alphanumeric: 0-9, a-z or A-Z

Returns:boolean

true if the char is alphanumeric, false otherwise

isConformantSchemeNameback to summary
public static boolean isConformantSchemeName(String p_scheme)

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 '.'.

Returns:boolean

true if the scheme is conformant, false otherwise

isDigitback to summary
private static boolean isDigit(char p_char)

Determine whether a char is a digit.

Returns:boolean

true if the char is betweeen '0' and '9', false otherwise

isGenericURIback to summary
public boolean isGenericURI()

Get the indicator as to whether this URI uses the "generic URI" syntax.

Returns:boolean

true if this URI uses the "generic URI" syntax, false otherwise

isHexback to summary
private static boolean isHex(char p_char)

Determine whether a character is a hexadecimal character.

Returns:boolean

true if the char is betweeen '0' and '9', 'a' and 'f' or 'A' and 'F', false otherwise

isPathCharacterback to summary
private static boolean isPathCharacter(char p_char)

Determine whether a char is a path character.

Returns:boolean

true if the char is a path character, false otherwise

isReservedCharacterback to summary
private static boolean isReservedCharacter(char p_char)

Determine whether a character is a reserved character: ';', '/', '?', ':', '@', '&', '=', '+', '$', ',', '[', or ']'

Returns:boolean

true if the string contains any reserved characters

isSchemeCharacterback to summary
private static boolean isSchemeCharacter(char p_char)

Determine whether a char is a scheme character.

Returns:boolean

true if the char is a scheme character, false otherwise

isUnreservedCharacterback to summary
private static boolean isUnreservedCharacter(char p_char)

Determine whether a char is an unreserved character.

Returns:boolean

true if the char is unreserved, false otherwise

isURICharacterback to summary
private static boolean isURICharacter(char p_char)

Determine whether a char is a URI character (reserved or unreserved, not including '%' for escaped octets).

Returns:boolean

true if the char is a URI character, false otherwise

isURIStringback to summary
private static boolean isURIString(String p_uric)

Determine whether a given string contains only URI characters (also called "uric" in RFC 2396). uric consist of all reserved characters, unreserved characters and escaped characters.

Returns:boolean

true if the string is comprised of uric, false otherwise

isUserinfoCharacterback to summary
private static boolean isUserinfoCharacter(char p_char)

Determine whether a char is a userinfo character.

Returns:boolean

true if the char is a userinfo character, false otherwise

isValidRegistryBasedAuthorityback to summary
private boolean isValidRegistryBasedAuthority(String authority)

Determines whether the given string is a registry based authority.

Parameters
authority:String

the authority component of a URI

Returns:boolean

true if the given string is a registry based authority

isValidServerBasedAuthorityback to summary
private boolean isValidServerBasedAuthority(String host, int port, String userinfo)

Determines whether the components host, port, and user info are valid as a server authority.

Parameters
host:String

the host component of authority

port:int

the port number component of authority

userinfo:String

the user info component of authority

Returns:boolean

true if the given host, port, and userinfo compose a valid server authority

isWellFormedAddressback to summary
public 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. A valid IPv4 address consists of four decimal digit groups separated by a '.'. Each group must consist of one to three digits. See RFC 2732 Section 3, and RFC 2373 Section 2.2, for the definition of IPv6 references. 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.

Returns:boolean

true if the string is a syntactically valid IPv4 address, IPv6 reference or hostname

isWellFormedIPv4Addressback to summary
public 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. 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:boolean

true if the string is a syntactically valid IPv4 address

isWellFormedIPv6Referenceback to summary
public 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. 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:boolean

true if the string is a syntactically valid IPv6 reference

scanHexSequenceback to summary
private static int scanHexSequence(String address, int index, int end, int[] counter)

Helper method for isWellFormedIPv6Reference which scans the hex sequences of an IPv6 address. It returns the index of the next character to scan in the address, or -1 if the string cannot match a valid IPv6 address.

Parameters
address:String

the string to be scanned

index:int

the beginning index (inclusive)

end:int

the ending index (exclusive)

counter:int[]

a counter for the number of 16-bit sections read in the address

Returns:int

the index of the next character to scan, or -1 if the string cannot match a valid IPv6 address

setFragmentback to summary
public void setFragment(String p_fragment) throws MalformedURIException

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:String

the fragment for this URI

Exceptions
MalformedURIException:
if p_fragment is not null and this URI does not conform to the generic URI syntax or if the path is null
setHostback to summary
public void setHost(String p_host) throws MalformedURIException

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:String

the host for this URI

Exceptions
MalformedURIException:
if p_host is not a valid IP address or DNS hostname.
setPathback to summary
public void setPath(String p_path) throws MalformedURIException

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:String

the path for this URI (may be null)

Exceptions
MalformedURIException:
if p_path contains invalid characters
setPortback to summary
public void setPort(int p_port) throws MalformedURIException

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:int

the port number for this URI

Exceptions
MalformedURIException:
if p_port is not -1 and not a valid port number
setQueryStringback to summary
public void setQueryString(String p_queryString) throws MalformedURIException

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:String

the query string for this URI

Exceptions
MalformedURIException:
if p_queryString is not null and this URI does not conform to the generic URI syntax or if the path is null
setRegBasedAuthorityback to summary
public void setRegBasedAuthority(String authority) throws MalformedURIException

Sets the registry based authority for this URI.

Note

This method overwrites server based authority if it previously existed in this URI.

Parameters
authority:String

the registry based authority for this URI

Exceptions
MalformedURIException:
it authority is not a well formed registry based authority
setSchemeback to summary
public void setScheme(String p_scheme) throws MalformedURIException

Set the scheme for this URI. The scheme is converted to lowercase before it is set.

Parameters
p_scheme:String

the scheme for this URI (cannot be null)

Exceptions
MalformedURIException:
if p_scheme is not a conformant scheme name
setUserinfoback to summary
public void setUserinfo(String p_userinfo) throws MalformedURIException

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:String

the userinfo for this URI

Exceptions
MalformedURIException:
if p_userinfo contains invalid characters
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Get the URI as a string specification. See RFC 2396 Section 5.2.

Returns:String

the URI string specification

org.apache.xerces.util back to summary

public Class URI.MalformedURIException

extends IOException
Class Inheritance
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.

Field Summary

Modifier and TypeField and Description
pack-priv static final long
serialVersionUID

Hides java.io.IOException.serialVersionUID.

Serialization version.

Constructor Summary

AccessConstructor and Description
public
MalformedURIException()

Constructs a MalformedURIException with no specified detail message.

public
MalformedURIException(String
the detail message.
p_msg)

Constructs a MalformedURIException with the specified detail message.

Field Detail

serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides java.io.IOException.serialVersionUID.

Serialization version.

Constructor Detail

MalformedURIExceptionback to summary
public MalformedURIException()

Constructs a MalformedURIException with no specified detail message.

MalformedURIExceptionback to summary
public MalformedURIException(String p_msg)

Constructs a MalformedURIException with the specified detail message.

Parameters
p_msg:String

the detail message.