URI (SoapUI 5.6.0 SDK)

All Implemented Interfaces and Traits:: java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

public class URI

The interface for the URI(Uniform Resource Identifiers) version of RFC 2396. This class has the purpose of supportting of parsing a URI reference to extend any specific protocols, the character encoding of the protocol to be transported and the charset of the document.

A URI is always in an "escaped" form, since escaping or unescaping a completed URI might change its semantics.

Implementers should be careful not to escape or unescape the same string more than once, since unescaping an already unescaped string might lead to misinterpreting a percent data character as another escaped character, or vice versa in the case of escaping an already escaped string.

In order to avoid these problems, data types used as follows:

   URI character sequence: char
   octet sequence: byte
   original character sequence: String

So, a URI is a sequence of characters as an array of a char type, which is not always represented as a sequence of octets as an array of byte.

URI Syntactic Components

 - In general, written as follows:
   Absolute URI = <scheme>:<scheme-specific-part>
   Generic URI = <scheme>://<authority><path>?<query>
 
 - Syntax
   absoluteURI   = scheme ":" ( hier_part | opaque_part )
   hier_part     = ( net_path | abs_path ) [ "?" query ]
   net_path      = "//" authority [ abs_path ]
   abs_path      = "/"  path_segments

The following examples illustrate URI that are in common use.

 ftp://ftp.is.co.za/rfc/rfc1808.txt
    -- ftp scheme for File Transfer Protocol services
 gopher://spinaltap.micro.umn.edu/00/Weather/California/Los%20Angeles
    -- gopher scheme for Gopher and Gopher+ Protocol services
 http://www.math.uio.no/faq/compression-faq/part1.html
    -- http scheme for Hypertext Transfer Protocol services
 mailto:mduerstifi.unizh.ch:
-- mailto scheme for electronic mail addresses
 news:comp.infosystems.www.servers.unix
    -- news scheme for USENET news groups and articles
 telnet://melvyl.ucop.edu/
    -- telnet scheme for interactive services via the TELNET Protocol

Please, notice that there are many modifications from URL(RFC 1738) and relative URL(RFC 1808).

The expressions for a URI

 For escaped URI forms
  - URI(char[]) // constructor
  - char[] getRawXxx() // method
  - String getEscapedXxx() // method
  - String toString() // method
 
 For unescaped URI forms
  - URI(String) // constructor
  - String getXXX() // method

Authors:: Sung-Gu; Mike Bowler

Version:: \$Revision: 564973 \$ \$Date: 2002/03/14 15:14:01

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`URI.DefaultCharsetChanged`	The charset-changed normal operation to represent to be required to alert to user the fact the default charset is changed.
`static class`	`URI.LocaleToCharsetMap`	A mapping to determine the (somewhat arbitrarily) preferred charset for a given locale.

Field Summary

Fields
Modifiers	Name	Description
`static java.util.BitSet`	`allowed_IPv6reference`	Those characters that are allowed for the IPv6reference component.
`static java.util.BitSet`	`allowed_abs_path`	Those characters that are allowed for the abs_path.
`static java.util.BitSet`	`allowed_authority`	Those characters that are allowed for the authority component.
`static java.util.BitSet`	`allowed_fragment`	Those characters that are allowed for the fragment component.
`static java.util.BitSet`	`allowed_host`	Those characters that are allowed for the host component.
`static java.util.BitSet`	`allowed_opaque_part`	Those characters that are allowed for the opaque_part.
`static java.util.BitSet`	`allowed_query`	Those characters that are allowed for the query component.
`static java.util.BitSet`	`allowed_reg_name`	Those characters that are allowed for the reg_name.
`static java.util.BitSet`	`allowed_rel_path`	Those characters that are allowed for the rel_path.
`static java.util.BitSet`	`allowed_userinfo`	Those characters that are allowed for the userinfo component.
`static java.util.BitSet`	`allowed_within_authority`	Those characters that are allowed for the authority component.
`static java.util.BitSet`	`allowed_within_path`	Those characters that are allowed within the path.
`static java.util.BitSet`	`allowed_within_query`	Those characters that are allowed within the query component.
`static java.util.BitSet`	`allowed_within_userinfo`	Those characters that are allowed for within the userinfo component.
`static java.util.BitSet`	`control`	BitSet for control.
`static java.util.BitSet`	`delims`	BitSet for delims.
`static java.util.BitSet`	`disallowed_opaque_part`	Disallowed opaque_part before escaping.
`static java.util.BitSet`	`disallowed_rel_path`	Disallowed rel_path before escaping.
`static java.util.BitSet`	`space`	BitSet for space.
`static java.util.BitSet`	`unwise`	BitSet for unwise.
`static java.util.BitSet`	`within_userinfo`	BitSet for within the userinfo component like user and password.

Constructor Summary

Constructors
Constructor and description
`URI (java.lang.String s, boolean escaped, java.lang.String charset)` Construct a URI from a string with the given charset.
`URI (java.lang.String s, boolean escaped)` Construct a URI from a string with the given charset.
`URI (char[] escaped, java.lang.String charset)` Construct a URI as an escaped form of a character array with the given charset.
`URI (char[] escaped)` Construct a URI as an escaped form of a character array.
`URI (java.lang.String original, java.lang.String charset)` Construct a URI from the given string with the given charset.
`URI (java.lang.String original)` Construct a URI from the given string.
`URI (java.lang.String scheme, java.lang.String schemeSpecificPart, java.lang.String fragment)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String fragment)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query, java.lang.String fragment)` Construct a general URI from the given components.
`URI (java.lang.String scheme, java.lang.String host, java.lang.String path, java.lang.String fragment)` Construct a general URI from the given components.
`URI (URI base, java.lang.String relative)` Construct a general URI with the given relative URI string.
`URI (URI base, java.lang.String relative, boolean escaped)` Construct a general URI with the given relative URI string.
`URI (URI base, URI relative)` Construct a general URI with the given relative URI.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`clone()` Create and return a copy of this object, the URI-reference containing the userinfo component.
	`int`	`compareTo(java.lang.Object obj)` Compare this URI to another object.
	`boolean`	`equals(java.lang.Object obj)` Test an object if this URI is equal to another.
	`java.lang.String`	`getAboveHierPath()` Get the level above the this hierarchy level.
	`java.lang.String`	`getAuthority()` Get the authority.
	`java.lang.String`	`getCurrentHierPath()` Get the current hierarchy level.
	`static java.lang.String`	`getDefaultDocumentCharset()` Get the recommended default charset of the document.
	`static java.lang.String`	`getDefaultDocumentCharsetByLocale()` Get the default charset of the document by locale.
	`static java.lang.String`	`getDefaultDocumentCharsetByPlatform()` Get the default charset of the document by platform.
	`static java.lang.String`	`getDefaultProtocolCharset()` Get the default charset of the protocol.
	`java.lang.String`	`getEscapedAboveHierPath()` Get the level above the this hierarchy level.
	`java.lang.String`	`getEscapedAuthority()` Get the escaped authority.
	`java.lang.String`	`getEscapedCurrentHierPath()` Get the escaped current hierarchy level.
	`java.lang.String`	`getEscapedFragment()` Get the escaped fragment.
	`java.lang.String`	`getEscapedName()` Get the escaped basename of the path.
	`java.lang.String`	`getEscapedPath()` Get the escaped path.
	`java.lang.String`	`getEscapedPathQuery()` Get the escaped query.
	`java.lang.String`	`getEscapedQuery()` Get the escaped query.
	`java.lang.String`	`getEscapedURI()` It can be gotten the URI character sequence.
	`java.lang.String`	`getEscapedURIReference()` Get the escaped URI reference string.
	`java.lang.String`	`getEscapedUserinfo()` Get the escaped userinfo.
	`java.lang.String`	`getFragment()` Get the fragment.
	`java.lang.String`	`getHost()` Get the host.
	`java.lang.String`	`getName()` Get the basename of the path.
	`java.lang.String`	`getPath()` Get the path.
	`java.lang.String`	`getPathQuery()` Get the path and query.
	`int`	`getPort()` Get the port.
	`java.lang.String`	`getProtocolCharset()` Get the protocol charset used by this current URI instance.
	`java.lang.String`	`getQuery()` Get the query.
	`char[]`	`getRawAboveHierPath()` Get the level above the this hierarchy level.
	`char[]`	`getRawAuthority()` Get the raw-escaped authority.
	`char[]`	`getRawCurrentHierPath()` Get the raw-escaped current hierarchy level.
	`char[]`	`getRawFragment()` Get the raw-escaped fragment.
	`char[]`	`getRawHost()` Get the host.
	`char[]`	`getRawName()` Get the raw-escaped basename of the path.
	`char[]`	`getRawPath()` Get the raw-escaped path.
	`char[]`	`getRawPathQuery()` Get the raw-escaped path and query.
	`char[]`	`getRawQuery()` Get the raw-escaped query.
	`char[]`	`getRawScheme()` Get the scheme.
	`char[]`	`getRawURI()` It can be gotten the URI character sequence.
	`char[]`	`getRawURIReference()` Get the URI reference character sequence.
	`char[]`	`getRawUserinfo()` Get the raw-escaped userinfo.
	`java.lang.String`	`getScheme()` Get the scheme.
	`java.lang.String`	`getURI()` It can be gotten the URI character sequence.
	`java.lang.String`	`getURIReference()` Get the original URI reference string.
	`java.lang.String`	`getUserinfo()` Get the userinfo.
	`boolean`	`hasAuthority()` Tell whether or not this URI has authority.
	`boolean`	`hasFragment()` Tell whether or not this URI has fragment.
	`boolean`	`hasQuery()` Tell whether or not this URI has query.
	`boolean`	`hasUserinfo()` Tell whether or not this URI has userinfo.
	`int`	`hashCode()` Return a hash code for this URI.
	`boolean`	`isAbsPath()` Tell whether or not the relativeURI or hier_part of this URI is abs_path.
	`boolean`	`isAbsoluteURI()` Tell whether or not this URI is absolute.
	`boolean`	`isHierPart()` Tell whether or not the absoluteURI of this URI is hier_part.
	`boolean`	`isHostname()` Tell whether or not the host part of this URI is hostname.
	`boolean`	`isIPv4address()` Tell whether or not the host part of this URI is IPv4address.
	`boolean`	`isIPv6reference()` Tell whether or not the host part of this URI is IPv6reference.
	`boolean`	`isNetPath()` Tell whether or not the relativeURI or heir_part of this URI is net_path.
	`boolean`	`isOpaquePart()` Tell whether or not the absoluteURI of this URI is opaque_part.
	`boolean`	`isRegName()` Tell whether or not the authority component of this URI is reg_name.
	`boolean`	`isRelPath()` Tell whether or not the relativeURI of this URI is rel_path.
	`boolean`	`isRelativeURI()` Tell whether or not this URI is relative.
	`boolean`	`isServer()` Tell whether or not the authority component of this URI is server.
	`void`	`normalize()` Normalizes the path part of this URI.
	`static void`	`setDefaultDocumentCharset(java.lang.String charset)` Set the default charset of the document.
	`static void`	`setDefaultProtocolCharset(java.lang.String charset)` Set the default charset of the protocol.
	`void`	`setEscapedAuthority(java.lang.String escapedAuthority)` Set the authority.
	`void`	`setEscapedFragment(java.lang.String escapedFragment)` Set the escaped fragment string.
	`void`	`setEscapedPath(java.lang.String escapedPath)` Set the escaped path.
	`void`	`setEscapedQuery(java.lang.String escapedQuery)` Set the escaped query string.
	`void`	`setFragment(java.lang.String fragment)` Set the fragment.
	`void`	`setPath(java.lang.String path)` Set the path.
	`void`	`setQuery(java.lang.String query)` Set the query.
	`void`	`setRawAuthority(char[] escapedAuthority)` Set the authority.
	`void`	`setRawFragment(char[] escapedFragment)` Set the raw-escaped fragment.
	`void`	`setRawPath(char[] escapedPath)` Set the raw-escaped path.
	`void`	`setRawQuery(char[] escapedQuery)` Set the raw-escaped query.
	`java.lang.String`	`toString()` Get the escaped URI string.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.util.BitSet allowed_IPv6reference
    
    Those characters that are allowed for the IPv6reference component. The characters '[', ']' in IPv6reference should be excluded.
  - public static final java.util.BitSet allowed_abs_path
    
    Those characters that are allowed for the abs_path.
  - public static final java.util.BitSet allowed_authority
    
    Those characters that are allowed for the authority component.
  - public static final java.util.BitSet allowed_fragment
    
    Those characters that are allowed for the fragment component.
  - public static final java.util.BitSet allowed_host
    
    Those characters that are allowed for the host component. The characters '[', ']' in IPv6reference should be excluded.
  - public static final java.util.BitSet allowed_opaque_part
    
    Those characters that are allowed for the opaque_part.
  - public static final java.util.BitSet allowed_query
    
    Those characters that are allowed for the query component.
  - public static final java.util.BitSet allowed_reg_name
    
    Those characters that are allowed for the reg_name.
  - public static final java.util.BitSet allowed_rel_path
    
    Those characters that are allowed for the rel_path.
  - public static final java.util.BitSet allowed_userinfo
    
    Those characters that are allowed for the userinfo component.
  - public static final java.util.BitSet allowed_within_authority
    
    Those characters that are allowed for the authority component.
  - public static final java.util.BitSet allowed_within_path
    
    Those characters that are allowed within the path.
  - public static final java.util.BitSet allowed_within_query
    
    Those characters that are allowed within the query component.
  - public static final java.util.BitSet allowed_within_userinfo
    
    Those characters that are allowed for within the userinfo component.
  - public static final java.util.BitSet control
    
    BitSet for control.
  - public static final java.util.BitSet delims
    
    BitSet for delims.
  - public static final java.util.BitSet disallowed_opaque_part
    
    Disallowed opaque_part before escaping.
  - public static final java.util.BitSet disallowed_rel_path
    
    Disallowed rel_path before escaping.
  - public static final java.util.BitSet space
    
    BitSet for space.
  - public static final java.util.BitSet unwise
    
    BitSet for unwise.
  - public static final java.util.BitSet within_userinfo
    
    BitSet for within the userinfo component like user and password.
- Constructor Detail
  - public URI(java.lang.String s, boolean escaped, java.lang.String charset)
    
    Construct a URI from a string with the given charset. The input string can be either in escaped or unescaped form.
    throws:
    URIException If the URI cannot be created.
    throws:
    NullPointerException if input string is null
    
    Parameters:
    s - URI character sequence
    escaped - true if URI character sequence is in escaped form. false otherwise.
    charset - the charset string to do escape encoding, if required
    See Also:
    getProtocolCharset
    Since:
    3.0
  - public URI(java.lang.String s, boolean escaped)
    
    Construct a URI from a string with the given charset. The input string can be either in escaped or unescaped form.
    throws:
    URIException If the URI cannot be created.
    throws:
    NullPointerException if input string is null
    
    Parameters:
    s - URI character sequence
    escaped - true if URI character sequence is in escaped form. false otherwise.
    See Also:
    getProtocolCharset
    Since:
    3.0
  - public URI(char[] escaped, java.lang.String charset)
    
    Construct a URI as an escaped form of a character array with the given charset.
    throws:
    URIException If the URI cannot be created.
    throws:
    NullPointerException if escaped is null
    deprecated:
    Use #URI(String, boolean, String)
    
    Parameters:
    escaped - the URI character sequence
    charset - the charset string to do escape encoding
    See Also:
    getProtocolCharset
  - public URI(char[] escaped)
    
    Construct a URI as an escaped form of a character array. An URI can be placed within double-quotes or angle brackets like "http://test.com/" and <http://test.com/>
    throws:
    URIException If the URI cannot be created.
    throws:
    NullPointerException if escaped is null
    deprecated:
    Use #URI(String, boolean)
    
    Parameters:
    escaped - the URI character sequence
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String original, java.lang.String charset)
    
    Construct a URI from the given string with the given charset.
    throws:
    URIException If the URI cannot be created.
    deprecated:
    Use #URI(String, boolean, String)
    
    Parameters:
    original - the string to be represented to URI character sequence It is one of absoluteURI and relativeURI.
    charset - the charset string to do escape encoding
    See Also:
    getProtocolCharset
  - public URI(java.lang.String original)
    
    Construct a URI from the given string.
```
   URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
 
```
    An URI can be placed within double-quotes or angle brackets like "http://test.com/" and <http://test.com/>
    throws:
    URIException If the URI cannot be created.
    deprecated:
    Use #URI(String, boolean)
    
    Parameters:
    original - the string to be represented to URI character sequence It is one of absoluteURI and relativeURI.
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String schemeSpecificPart, java.lang.String fragment)
    
    Construct a general URI from the given components.
```
   URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
   absoluteURI   = scheme ":" ( hier_part | opaque_part )
   opaque_part   = uric_no_slash *uric
 
```
    It's for absolute URI = <scheme>:<scheme-specific-part># <fragment>.
    throws:
    URIException If the URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    schemeSpecificPart - scheme_specific_part
    fragment - the fragment string
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String fragment)
    
    Construct a general URI from the given components.
```
   URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
   absoluteURI   = scheme ":" ( hier_part | opaque_part )
   relativeURI   = ( net_path | abs_path | rel_path ) [ "?" query ]
   hier_part     = ( net_path | abs_path ) [ "?" query ]
 
```
    It's for absolute URI = <scheme>:<path>?<query>#< fragment> and relative URI = <path>?<query>#<fragment >.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    authority - the authority string
    path - the path string
    query - the query string
    fragment - the fragment string
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port)
    
    Construct a general URI from the given components.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    userinfo - the userinfo string
    host - the host string
    port - the port number
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path)
    
    Construct a general URI from the given components.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    userinfo - the userinfo string
    host - the host string
    port - the port number
    path - the path string
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query)
    
    Construct a general URI from the given components.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    userinfo - the userinfo string
    host - the host string
    port - the port number
    path - the path string
    query - the query string
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query, java.lang.String fragment)
    
    Construct a general URI from the given components.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    userinfo - the userinfo string
    host - the host string
    port - the port number
    path - the path string
    query - the query string
    fragment - the fragment string
    See Also:
    getDefaultProtocolCharset
  - public URI(java.lang.String scheme, java.lang.String host, java.lang.String path, java.lang.String fragment)
    
    Construct a general URI from the given components.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    scheme - the scheme string
    host - the host string
    path - the path string
    fragment - the fragment string
    See Also:
    getDefaultProtocolCharset
  - public URI(URI base, java.lang.String relative)
    
    Construct a general URI with the given relative URI string.
    throws:
    URIException If the new URI cannot be created.
    deprecated:
    Use #URI(URI, String, boolean)
    
    Parameters:
    base - the base URI
    relative - the relative URI string
  - public URI(URI base, java.lang.String relative, boolean escaped)
    
    Construct a general URI with the given relative URI string.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    base - the base URI
    relative - the relative URI string
    escaped - true if URI character sequence is in escaped form. false otherwise.
    Since:
    3.0
  - public URI(URI base, URI relative)
    
    Construct a general URI with the given relative URI.
```
   URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
   relativeURI   = ( net_path | abs_path | rel_path ) [ "?" query ]
 
```
    Resolving Relative References to Absolute Form.
    Examples of Resolving Relative URI References
    Within an object with a well-defined base URI of
```
   http://a/b/c/d;p?q
 
```
    the relative URI would be resolved as follows:
    Normal Examples
```
   g:h           =  g:h
   g             =  http://a/b/c/g
   ./g           =  http://a/b/c/g
   g/            =  http://a/b/c/g/
   /g            =  http://a/g
   //g           =  http://g
   ?y            =  http://a/b/c/?y
   g?y           =  http://a/b/c/g?y
   #s            =  (current document)#s
   g#s           =  http://a/b/c/g#s
   g?y#s         =  http://a/b/c/g?y#s
   ;x            =  http://a/b/c/;x
   g;x           =  http://a/b/c/g;x
   g;x?y#s       =  http://a/b/c/g;x?y#s
   .             =  http://a/b/c/
   ./            =  http://a/b/c/
   ..            =  http://a/b/
   ../           =  http://a/b/
   ../g          =  http://a/b/g
   ../..         =  http://a/
   ../../        =  http://a/
   ../../g       =  http://a/g
 
```
    Some URI schemes do not allow a hierarchical syntax matching the syntax, and thus cannot use relative references.
    throws:
    URIException If the new URI cannot be created.
    
    Parameters:
    base - the base URI
    relative - the relative URI
- Method Detail
  - public java.lang.Object clone()
    
    Create and return a copy of this object, the URI-reference containing the userinfo component. Notice that the whole URI-reference including the userinfo component counld not be gotten as a String.
    To copy the identical URI object including the userinfo component, it should be used.
    Returns:
    a clone of this instance
  - public int compareTo(java.lang.Object obj)
    
    Compare this URI to another object.
    throws:
    ClassCastException not URI argument
    
    Parameters:
    obj - the object to be compared.
    Returns:
    0, if it's same, -1, if failed, first being compared with in the authority component
  - public boolean equals(java.lang.Object obj)
    
    Test an object if this URI is equal to another.
    Parameters:
    obj - an object to compare
    Returns:
    true if two URI objects are equal
  - public java.lang.String getAboveHierPath()
    
    Get the level above the this hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the above hierarchy level
    See Also:
    decode
  - public java.lang.String getAuthority()
    
    Get the authority.
    throws:
    URIException If decode fails
    
    Returns:
    the authority
  - public java.lang.String getCurrentHierPath()
    
    Get the current hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the current hierarchy level
    See Also:
    decode
  - public static java.lang.String getDefaultDocumentCharset()
    
    Get the recommended default charset of the document.
    Returns:
    the default charset string
  - public static java.lang.String getDefaultDocumentCharsetByLocale()
    
    Get the default charset of the document by locale.
    Returns:
    the default charset string by locale
  - public static java.lang.String getDefaultDocumentCharsetByPlatform()
    
    Get the default charset of the document by platform.
    Returns:
    the default charset string by platform
  - public static java.lang.String getDefaultProtocolCharset()
    
    Get the default charset of the protocol.
    An individual URI scheme may require a single charset, define a default charset, or provide a way to indicate the charset used.
    To work globally either requires support of a number of character sets and to be able to convert between them, or the use of a single preferred character set. For support of global compatibility it is STRONGLY RECOMMENDED that clients and servers use UTF-8 encoding when exchanging URIs.
    Returns:
    the default charset string
  - public java.lang.String getEscapedAboveHierPath()
    
    Get the level above the this hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the raw above hierarchy level
  - public java.lang.String getEscapedAuthority()
    
    Get the escaped authority.
    Returns:
    the escaped authority
  - public java.lang.String getEscapedCurrentHierPath()
    
    Get the escaped current hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the escaped current hierarchy level
  - public java.lang.String getEscapedFragment()
    
    Get the escaped fragment.
    Returns:
    the escaped fragment string
  - public java.lang.String getEscapedName()
    
    Get the escaped basename of the path.
    Returns:
    the escaped basename string
  - public java.lang.String getEscapedPath()
    
    Get the escaped path.
```
   path          = [ abs_path | opaque_part ]
   abs_path      = "/"  path_segments
   opaque_part   = uric_no_slash *uric
 
```
    Returns:
    the escaped path string
  - public java.lang.String getEscapedPathQuery()
    
    Get the escaped query.
    Returns:
    the escaped path and query string
  - public java.lang.String getEscapedQuery()
    
    Get the escaped query.
    Returns:
    the escaped query string
  - public java.lang.String getEscapedURI()
    
    It can be gotten the URI character sequence. It's escaped. For the purpose of the protocol to be transported, it will be useful.
    Returns:
    the escaped URI string
  - public java.lang.String getEscapedURIReference()
    
    Get the escaped URI reference string.
    Returns:
    the escaped URI reference string
  - public java.lang.String getEscapedUserinfo()
    
    Get the escaped userinfo.
    Returns:
    the escaped userinfo
    See Also:
    getAuthority
  - public java.lang.String getFragment()
    
    Get the fragment.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Returns:
    the fragment string
    See Also:
    decode
  - public java.lang.String getHost()
    
    Get the host.
```
   host          = hostname | IPv4address | IPv6reference
 
```
    throws:
    URIException If decode fails
    
    Returns:
    the host
    See Also:
    getAuthority
  - public java.lang.String getName()
    
    Get the basename of the path.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Returns:
    the basename string
    See Also:
    decode
  - public java.lang.String getPath()
    
    Get the path.
```
   path          = [ abs_path | opaque_part ]
 
```
    throws:
    URIException If decode fails.
    
    Returns:
    the path string
    See Also:
    decode
  - public java.lang.String getPathQuery()
    
    Get the path and query.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Returns:
    the path and query string.
    See Also:
    decode
  - public int getPort()
    
    Get the port. In order to get the specfic default port, the specific protocol-supported class extended from the URI class should be used. It has the server-based naming authority.
    Returns:
    the port if -1, it has the default port for the scheme or the server-based naming authority is not supported in the specific URI.
  - public java.lang.String getProtocolCharset()
    
    Get the protocol charset used by this current URI instance. It was set by the constructor for this instance. If it was not set by contructor, it will return the default protocol charset.
    Returns:
    the protocol charset string
    See Also:
    getDefaultProtocolCharset
  - public java.lang.String getQuery()
    
    Get the query.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Returns:
    the query string.
    See Also:
    decode
  - public char[] getRawAboveHierPath()
    
    Get the level above the this hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the raw above hierarchy level
  - public char[] getRawAuthority()
    
    Get the raw-escaped authority.
    Returns:
    the raw-escaped authority
  - public char[] getRawCurrentHierPath()
    
    Get the raw-escaped current hierarchy level.
    throws:
    URIException If getRawCurrentHierPath(char[]) fails.
    
    Returns:
    the raw-escaped current hierarchy level
  - public char[] getRawFragment()
    
    Get the raw-escaped fragment.
    The optional fragment identifier is not part of a URI, but is often used in conjunction with a URI.
    The format and interpretation of fragment identifiers is dependent on the media type [RFC2046] of the retrieval result.
    A fragment identifier is only meaningful when a URI reference is intended for retrieval and the result of that retrieval is a document for which the identified fragment is consistently defined.
    Returns:
    the raw-escaped fragment
  - public char[] getRawHost()
    
    Get the host.
```
   host          = hostname | IPv4address | IPv6reference
 
```
    Returns:
    the host
    See Also:
    getAuthority
  - public char[] getRawName()
    
    Get the raw-escaped basename of the path.
    Returns:
    the raw-escaped basename
  - public char[] getRawPath()
    
    Get the raw-escaped path.
```
   path          = [ abs_path | opaque_part ]
 
```
    Returns:
    the raw-escaped path
  - public char[] getRawPathQuery()
    
    Get the raw-escaped path and query.
    Returns:
    the raw-escaped path and query
  - public char[] getRawQuery()
    
    Get the raw-escaped query.
    Returns:
    the raw-escaped query
  - public char[] getRawScheme()
    
    Get the scheme.
    Returns:
    the scheme
  - public char[] getRawURI()
    
    It can be gotten the URI character sequence. It's raw-escaped. For the purpose of the protocol to be transported, it will be useful.
    It is clearly unwise to use a URL that contains a password which is intended to be secret. In particular, the use of a password within the 'userinfo' component of a URL is strongly disrecommended except in those rare cases where the 'password' parameter is intended to be public.
    When you want to get each part of the userinfo, you need to use the specific methods in the specific URL. It depends on the specific URL.
    Returns:
    the URI character sequence
  - public char[] getRawURIReference()
    
    Get the URI reference character sequence.
    Returns:
    the URI reference character sequence
  - public char[] getRawUserinfo()
    
    Get the raw-escaped userinfo.
    Returns:
    the raw-escaped userinfo
    See Also:
    getAuthority
  - public java.lang.String getScheme()
    
    Get the scheme.
    Returns:
    the scheme null if undefined scheme
  - public java.lang.String getURI()
    
    It can be gotten the URI character sequence.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Returns:
    the original URI string
    See Also:
    decode
  - public java.lang.String getURIReference()
    
    Get the original URI reference string.
    throws:
    URIException If decode fails.
    
    Returns:
    the original URI reference string
  - public java.lang.String getUserinfo()
    
    Get the userinfo.
    throws:
    URIException If decode fails
    
    Returns:
    the userinfo
    See Also:
    getAuthority
  - public boolean hasAuthority()
    
    Tell whether or not this URI has authority. It's the same function as the is_net_path() method.
    Returns:
    true iif this URI has authority
    See Also:
    isNetPath
  - public boolean hasFragment()
    
    Tell whether or not this URI has fragment.
    Returns:
    true iif this URI has fragment
  - public boolean hasQuery()
    
    Tell whether or not this URI has query.
    Returns:
    true iif this URI has query
  - public boolean hasUserinfo()
    
    Tell whether or not this URI has userinfo.
    Returns:
    true iif this URI has userinfo
  - public int hashCode()
    
    Return a hash code for this URI.
    Returns:
    a has code value for this URI
  - public boolean isAbsPath()
    
    Tell whether or not the relativeURI or hier_part of this URI is abs_path.
    Returns:
    true iif the relativeURI or hier_part is abs_path
  - public boolean isAbsoluteURI()
    
    Tell whether or not this URI is absolute.
    Returns:
    true iif this URI is absoluteURI
  - public boolean isHierPart()
    
    Tell whether or not the absoluteURI of this URI is hier_part.
    Returns:
    true iif the absoluteURI is hier_part
  - public boolean isHostname()
    
    Tell whether or not the host part of this URI is hostname.
    Returns:
    true iif the host part is hostname
  - public boolean isIPv4address()
    
    Tell whether or not the host part of this URI is IPv4address.
    Returns:
    true iif the host part is IPv4address
  - public boolean isIPv6reference()
    
    Tell whether or not the host part of this URI is IPv6reference.
    Returns:
    true iif the host part is IPv6reference
  - public boolean isNetPath()
    
    Tell whether or not the relativeURI or heir_part of this URI is net_path. It's the same function as the has_authority() method.
    Returns:
    true iif the relativeURI or heir_part is net_path
    See Also:
    hasAuthority
  - public boolean isOpaquePart()
    
    Tell whether or not the absoluteURI of this URI is opaque_part.
    Returns:
    true iif the absoluteURI is opaque_part
  - public boolean isRegName()
    
    Tell whether or not the authority component of this URI is reg_name.
    Returns:
    true iif the authority component is reg_name
  - public boolean isRelPath()
    
    Tell whether or not the relativeURI of this URI is rel_path.
    Returns:
    true iif the relativeURI is rel_path
  - public boolean isRelativeURI()
    
    Tell whether or not this URI is relative.
    Returns:
    true iif this URI is relativeURI
  - public boolean isServer()
    
    Tell whether or not the authority component of this URI is server.
    Returns:
    true iif the authority component is server
  - public void normalize()
    
    Normalizes the path part of this URI. Normalization is only meant to be performed on URIs with an absolute path. Calling this method on a relative path URI will have no effect.
    throws:
    URIException no more higher path level to be normalized
    
    See Also:
    isAbsPath()
  - public static void setDefaultDocumentCharset(java.lang.String charset)
    
    Set the default charset of the document.
    Notice that it will be possible to contain mixed characters (e.g. ftp://host/KoreanNamespace/ChineseResource). To handle the Bi-directional display of these character sets, the protocol charset could be simply used again. Because it's not yet implemented that the insertion of BIDI control characters at different points during composition is extracted.
    
    Always all the time, the setter method is always succeeded and throws DefaultCharsetChanged exception.
    So API programmer must follow the following way:
```
  import org.apache.util.URI$DefaultCharsetChanged;
      .
      .
      .
  try {
      URI.setDefaultDocumentCharset("EUC-KR");
  } catch (DefaultCharsetChanged cc) {
      // CASE 1: the exception could be ignored, when it is set by user
      if (cc.getReasonCode() == DefaultCharsetChanged.DOCUMENT_CHARSET) {
      // CASE 2: let user know the default document charset changed
      } else {
      // CASE 2: let user know the default protocol charset changed
      }
  }
  
```
    The API programmer is responsible to set the correct charset. And each application should remember its own charset to support.
    throws:
    DefaultCharsetChanged default charset changed
    
    Parameters:
    charset - the default charset for the document
  - public static void setDefaultProtocolCharset(java.lang.String charset)
    
    Set the default charset of the protocol.
    The character set used to store files SHALL remain a local decision and MAY depend on the capability of local operating systems. Prior to the exchange of URIs they SHOULD be converted into a ISO/IEC 10646 format and UTF-8 encoded. This approach, while allowing international exchange of URIs, will still allow backward compatibility with older systems because the code set positions for ASCII characters are identical to the one byte sequence in UTF-8.
    An individual URI scheme may require a single charset, define a default charset, or provide a way to indicate the charset used.
    
    Always all the time, the setter method is always succeeded and throws DefaultCharsetChanged exception.
    So API programmer must follow the following way:
```
  import org.apache.util.URI$DefaultCharsetChanged;
      .
      .
      .
  try {
      URI.setDefaultProtocolCharset("UTF-8");
  } catch (DefaultCharsetChanged cc) {
      // CASE 1: the exception could be ignored, when it is set by user
      if (cc.getReasonCode() == DefaultCharsetChanged.PROTOCOL_CHARSET) {
      // CASE 2: let user know the default protocol charset changed
      } else {
      // CASE 2: let user know the default document charset changed
      }
  }
  
```
    The API programmer is responsible to set the correct charset. And each application should remember its own charset to support.
    throws:
    DefaultCharsetChanged default charset changed
    
    Parameters:
    charset - the default charset for each protocol
  - public void setEscapedAuthority(java.lang.String escapedAuthority)
    
    Set the authority. It can be one type of server, hostport, hostname, IPv4address, IPv6reference and reg_name. Note that there is no setAuthority method by the escape encoding reason.
    throws:
    URIException If parseAuthority(java.lang.String, boolean) fails
    
    Parameters:
    escapedAuthority - the escaped authority string
  - public void setEscapedFragment(java.lang.String escapedFragment)
    
    Set the escaped fragment string.
    throws:
    URIException escaped fragment not valid
    
    Parameters:
    escapedFragment - the escaped fragment string
  - public void setEscapedPath(java.lang.String escapedPath)
    
    Set the escaped path.
    throws:
    URIException encoding error or not proper for initial instance
    
    Parameters:
    escapedPath - the escaped path string
    See Also:
    encode
  - public void setEscapedQuery(java.lang.String escapedQuery)
    
    Set the escaped query string.
    throws:
    URIException escaped query not valid
    
    Parameters:
    escapedQuery - the escaped query string
  - public void setFragment(java.lang.String fragment)
    
    Set the fragment.
    throws:
    URIException If an error occurs.
    
    Parameters:
    fragment - the fragment string.
  - public void setPath(java.lang.String path)
    
    Set the path.
    throws:
    URIException set incorrectly or fragment only
    
    Parameters:
    path - the path string
    See Also:
    encode
  - public void setQuery(java.lang.String query)
    
    Set the query.
    When a query string is not misunderstood the reserved special characters ("&", "=", "+", ",", and "$") within a query component, it is recommended to use in encoding the whole query with this method.
    The additional APIs for the special purpose using by the reserved special characters used in each protocol are implemented in each protocol classes inherited from URI. So refer to the same-named APIs implemented in each specific protocol instance.
    throws:
    URIException incomplete trailing escape pattern or unsupported character encoding
    
    Parameters:
    query - the query string.
    See Also:
    encode
  - public void setRawAuthority(char[] escapedAuthority)
    
    Set the authority. It can be one type of server, hostport, hostname, IPv4address, IPv6reference and reg_name.
```
   authority     = server | reg_name
 
```
    throws:
    URIException If parseAuthority(java.lang.String, boolean) fails
    throws:
    NullPointerException null authority
    
    Parameters:
    escapedAuthority - the raw escaped authority
  - public void setRawFragment(char[] escapedFragment)
    
    Set the raw-escaped fragment.
    throws:
    URIException escaped fragment not valid
    
    Parameters:
    escapedFragment - the raw-escaped fragment
  - public void setRawPath(char[] escapedPath)
    
    Set the raw-escaped path.
    throws:
    URIException encoding error or not proper for initial instance
    
    Parameters:
    escapedPath - the path character sequence
    See Also:
    encode
  - public void setRawQuery(char[] escapedQuery)
    
    Set the raw-escaped query.
    throws:
    URIException escaped query not valid
    
    Parameters:
    escapedQuery - the raw-escaped query
  - public java.lang.String toString()
    
    Get the escaped URI string.
    On the document, the URI-reference form is only used without the userinfo component like http://jakarta.apache.org/ by the security reason. But the URI-reference form with the userinfo component could be parsed.
    In other words, this URI and any its subclasses must not expose the URI-reference expression with the userinfo component like http://user:password@hostport/restricted_zone.
    It means that the API client programmer should extract each user and password to access manually. Probably it will be supported in the each subclass, however, not a whole URI-reference expression.
    Returns:
    the escaped URI string
    See Also:
    clone()

| Detail:
Field
Constructor
Method

SoapUI 5.6.0 SDK

[Java] Class URI

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.util.BitSet allowed_IPv6reference

public static final java.util.BitSet allowed_abs_path

public static final java.util.BitSet allowed_authority

public static final java.util.BitSet allowed_fragment

public static final java.util.BitSet allowed_host

public static final java.util.BitSet allowed_opaque_part

public static final java.util.BitSet allowed_query

public static final java.util.BitSet allowed_reg_name

public static final java.util.BitSet allowed_rel_path

public static final java.util.BitSet allowed_userinfo

public static final java.util.BitSet allowed_within_authority

public static final java.util.BitSet allowed_within_path

public static final java.util.BitSet allowed_within_query

public static final java.util.BitSet allowed_within_userinfo

public static final java.util.BitSet control

public static final java.util.BitSet delims

public static final java.util.BitSet disallowed_opaque_part

public static final java.util.BitSet disallowed_rel_path

public static final java.util.BitSet space

public static final java.util.BitSet unwise

public static final java.util.BitSet within_userinfo

Constructor Detail

public URI(java.lang.String s, boolean escaped, java.lang.String charset)

public URI(java.lang.String s, boolean escaped)

public URI(char[] escaped, java.lang.String charset)

public URI(char[] escaped)

public URI(java.lang.String original, java.lang.String charset)

public URI(java.lang.String original)

public URI(java.lang.String scheme, java.lang.String schemeSpecificPart, java.lang.String fragment)

public URI(java.lang.String scheme, java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String fragment)

public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port)

public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path)

public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query)

public URI(java.lang.String scheme, java.lang.String userinfo, java.lang.String host, int port, java.lang.String path, java.lang.String query, java.lang.String fragment)

public URI(java.lang.String scheme, java.lang.String host, java.lang.String path, java.lang.String fragment)

public URI(URI base, java.lang.String relative)

public URI(URI base, java.lang.String relative, boolean escaped)

public URI(URI base, URI relative)

Method Detail

public java.lang.Object clone()

public int compareTo(java.lang.Object obj)

public boolean equals(java.lang.Object obj)

public java.lang.String getAboveHierPath()

public java.lang.String getAuthority()

public java.lang.String getCurrentHierPath()

public static java.lang.String getDefaultDocumentCharset()

public static java.lang.String getDefaultDocumentCharsetByLocale()

public static java.lang.String getDefaultDocumentCharsetByPlatform()

public static java.lang.String getDefaultProtocolCharset()

public java.lang.String getEscapedAboveHierPath()

public java.lang.String getEscapedAuthority()

public java.lang.String getEscapedCurrentHierPath()

public java.lang.String getEscapedFragment()

public java.lang.String getEscapedName()

public java.lang.String getEscapedPath()

public java.lang.String getEscapedPathQuery()

public java.lang.String getEscapedQuery()

public java.lang.String getEscapedURI()

public java.lang.String getEscapedURIReference()

public java.lang.String getEscapedUserinfo()

public java.lang.String getFragment()

public java.lang.String getHost()

public java.lang.String getName()

public java.lang.String getPath()

public java.lang.String getPathQuery()

public int getPort()

public java.lang.String getProtocolCharset()

public java.lang.String getQuery()

public char[] getRawAboveHierPath()

public char[] getRawAuthority()

public char[] getRawCurrentHierPath()

public char[] getRawFragment()

public char[] getRawHost()