FileDocCategorySizeDatePackage
PURL.javaAPI DocphoneME MR2 API (J2ME)21133Wed May 02 18:00:34 BST 2007com.sun.perseus.platform

PURL

public final class PURL extends Object
Class URL represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. A resource can be something as simple as a file or a directory, or it can be a reference to a more complicated object, such as a query to a database or to a search engine. More information on the types of URLs and their formats can be found at:
http://archive.ncsa.uiuc.edu/SDG/Software/Mosaic/Demo/url-primer.html

In general, a URL can be broken into several parts. The previous example of a URL indicates that the protocol to use is http (HyperText Transfer Protocol) and that the information resides on a host machine named www.ncsa.uiuc.edu. The information on that host machine is named /SDG/Software/Mosaic/Demo/url-primer.html. The exact meaning of this name on the host machine is both protocol dependent and host dependent. The information normally resides in a file, but it could be generated on the fly. This component of the URL is called the path component.

A URL can optionally specify a "port", which is the port number to which the TCP connection is made on the remote host machine. If the port is not specified, the default port for the protocol is used instead. For example, the default port for http is 80. An alternative port could be specified as:

http://archive.ncsa.uiuc.edu:80/SDG/Software/Mosaic/Demo/url-primer.html

The syntax of URL is defined by RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax, amended by RFC 2732: Format for Literal IPv6 Addresses in URLs.

A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example,

http://java.sun.com/index.html#chapter1

This fragment is not technically part of the URL. Rather, it indicates that after the specified resource is retrieved, the application is specifically interested in that part of the document that has the tag chapter1 attached to it. The meaning of a tag is resource specific.

An application can also specify a "relative URL", which contains only enough information to reach the resource relative to another URL. Relative URLs are frequently used within HTML pages. For example, if the contents of the URL:

http://java.sun.com/index.html
contained within it the relative URL:
FAQ.html
it would be a shorthand for:
http://java.sun.com/FAQ.html

The relative URL need not specify all the components of a URL. If the protocol, host name, or port number is missing, the value is inherited from the fully specified URL. The file component must be specified. The optional fragment is not inherited.

Fields Summary
static final long
serialVersionUID
private static final String
protocolPathProp
The property which specifies the package prefix list to be scanned for protocol handlers. The value of this property (if any) should be a vertical bar delimited list of package names to search through for a protocol handler to load. The policy of this class is that all protocol handlers will be in a class called .Handler, and each package in the list is examined in turn for a matching handler. If none are found (or the property is not specified), the default package prefix, sun.net.www.protocol, is used. The search proceeds from the first package in the list to the last and stops when a match is found.
private String
protocol
The protocol to use (ftp, http, nntp, ... etc.) .
private String
host
The host name to connect to.
private int
port
The protocol port to connect to.
private String
file
The specified file name on that host. file is defined as path[?query]
private transient String
query
The query part of this URL.
private String
authority
The authority part of this URL.
private transient String
path
The path part of this URL.
private transient String
userInfo
The userinfo part of this URL.
private String
ref
# reference.
transient Object
hostAddress
The host's IP address, used in equals and hashCode. Computed on demand. An uninitialized or unknown hostAddress is null.
private int
hashCode
Constructors Summary
public PURL(String spec)
Creates a URL object from the String representation.

This constructor is equivalent to a call to the two-argument constructor with a null first argument.

param
spec the String to parse as a URL.
exception
Error If the string specifies an unknown protocol.
see
java.net.URL#URL(java.net.URL, java.lang.String)


                                                                                     
         
	this(null, spec);
    
public PURL(PURL context, String spec)
Creates a URL by parsing the given spec within a specified context. The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :
<scheme>://<authority><path>?<query>#<fragment>
The reference is parsed into the scheme, authority, path, query and fragment parts. If the path component is empty and the scheme, authority, and query components are undefined, then the new URL is a reference to the current document. Otherwise, the fragment and query parts present in the spec are used in the new URL.

If the scheme component is defined in the given spec and does not match the scheme of the context, then the new URL is created as an absolute URL based on the spec alone. Otherwise the scheme component is inherited from the context URL.

If the authority component is present in the spec then the spec is treated as absolute and the spec authority and path will replace the context authority and path. If the authority component is absent in the spec then the authority of the new URL will be inherited from the context.

If the spec's path component begins with a slash character "/" then the path is treated as absolute and the spec path replaces the context path.

Otherwise, the path is treated as a relative path and is appended to the context path, as described in RFC2396. Also, in this case, the path is canonicalized through the removal of directory changes made by occurences of ".." and ".".

For a more detailed description of URL parsing, refer to RFC2396.

param
context the context in which to parse the specification.
param
spec the String to parse as a URL.
exception
Error if no protocol is specified, or an unknown protocol is found.
see
java.net.URL#URL(java.lang.String, java.lang.String, int, java.lang.String)
see
java.net.URLStreamHandler
see
java.net.URLStreamHandler#parseURL(java.net.URL, java.lang.String, int, int)

	this(context, spec, null);
    
public PURL(PURL context, String spec, Object handler)
Creates a URL by parsing the given spec with the specified handler within a specified context. If the handler is null, the parsing occurs as with the two argument constructor.

param
context the context in which to parse the specification.
param
spec the String to parse as a URL.
param
handler the stream handler for the URL.
exception
Error if no protocol is specified, or an unknown protocol is found.
exception
SecurityException if a security manager exists and its checkPermission method doesn't allow specifying a stream handler.
see
java.net.URL#URL(java.lang.String, java.lang.String, int, java.lang.String)
see
java.net.URLStreamHandler
see
java.net.URLStreamHandler#parseURL(java.net.URL, java.lang.String, int, int)

	String original = spec;
	int i, limit, c;
	int start = 0;
	String newProtocol = null;
	boolean aRef=false;
	boolean isRelative = false;

	// Check for permission to specify a handler
	if (handler != null) {
	    // 	    SecurityManager sm = System.getSecurityManager();
	    // 	    if (sm != null) {
	    // 		checkSpecifyHandler(sm);
	    // 	    }
	}

	try {
	    limit = spec.length();
	    while ((limit > 0) && (spec.charAt(limit - 1) <= ' ")) {
		limit--;	//eliminate trailing whitespace
	    }
	    while ((start < limit) && (spec.charAt(start) <= ' ")) {
		start++;	// eliminate leading whitespace
	    }

	    if (spec.regionMatches(true, start, "url:", 0, 4)) {
		start += 4;
	    }
	    if (start < spec.length() && spec.charAt(start) == '#") {
		/* we're assuming this is a ref relative to the context URL.
		 * This means protocols cannot start w/ '#', but we must parse
		 * ref URL's like: "hello:there" w/ a ':' in them.
		 */
		aRef=true;
	    }
	    for (i = start ; !aRef && (i < limit) &&
		     ((c = spec.charAt(i)) != '/") ; i++) {
		if (c == ':") {

		    String s = spec.substring(start, i).toLowerCase();
		    if (isValidProtocol(s)) {
			newProtocol = s;
			start = i + 1;
		    }
		    break;
		}
	    }

	    // Only use our context if the protocols match.
	    protocol = newProtocol;
	    if ((context != null) && ((newProtocol == null) ||
			    newProtocol.equalsIgnoreCase(context.protocol))) {

                // If the context is a hierarchical URL scheme and the spec
		// contains a matching scheme then maintain backwards
		// compatibility and treat it as if the spec didn't contain
		// the scheme; see 5.2.3 of RFC2396
		if (context.path != null && context.path.startsWith("/"))
		    newProtocol = null;

                if (newProtocol == null) {
                    protocol = context.protocol;
		    authority = context.authority;
		    userInfo = context.userInfo;
                    host = context.host;
                    port = context.port;
                    file = context.file;
		    path = context.path;
		    isRelative = true;
                }
	    }

	    if (protocol == null) {
		throw new Error("no protocol: "+original);
	    }

	    i = spec.indexOf('#", start);
	    if (i >= 0) {
		ref = spec.substring(i + 1, limit);
		limit = i;
	    }
	    
	    /*
	     * Handle special case inheritance of query and fragment
	     * implied by RFC2396 section 5.2.2.
	     */
	    if (isRelative && start == limit) {
		query = context.query;
		if (ref == null) {
		    ref = context.ref;
		}
	    }

	    PURLStreamHandler.parseURL(this, spec, start, limit);

	} catch(Error e) {
	    throw e;
	} catch(Exception e) {
	    throw new Error(e.getMessage());
	}
    
Methods Summary
public java.lang.StringgetAuthority()
Gets the authority part of this URL.

return
the authority part of this URL
since
1.3

	return authority;
    
public intgetDefaultPort()
Gets the default port number of the protocol associated with this URL. If the URL scheme or the URLStreamHandler for the URL do not define a default port number, then -1 is returned.

return
the port number

	return -1;
	//return handler.getDefaultPort();
    
public java.lang.StringgetFile()
Gets the file name of this URL. The returned file portion will be the same as getPath(), plus the concatenation of the value of getQuery(), if any. If there is no query portion, this method and getPath() will return identical results.

return
the file name of this URL, or an empty string if one does not exist

	return file;
    
public java.lang.StringgetHost()
Gets the host name of this URL, if applicable. The format of the host conforms to RFC 2732, i.e. for a literal IPv6 address, this method will return the IPv6 address enclosed in square brackets ('[' and ']').

return
the host name of this URL.

	return host;
    
public java.lang.StringgetPath()
Gets the path part of this URL.

return
the path part of this URL, or an empty string if one does not exist
since
1.3

	return path;
    
public intgetPort()
Gets the port number of this URL.

return
the port number, or -1 if the port is not set

	return port;
    
public java.lang.StringgetProtocol()
Gets the protocol name of this URL.

return
the protocol of this URL.

	return protocol;
    
public java.lang.StringgetQuery()
Gets the query part of this URL.

return
the query part of this URL, or null if one does not exist
since
1.3

	return query;
    
public java.lang.StringgetRef()
Gets the anchor (also known as the "reference") of this URL.

return
the anchor (also known as the "reference") of this URL, or null if one does not exist

	return ref;
    
public java.lang.StringgetUserInfo()
Gets the userInfo part of this URL.

return
the userInfo part of this URL, or null if one does not exist

	return userInfo;
    
private booleanisValidProtocol(java.lang.String protocol)

	int len = protocol.length();
        if (len < 1)
            return false;
        char c = protocol.charAt(0);
        if (!(Character.isLowerCase(c) || 
	      Character.isUpperCase(c)))
            return false;
	for (int i = 1; i < len; i++) {
	    c = protocol.charAt(i);
	    if (!(Character.isLowerCase(c) || 
		  Character.isUpperCase(c) ||
		  Character.isDigit(c))
		&& c != '." && c != '+" &&
		c != '-") {
		return false;
	    }
	}
	return true;
    
protected voidset(java.lang.String protocol, java.lang.String host, int port, java.lang.String file, java.lang.String ref)
Sets the fields of the URL. This is not a public method so that only URLStreamHandlers can modify URL fields. URLs are otherwise constant.

param
protocol the name of the protocol to use
param
host the name of the host
param
port the port number on the host
param
file the file on the host
param
ref the internal reference in the URL

	synchronized (this) {
	    this.protocol = protocol;
	    this.host = host;
            authority = port == -1 ? host : host + ":" + port;
	    this.port = port;
	    this.file = file;
	    this.ref = ref;
	    /* This is very important. We must recompute this after the
	     * URL has been changed. */
	    hashCode = -1;
            hostAddress = null;
            int q = file.lastIndexOf('?");
            if (q != -1) {
                query = file.substring(q+1);
                path = file.substring(0, q);
            } else
                path = file;
	}
    
protected voidset(java.lang.String protocol, java.lang.String host, int port, java.lang.String authority, java.lang.String userInfo, java.lang.String path, java.lang.String query, java.lang.String ref)
Sets the specified 8 fields of the URL. This is not a public method so that only URLStreamHandlers can modify URL fields. URLs are otherwise constant.

param
protocol the name of the protocol to use
param
host the name of the host
param
port the port number on the host
param
authority the authority part for the url
param
userInfo the username and password
param
path the file on the host
param
ref the internal reference in the URL
param
query the query part of this URL
since
1.3

	synchronized (this) {
	    this.protocol = protocol;
	    this.host = host;
	    this.port = port;
	    this.file = query == null ? path : path + "?" + query;
            this.userInfo = userInfo;
            this.path = path;
	    this.ref = ref;
	    /* This is very important. We must recompute this after the
	     * URL has been changed. */
	    hashCode = -1;
            hostAddress = null;
            this.query = query;
            this.authority = authority;
	}
    
public java.lang.StringtoExternalForm()
Constructs a string representation of this URL. The string is created by calling the toExternalForm method of the stream protocol handler for this object.

return
a string representation of this object.
see
java.net.URL#URL(java.lang.String, java.lang.String, int, java.lang.String)
see
java.net.URLStreamHandler#toExternalForm(java.net.URL)

	return PURLStreamHandler.toExternalForm(this);
    
public java.lang.StringtoString()
Constructs a string representation of this URL. The string is created by calling the toExternalForm method of the stream protocol handler for this object.

return
a string representation of this object.
see
java.net.URL#URL(java.lang.String, java.lang.String, int, java.lang.String)
see
java.net.URLStreamHandler#toExternalForm(java.net.URL)

	return toExternalForm();