/*
* Copyright (c) 2000, 2001, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jndi.toolkit.url;
import java.net.MalformedURLException;
A Uri object represents an absolute Uniform Resource Identifier
(URI) as defined by RFC 2396 and updated by RFC 2373 and RFC 2732.
The most commonly used form of URI is the Uniform Resource Locator (URL).
The java.net.URL class cannot be used to parse URIs since it
requires the installation of URL stream handlers that may not be
available. The hack of getting around this by temporarily
replacing the scheme part of a URI is not appropriate here: JNDI
service providers must work on older Java platforms, and we want
new features and bug fixes that are not available in old versions
of the URL class.
It may be appropriate to drop this code in favor of the
java.net.URI class. The changes would need to be written so as to
still run on pre-1.4 platforms not containing that class.
The format of an absolute URI (see the RFCs mentioned above) is:
absoluteURI = scheme ":" ( hier_part | opaque_part )
scheme = alpha *( alpha | digit | "+" | "-" | "." )
hier_part = ( net_path | abs_path ) [ "?" query ]
opaque_part = uric_no_slash *uric
net_path = "//" authority [ abs_path ]
abs_path = "/" path_segments
authority = server | reg_name
reg_name = 1*( unreserved | escaped | "$" | "," |
";" | ":" | "@" | "&" | "=" | "+" )
server = [ [ userinfo "@" ] hostport ]
userinfo = *( unreserved | escaped |
";" | ":" | "&" | "=" | "+" | "$" | "," )
hostport = host [ ":" port ]
host = hostname | IPv4address | IPv6reference
port = *digit
IPv6reference = "[" IPv6address "]"
IPv6address = hexpart [ ":" IPv4address ]
IPv4address = 1*3digit "." 1*3digit "." 1*3digit "." 1*3digit
hexpart = hexseq | hexseq "::" [ hexseq ] | "::" [ hexseq ]
hexseq = hex4 *( ":" hex4)
hex4 = 1*4hex
path = [ abs_path | opaque_part ]
path_segments = segment *( "/" segment )
segment = *pchar *( ";" param )
param = *pchar
pchar = unreserved | escaped |
":" | "@" | "&" | "=" | "+" | "$" | ","
query = *uric
uric = reserved | unreserved | escaped
uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
"&" | "=" | "+" | "$" | ","
reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
"$" | "," | "[" | "]"
unreserved = alphanum | mark
mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
escaped = "%" hex hex
unwise = "{" | "}" | "|" | "\" | "^" | "`"
Currently URIs containing userinfo or reg_name are not supported. The opaque_part of a non-hierarchical URI is treated as if if were a path without a leading slash.
/**
* A Uri object represents an absolute Uniform Resource Identifier
* (URI) as defined by RFC 2396 and updated by RFC 2373 and RFC 2732.
* The most commonly used form of URI is the Uniform Resource Locator (URL).
*
* <p> The java.net.URL class cannot be used to parse URIs since it
* requires the installation of URL stream handlers that may not be
* available. The hack of getting around this by temporarily
* replacing the scheme part of a URI is not appropriate here: JNDI
* service providers must work on older Java platforms, and we want
* new features and bug fixes that are not available in old versions
* of the URL class.
*
* <p> It may be appropriate to drop this code in favor of the
* java.net.URI class. The changes would need to be written so as to
* still run on pre-1.4 platforms not containing that class.
*
* <p> The format of an absolute URI (see the RFCs mentioned above) is:
* <blockquote><pre>{@code
* absoluteURI = scheme ":" ( hier_part | opaque_part )
*
* scheme = alpha *( alpha | digit | "+" | "-" | "." )
*
* hier_part = ( net_path | abs_path ) [ "?" query ]
* opaque_part = uric_no_slash *uric
*
* net_path = "//" authority [ abs_path ]
* abs_path = "/" path_segments
*
* authority = server | reg_name
* reg_name = 1*( unreserved | escaped | "$" | "," |
* ";" | ":" | "@" | "&" | "=" | "+" )
* server = [ [ userinfo "@" ] hostport ]
* userinfo = *( unreserved | escaped |
* ";" | ":" | "&" | "=" | "+" | "$" | "," )
*
* hostport = host [ ":" port ]
* host = hostname | IPv4address | IPv6reference
* port = *digit
*
* IPv6reference = "[" IPv6address "]"
* IPv6address = hexpart [ ":" IPv4address ]
* IPv4address = 1*3digit "." 1*3digit "." 1*3digit "." 1*3digit
* hexpart = hexseq | hexseq "::" [ hexseq ] | "::" [ hexseq ]
* hexseq = hex4 *( ":" hex4)
* hex4 = 1*4hex
*
* path = [ abs_path | opaque_part ]
* path_segments = segment *( "/" segment )
* segment = *pchar *( ";" param )
* param = *pchar
* pchar = unreserved | escaped |
* ":" | "@" | "&" | "=" | "+" | "$" | ","
*
* query = *uric
*
* uric = reserved | unreserved | escaped
* uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
* "&" | "=" | "+" | "$" | ","
* reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
* "$" | "," | "[" | "]"
* unreserved = alphanum | mark
* mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
* escaped = "%" hex hex
* unwise = "{" | "}" | "|" | "\" | "^" | "`"
* }</pre></blockquote>
*
* <p> Currently URIs containing {@code userinfo} or {@code reg_name}
* are not supported.
* The {@code opaque_part} of a non-hierarchical URI is treated as if
* if were a {@code path} without a leading slash.
*/
public class Uri {
protected String uri;
protected String scheme;
protected String host = null;
protected int port = -1;
protected boolean hasAuthority;
protected String path;
protected String query = null;
Creates a Uri object given a URI string.
/**
* Creates a Uri object given a URI string.
*/
public Uri(String uri) throws MalformedURLException {
init(uri);
}
Creates an uninitialized Uri object. The init() method must
be called before any other Uri methods.
/**
* Creates an uninitialized Uri object. The init() method must
* be called before any other Uri methods.
*/
protected Uri() {
}
Initializes a Uri object given a URI string.
This method must be called exactly once, and before any other Uri
methods.
/**
* Initializes a Uri object given a URI string.
* This method must be called exactly once, and before any other Uri
* methods.
*/
protected void init(String uri) throws MalformedURLException {
this.uri = uri;
parse(uri);
}
Returns the URI's scheme.
/**
* Returns the URI's scheme.
*/
public String getScheme() {
return scheme;
}
Returns the host from the URI's authority part, or null if no host is provided. If the host is an IPv6 literal, the delimiting brackets are part of the returned value (see URI.getHost). /**
* Returns the host from the URI's authority part, or null
* if no host is provided. If the host is an IPv6 literal, the
* delimiting brackets are part of the returned value (see
* {@link java.net.URI#getHost}).
*/
public String getHost() {
return host;
}
Returns the port from the URI's authority part, or -1 if
no port is provided.
/**
* Returns the port from the URI's authority part, or -1 if
* no port is provided.
*/
public int getPort() {
return port;
}
Returns the URI's path. The path is never null. Note that a
slash following the authority part (or the scheme if there is
no authority part) is part of the path. For example, the path
of "http://host/a/b" is "/a/b".
/**
* Returns the URI's path. The path is never null. Note that a
* slash following the authority part (or the scheme if there is
* no authority part) is part of the path. For example, the path
* of "http://host/a/b" is "/a/b".
*/
public String getPath() {
return path;
}
Returns the URI's query part, or null if no query is provided.
Note that a query always begins with a leading "?".
/**
* Returns the URI's query part, or null if no query is provided.
* Note that a query always begins with a leading "?".
*/
public String getQuery() {
return query;
}
Returns the URI as a string.
/**
* Returns the URI as a string.
*/
public String toString() {
return uri;
}
/*
* Parses a URI string and sets this object's fields accordingly.
*/
private void parse(String uri) throws MalformedURLException {
int i; // index into URI
i = uri.indexOf(':'); // parse scheme
if (i < 0) {
throw new MalformedURLException("Invalid URI: " + uri);
}
scheme = uri.substring(0, i);
i++; // skip past ":"
hasAuthority = uri.startsWith("//", i);
if (hasAuthority) { // parse "//host:port"
i += 2; // skip past "//"
int slash = uri.indexOf('/', i);
if (slash < 0) {
slash = uri.length();
}
if (uri.startsWith("[", i)) { // at IPv6 literal
int brac = uri.indexOf(']', i + 1);
if (brac < 0 || brac > slash) {
throw new MalformedURLException("Invalid URI: " + uri);
}
host = uri.substring(i, brac + 1); // include brackets
i = brac + 1; // skip past "[...]"
} else { // at host name or IPv4
int colon = uri.indexOf(':', i);
int hostEnd = (colon < 0 || colon > slash)
? slash
: colon;
if (i < hostEnd) {
host = uri.substring(i, hostEnd);
}
i = hostEnd; // skip past host
}
if ((i + 1 < slash) &&
uri.startsWith(":", i)) { // parse port
i++; // skip past ":"
port = Integer.parseInt(uri.substring(i, slash));
}
i = slash; // skip to path
}
int qmark = uri.indexOf('?', i); // look for query
if (qmark < 0) {
path = uri.substring(i);
} else {
path = uri.substring(i, qmark);
query = uri.substring(qmark);
}
}
/*
// Debug
public static void main(String args[]) throws MalformedURLException {
for (int i = 0; i < args.length; i++) {
Uri uri = new Uri(args[i]);
String h = (uri.getHost() != null) ? uri.getHost() : "";
String p = (uri.getPort() != -1) ? (":" + uri.getPort()) : "";
String a = uri.hasAuthority ? ("//" + h + p) : "";
String q = (uri.getQuery() != null) ? uri.getQuery() : "";
String str = uri.getScheme() + ":" + a + uri.getPath() + q;
if (! uri.toString().equals(str)) {
System.out.println(str);
}
System.out.println(h);
}
}
*/
}