Uri (JWAT common 1.2.1 API)

java.lang.Object
- org.jwat.common.Uri

All Implemented Interfaces:

java.lang.Comparable<Uri>
```
public class Uri
extends java.lang.Object
implements java.lang.Comparable<Uri>
```
Custom URI parser/validation based on rfc3986. An URI is split into sub components which are in turn validated. The overall reason for implementing this class is the lack of support for %uxxxx encoding which is not part of the specification but nevertheless needs to be validated since they are in use. Other non standard characters are also used in the wild. This implementation is not a complete substitute for the JDK version. It does not yet implement the following methods. - normalize() - parseServerAuthority() - relativize(URI uri) - resolve(String str) - resolve(URI uri) - toASCIIString()

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`authority` Authority components decoded, if present.
`protected java.lang.String`	`authorityRaw` Raw authority components, if present.
`protected boolean`	`bAbsolute` Boolean indicating whether this URI is absolute.
`protected boolean`	`bOpaque` Boolean indicating whether this URI is opaque, @see #isOpaque()
`protected java.lang.String`	`fragment` Fragment component decoded, if present.
`protected java.lang.String`	`fragmentRaw` Raw fragment component, if present.
`protected java.lang.String`	`hierPartRaw` Raw hier-part part ("//" + authority + path).
`protected java.lang.String`	`host` Host authority component decoded, if present.
`protected java.lang.String`	`hostRaw` Host authority component, if present.
`protected java.lang.String`	`path` Path component decoded.
`protected java.lang.String`	`pathRaw` Raw path component.
`protected int`	`port` Port authority component, if present.
`protected java.lang.String`	`portRaw` Raw port authority component, if present.
`protected java.lang.String`	`query` Query component decoded, if present.
`protected java.lang.String`	`queryRaw` Raw query component, if present.
`protected java.lang.String`	`scheme` Scheme component, if present.
`protected java.lang.String`	`schemeSpecificPart` Scheme specific part decoded.
`protected java.lang.String`	`schemeSpecificPartRaw` Raw scheme specific part, if present.
`protected UriProfile`	`uriProfile` Profile used to parse URI.
`protected java.lang.String`	`userinfo` Userinfo authority component decoded, if present.
`protected java.lang.String`	`userinfoRaw` Raw userinfo authority component, if present.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Uri()` Constructor for unit-testing.
	`Uri(java.lang.String str)` Constructs a URI by parsing the given string using the default RFC3986 profile.
	`Uri(java.lang.String str, UriProfile uriProfile)` Constructs a URI by parsing the given string using the requested profile.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Uri uri)`
`static Uri`	`create(java.lang.String str)` Creates a URI by parsing the given string using the default RFC3986 profile.
`static Uri`	`create(java.lang.String str, UriProfile uriProfile)` Creates a URI by parsing the given string using the requested profile.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAuthority()` Returns the decoded authority component of this URI.
`java.lang.String`	`getFragment()` Returns the decoded fragment component of this URI.
`java.lang.String`	`getHost()` Returns the host component of this URI.
`java.lang.String`	`getPath()` Returns the decoded path component of this URI.
`int`	`getPort()` Returns the port number of this URI.
`java.lang.String`	`getQuery()` Returns the decoded query component of this URI.
`java.lang.String`	`getRawAuthority()` Returns the raw authority component of this URI.
`java.lang.String`	`getRawFragment()` Returns the raw fragment component of this URI.
`java.lang.String`	`getRawPath()` Returns the raw path component of this URI.
`java.lang.String`	`getRawQuery()` Returns the raw query component of this URI.
`java.lang.String`	`getRawSchemeSpecificPart()` Returns the raw scheme-specific part of this URI.
`java.lang.String`	`getRawUserInfo()` Returns the raw user-information component of this URI.
`java.lang.String`	`getScheme()` Returns the scheme component of this URI.
`java.lang.String`	`getSchemeSpecificPart()` Returns the decoded scheme-specific part of this URI.
`java.lang.String`	`getUserInfo()` Returns the decoded user-information component of this URI.
`int`	`hashCode()`
`boolean`	`isAbsolute()` Tells whether or not this URI is absolute.
`boolean`	`isOpaque()` Tells whether or not this URI is opaque.
`java.lang.String`	`toString()`
`protected void`	`validate_absoluteUri(java.lang.String uriStr, int uIdx)` Parse and validate an absolute URI string.
`protected void`	`validate_relativeUri(java.lang.String uriStr, int uIdx)` Parse and validate a relative URI string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - hierPartRaw
```
protected java.lang.String hierPartRaw
```
    Raw hier-part part ("//" + authority + path).
  - schemeSpecificPartRaw
```
protected java.lang.String schemeSpecificPartRaw
```
    Raw scheme specific part, if present.
  - authorityRaw
```
protected java.lang.String authorityRaw
```
    Raw authority components, if present.
  - userinfoRaw
```
protected java.lang.String userinfoRaw
```
    Raw userinfo authority component, if present.
  - hostRaw
```
protected java.lang.String hostRaw
```
    Host authority component, if present.
  - portRaw
```
protected java.lang.String portRaw
```
    Raw port authority component, if present.
  - pathRaw
```
protected java.lang.String pathRaw
```
    Raw path component.
  - queryRaw
```
protected java.lang.String queryRaw
```
    Raw query component, if present.
  - fragmentRaw
```
protected java.lang.String fragmentRaw
```
    Raw fragment component, if present.
  - scheme
```
protected java.lang.String scheme
```
    Scheme component, if present.
  - schemeSpecificPart
```
protected java.lang.String schemeSpecificPart
```
    Scheme specific part decoded.
  - authority
```
protected java.lang.String authority
```
    Authority components decoded, if present.
  - userinfo
```
protected java.lang.String userinfo
```
    Userinfo authority component decoded, if present.
  - host
```
protected java.lang.String host
```
    Host authority component decoded, if present.
  - port
```
protected int port
```
    Port authority component, if present.
  - path
```
protected java.lang.String path
```
    Path component decoded.
  - query
```
protected java.lang.String query
```
    Query component decoded, if present.
  - fragment
```
protected java.lang.String fragment
```
    Fragment component decoded, if present.
  - bAbsolute
```
protected boolean bAbsolute
```
    Boolean indicating whether this URI is absolute.
  - bOpaque
```
protected boolean bOpaque
```
    Boolean indicating whether this URI is opaque, @see #isOpaque()
  - uriProfile
```
protected UriProfile uriProfile
```
    Profile used to parse URI.
- Constructor Detail
  - Uri
```
protected Uri()
```
    Constructor for unit-testing.
  - Uri
```
public Uri(java.lang.String str)
    throws java.net.URISyntaxException
```
    Constructs a URI by parsing the given string using the default RFC3986 profile.
    
    Parameters:
    
    str - The string to be parsed into a URI
    
    Throws:
    
    java.net.URISyntaxException - If the given string violates RFC 3986
  - Uri
```
public Uri(java.lang.String str,
           UriProfile uriProfile)
    throws java.net.URISyntaxException
```
    Constructs a URI by parsing the given string using the requested profile.
    
    Parameters:
    
    str - The string to be parsed into a URI
    
    uriProfile - the requested profile
    
    Throws:
    
    java.net.URISyntaxException - If the given string violates the profile
- Method Detail
  - create
```
public static Uri create(java.lang.String str)
                  throws java.lang.IllegalArgumentException
```
    Creates a URI by parsing the given string using the default RFC3986 profile.
    
    Parameters:
    
    str - The string to be parsed into a URI
    
    Returns:
    
    The new URI
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given string violates RFC 3986
  - create
```
public static Uri create(java.lang.String str,
                         UriProfile uriProfile)
                  throws java.lang.IllegalArgumentException
```
    Creates a URI by parsing the given string using the requested profile.
    
    Parameters:
    
    str - The string to be parsed into a URI
    
    uriProfile - the requested profile
    
    Returns:
    
    The new URI
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given string violates the profile
  - validate_absoluteUri
```
protected void validate_absoluteUri(java.lang.String uriStr,
                                    int uIdx)
                             throws java.net.URISyntaxException
```
    Parse and validate an absolute URI string.
    
    Parameters:
    
    uriStr - URI string
    
    uIdx - index in string after scheme colon character
    
    Throws:
    
    java.net.URISyntaxException - if the URI is invalid in some way
  - validate_relativeUri
```
protected void validate_relativeUri(java.lang.String uriStr,
                                    int uIdx)
                             throws java.net.URISyntaxException
```
    Parse and validate a relative URI string. This method is also used by the absolute parser after a scheme has been identified.
    
    Parameters:
    
    uriStr - URI string
    
    uIdx - index in string to start parsing from
    
    Throws:
    
    java.net.URISyntaxException - if the URI is invalid in some way
  - isAbsolute
```
public boolean isAbsolute()
```
    Tells whether or not this URI is absolute. A URI is absolute if, and only if, it has a scheme component.
    
    Returns:
    
    true if, and only if, this URI is absolute
  - isOpaque
```
public boolean isOpaque()
```
    Tells whether or not this URI is opaque. A URI is opaque if, and only if, it is absolute and its scheme-specific part does not begin with a slash character ('/'). An opaque URI has a scheme, a scheme-specific part, and possibly a fragment; all other components are undefined.
    
    Returns:
    
    true if, and only if, this URI is opaque
  - getScheme
```
public java.lang.String getScheme()
```
    Returns the scheme component of this URI. The scheme component of a URI, if defined, only contains characters in the alphanum category and in the string "-.+". A scheme always starts with an alpha character. The scheme component of a URI cannot contain escaped octets, hence this method does not perform any decoding.
    
    Returns:
    
    The scheme component of this URI, or null if the scheme is undefined
  - getRawSchemeSpecificPart
```
public java.lang.String getRawSchemeSpecificPart()
```
    Returns the raw scheme-specific part of this URI. The scheme-specific part is never undefined, though it may be empty. The scheme-specific part of a URI only contains legal URI characters.
    
    Returns:
    
    The raw scheme-specific part of this URI (never null)
  - getSchemeSpecificPart
```
public java.lang.String getSchemeSpecificPart()
```
    Returns the decoded scheme-specific part of this URI. The string returned by this method is equal to that returned by the getRawSchemeSpecificPart method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded scheme-specific part of this URI (never null)
  - getRawAuthority
```
public java.lang.String getRawAuthority()
```
    Returns the raw authority component of this URI. The authority component of a URI, if defined, only contains the commercial-at character ('@') and characters in the unreserved, punct, escaped, and other categories. If the authority is server-based then it is further constrained to have valid user-information, host, and port components.
    
    Returns:
    
    The raw authority component of this URI, or null if the authority is undefined
  - getAuthority
```
public java.lang.String getAuthority()
```
    Returns the decoded authority component of this URI. The string returned by this method is equal to that returned by the getRawAuthority method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded authority component of this URI, or null if the authority is undefined
  - getRawUserInfo
```
public java.lang.String getRawUserInfo()
```
    Returns the raw user-information component of this URI. The user-information component of a URI, if defined, only contains characters in the unreserved, punct, escaped, and other categories.
    
    Returns:
    
    The raw user-information component of this URI, or null if the user information is undefined
  - getUserInfo
```
public java.lang.String getUserInfo()
```
    Returns the decoded user-information component of this URI. The string returned by this method is equal to that returned by the getRawUserInfo method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded user-information component of this URI, or null if the user information is undefined
  - getHost
```
public java.lang.String getHost()
```
    Returns the host component of this URI. The host component of a URI, if defined, will have one of the following forms: - A domain name consisting of one or more labels separated by period characters ('.'), optionally followed by a period character. Each label consists of alphanum characters as well as hyphen characters ('-'), though hyphens never occur as the first or last characters in a label. The rightmost label of a domain name consisting of two or more labels, begins with an alpha character. - A dotted-quad IPv4 address of the form digit+.digit+.digit+.digit+, where no digit sequence is longer than three characters and no sequence has a value larger than 255. - An IPv6 address enclosed in square brackets ('[' and ']') and consisting of hexadecimal digits, colon characters (':'), and possibly an embedded IPv4 address. The full syntax of IPv6 addresses is specified in RFC 2373: IPv6 Addressing Architecture. The host component of a URI cannot contain escaped octets, hence this method does not perform any decoding.
    
    Returns:
    
    The host component of this URI, or null if the host is undefined
  - getPort
```
public int getPort()
```
    Returns the port number of this URI. The port component of a URI, if defined, is a non-negative integer between 1 and 65535.
    
    Returns:
    
    The port component of this URI, or -1 if the port is undefined
  - getRawPath
```
public java.lang.String getRawPath()
```
    Returns the raw path component of this URI. The path component of a URI, if defined, only contains the slash character ('/'), the commercial-at character ('@'), and characters in the unreserved, punct, escaped, and other categories.
    
    Returns:
    
    The path component of this URI, or null if the path is undefined
  - getPath
```
public java.lang.String getPath()
```
    Returns the decoded path component of this URI. The string returned by this method is equal to that returned by the getRawPath method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded path component of this URI, or null if the path is undefined
  - getRawQuery
```
public java.lang.String getRawQuery()
```
    Returns the raw query component of this URI. The query component of a URI, if defined, only contains legal URI characters.
    
    Returns:
    
    The raw query component of this URI, or null if the query is undefined
  - getQuery
```
public java.lang.String getQuery()
```
    Returns the decoded query component of this URI. The string returned by this method is equal to that returned by the getRawQuery method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded query component of this URI, or null if the query is undefined
  - getRawFragment
```
public java.lang.String getRawFragment()
```
    Returns the raw fragment component of this URI. The fragment component of a URI, if defined, only contains legal URI characters.
    
    Returns:
    
    The raw fragment component of this URI, or null if the fragment is undefined
  - getFragment
```
public java.lang.String getFragment()
```
    Returns the decoded fragment component of this URI. The string returned by this method is equal to that returned by the getRawFragment method except that all sequences of escaped octets are decoded.
    
    Returns:
    
    The decoded fragment component of this URI, or null if the fragment is undefined
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(Uri uri)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Uri>

Class Uri

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hierPartRaw

schemeSpecificPartRaw

authorityRaw

userinfoRaw

hostRaw

portRaw

pathRaw

queryRaw

fragmentRaw

scheme

schemeSpecificPart

authority

userinfo

host

port

path

query

fragment

bAbsolute

bOpaque

uriProfile

Constructor Detail

Uri

Uri

Uri

Method Detail

create

create

validate_absoluteUri

validate_relativeUri

isAbsolute

isOpaque

getScheme

getRawSchemeSpecificPart

getSchemeSpecificPart

getRawAuthority

getAuthority

getRawUserInfo

getUserInfo

getHost

getPort

getRawPath

getPath

getRawQuery

getQuery

getRawFragment

getFragment

toString

equals

hashCode

compareTo