URI ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- iaik.ixsil.util.URI

```
public class URI
extends java.lang.Object
```
This class represents a Uniform Ressource Identifier (URI), as specified in RFC 2396.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`authority_` The authority component of an URI.
`protected static java.lang.String`	`AUTHORITY_CHARS_` Contains all characters which are allowed for the authority component of an URI.
`protected java.lang.String`	`path_` The path component of an URI.
`protected static java.lang.String`	`PATH_CHARS_` Contains all characters which are allowed for the path component of an URI.
`protected java.lang.String`	`query_` The query component of an URI.
`protected static java.lang.String`	`QUERY_CHARS_` Contains all characters which are allowed for the query component of an URI.
`protected java.lang.String`	`reference_` The reference component of an URI.
`protected static java.lang.String`	`REFERENCE_CHARS_` Contains all characters which are allowed for the reference component of an URI.S_
`protected static java.lang.String`	`RESERVED_` Contains all reserved characters which can be used for an URI.
`protected java.lang.String`	`scheme_` The scheme component of an URI.
`protected static java.lang.String`	`SCHEME_CHARS_` Contains all characters which are allowed for the scheme component of an URI.
`protected static java.lang.String`	`UNRESERVED_` Contains all unreserved characters which can be used for an URI.

Constructor Summary

Constructors
Constructor and Description
`URI(java.lang.String uri)` Parses the given URI string and extracts its five components.
`URI(java.lang.String scheme, java.lang.String authority, java.lang.String path, java.lang.String query, java.lang.String reference)` Constructs a URI from its five components.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static URI`	`absolutizeURI(URI base, URI candidate)` Absolutizes a specified candidate URI using a specified base URI according to RFC 2396, section 5.2.
`protected java.lang.String`	`escape(java.lang.String original, java.lang.String allowedChars)` Escapes all non-ASCII characters and all forbidden ASCII characters in the specified string.
`java.lang.String`	`getAuthority()` Gets the authority component of the URI.
`java.lang.String`	`getAuthorityUnescaped()` Gets the authority component of the URI in its unescaped (unicode) version.
`java.lang.String`	`getPath()` Gets the path component of the URI.
`java.lang.String`	`getPathUnescaped()` Gets the path component of the URI in its unescaped (unicode) version.
`java.lang.String`	`getQuery()` Gets the query component of the URI.
`java.lang.String`	`getQueryUnescaped()` Gets the query component of the URI in its unescaped (unicode) version.
`java.lang.String`	`getReference()` Gets the reference component of the URI.
`java.lang.String`	`getReferenceUnescaped()` Gets the reference component of the URI in its unescaped (unicode) version.
`java.lang.String`	`getScheme()` Gets the scheme component of the URI.
`java.lang.String`	`getSchemeUnescaped()` Gets the scheme component of the URI in its unescaped (unicode) version.
`java.lang.String`	`getURIWithoutReference()` Provides the string representation of the URI, excluding the reference part.
`boolean`	`isAbsolute()` Tests if the URI is absolute.
`boolean`	`isEmpty()` Checks if the URI is empty.
`boolean`	`isReference()` Checks if the URI is reference-only.
`protected java.lang.String`	`parseComponent(java.lang.String uri, int fromIndex, java.lang.String allowedChars)` Gets the longest possible substring, containing only the specified allowed characters, and starting at the specified position of the candidate string.
`java.lang.String`	`toString()` Provides the sString representation of the URI.
`protected java.lang.String`	`unescape(java.lang.String escaped)` Unescapes the provided string.

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

- Field Detail
  - UNRESERVED_
```
protected static final java.lang.String UNRESERVED_
```
    Contains all unreserved characters which can be used for an URI.
    
    See Also:
    
    Constant Field Values
  - RESERVED_
```
protected static final java.lang.String RESERVED_
```
    Contains all reserved characters which can be used for an URI.
    
    See Also:
    
    Constant Field Values
  - SCHEME_CHARS_
```
protected static final java.lang.String SCHEME_CHARS_
```
    Contains all characters which are allowed for the scheme component of an URI.
    
    See Also:
    
    Constant Field Values
  - AUTHORITY_CHARS_
```
protected static final java.lang.String AUTHORITY_CHARS_
```
    Contains all characters which are allowed for the authority component of an URI.
    
    See Also:
    
    Constant Field Values
  - PATH_CHARS_
```
protected static final java.lang.String PATH_CHARS_
```
    Contains all characters which are allowed for the path component of an URI.
    
    See Also:
    
    Constant Field Values
  - QUERY_CHARS_
```
protected static final java.lang.String QUERY_CHARS_
```
    Contains all characters which are allowed for the query component of an URI.
    
    See Also:
    
    Constant Field Values
  - REFERENCE_CHARS_
```
protected static final java.lang.String REFERENCE_CHARS_
```
    Contains all characters which are allowed for the reference component of an URI.S_
    
    See Also:
    
    Constant Field Values
  - scheme_
```
protected java.lang.String scheme_
```
    The scheme component of an URI.
  - authority_
```
protected java.lang.String authority_
```
    The authority component of an URI.
  - path_
```
protected java.lang.String path_
```
    The path component of an URI.
  - query_
```
protected java.lang.String query_
```
    The query component of an URI.
  - reference_
```
protected java.lang.String reference_
```
    The reference component of an URI.
- Constructor Detail
  - URI
```
public URI(java.lang.String scheme,
           java.lang.String authority,
           java.lang.String path,
           java.lang.String query,
           java.lang.String reference)
```
    Constructs a URI from its five components. No validity checks are made here regarding the interdependency between particular components. Please see RFC 2396.
    To construct a empty URI, all components must equal null, except path, which must be an empty String.
    
    To construct a reference-only URI, all components must equal null, except path, which must be an empty String, and reference, which must at least be an empty String.
    
    Please note, that all parameters are considered to contain no escape sequences (%XX). For example, an invocation (new URI("file", null, "a%20filename.txt", null, null)).toString() would result in a string value of file:a%2520filename.txt.
    
    Parameters:
    
    scheme - The URI scheme component.
    
    authority - The URI authority component.
    
    path - The URI path component.
    
    query - The URI query component.
    
    reference - The URI reference component.
  - URI
```
public URI(java.lang.String uri)
    throws URIException
```
    Parses the given URI string and extracts its five components.
    
    Parameters:
    
    uri - A string representing an URI according to RFC 2396. Must not be null.
    
    Throws:
    
    URIException - if a parsing error occurs.
- Method Detail
  - absolutizeURI
```
public static URI absolutizeURI(URI base,
                                URI candidate)
                         throws URIException
```
    Absolutizes a specified candidate URI using a specified base URI according to RFC 2396, section 5.2.
    
    Parameters:
    
    base - The base URI. Must not be null.
    
    candidate - The candidate URI. Must not be null.
    
    Returns:
    
    the absolutized URI.
    
    Throws:
    
    URIException - if the candidate URI cannot be absolutized with the specified base URI.
  - getURIWithoutReference
```
public java.lang.String getURIWithoutReference()
```
    Provides the string representation of the URI, excluding the reference part.
    
    Returns:
    
    the URI as a string, employing the URI escaping mechanism for unallowed characters.
  - toString
```
public java.lang.String toString()
```
    Provides the sString representation of the URI.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the URI as a string, employing the URI escaping mechanism for unallowed characters.
  - isEmpty
```
public boolean isEmpty()
```
    Checks if the URI is empty.
    
    Returns:
    
    true if the URI is empty, false otherwise.
  - isReference
```
public boolean isReference()
```
    Checks if the URI is reference-only. For instance #aRef is reference-only, but http://anywhere.com/aDocument.html#aRef is not reference-only, but it has a reference.
    
    Returns:
    
    true if the URI is reference-only, false otherwise.
  - getScheme
```
public java.lang.String getScheme()
```
    Gets the scheme component of the URI.
    
    Returns:
    
    the URI's scheme component or null if it does not exist.
  - getSchemeUnescaped
```
public java.lang.String getSchemeUnescaped()
```
    Gets the scheme component of the URI in its unescaped (unicode) version.
    
    Returns:
    
    the URI's scheme component or null if it does not exist.
  - getAuthority
```
public java.lang.String getAuthority()
```
    Gets the authority component of the URI.
    
    Returns:
    
    the URI's authority component or null if it does not exist.
  - getAuthorityUnescaped
```
public java.lang.String getAuthorityUnescaped()
```
    Gets the authority component of the URI in its unescaped (unicode) version.
    
    Returns:
    
    the URI's authority component or null if it does not exist.
  - getPath
```
public java.lang.String getPath()
```
    Gets the path component of the URI.
    
    Returns:
    
    the URI's path component or null if it does not exist.
  - getPathUnescaped
```
public java.lang.String getPathUnescaped()
```
    Gets the path component of the URI in its unescaped (unicode) version.
    
    Returns:
    
    the URI's path component or null if it does not exist.
  - getQuery
```
public java.lang.String getQuery()
```
    Gets the query component of the URI.
    
    Returns:
    
    the URI's query component or null if it does not exist.
  - getQueryUnescaped
```
public java.lang.String getQueryUnescaped()
```
    Gets the query component of the URI in its unescaped (unicode) version.
    
    Returns:
    
    the URI's query component or null if it does not exist.
  - getReference
```
public java.lang.String getReference()
```
    Gets the reference component of the URI.
    
    Returns:
    
    the URI's reference component or null if it does not exist.
  - getReferenceUnescaped
```
public java.lang.String getReferenceUnescaped()
```
    Gets the reference component of the URI in its unescaped (unicode) version.
    
    Returns:
    
    the URI's reference component or null if it does not exist.
  - isAbsolute
```
public boolean isAbsolute()
```
    Tests if the URI is absolute. According to RFC 2396 an URI is absolute, if the scheme component is defined.
    
    Returns:
    
    true, if the URI is absolute, false otherwise.
  - escape
```
protected java.lang.String escape(java.lang.String original,
                                  java.lang.String allowedChars)
```
    Escapes all non-ASCII characters and all forbidden ASCII characters in the specified string. A non-ASCII character is at first transformed into its UTF8 bytes. These bytes are then escaped with the URI escaping mechanism as specified by RFC 2396. For example, the character ä is transformed into the byte sequence 0xC3 0xA4. Therefore the corresponding representation as escaped URI characters is %c3%a4.
    
    Parameters:
    
    original - The string which characters are perhaps to be escaped. Must not be null.
    
    allowedChars - String containing all allowed ASCII characters which should not be escaped. Must not be null.
    
    Returns:
    
    The escaped equivalent of the original string.
  - unescape
```
protected java.lang.String unescape(java.lang.String escaped)
```
    Unescapes the provided string. All escapes sequences (%xy)* are replaced with its corresponding unicode characters. For instance, %C3%B6 is replaced with unicode character 0xF6 (character ö).
    
    Parameters:
    
    escaped - The string to be escaped.
    
    Returns:
    
    the unescaped string.
  - parseComponent
```
protected java.lang.String parseComponent(java.lang.String uri,
                                          int fromIndex,
                                          java.lang.String allowedChars)
```
    Gets the longest possible substring, containing only the specified allowed characters, and starting at the specified position of the candidate string.
    
    Parameters:
    
    uri - The string containing the requested substring. Must not be null.
    
    fromIndex - The start position of the substring. Must match the interval [0, candidate.length()].
    
    allowedChars - A string containing all allowed characters for the substring. Must not be null.
    
    Returns:
    
    the longest possible substring, containing only the specified allowed characters, and starting at the specified position of the candidate string.

Class URI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNRESERVED_

RESERVED_

SCHEME_CHARS_

AUTHORITY_CHARS_

PATH_CHARS_

QUERY_CHARS_

REFERENCE_CHARS_

scheme_

authority_

path_

query_

reference_

Constructor Detail

URI

URI

Method Detail

absolutizeURI

getURIWithoutReference

toString

isEmpty

isReference

getScheme

getSchemeUnescaped

getAuthority

getAuthorityUnescaped

getPath

getPathUnescaped

getQuery

getQueryUnescaped

getReference

getReferenceUnescaped

isAbsolute

escape

unescape

parseComponent