Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIJARURI Interface Reference

JAR URLs have the following syntax. More...

import "nsIJARURI.idl";

Inheritance diagram for nsIJARURI:
Inheritance graph
[legend]
Collaboration diagram for nsIJARURI:
Collaboration graph
[legend]

List of all members.

Public Member Functions

AUTF8String getCommonBaseSpec (in nsIURI aURIToCompare)
 This method takes a uri and compares the two.
AUTF8String getRelativeSpec (in nsIURI aURIToCompare)
 This method takes a uri and returns a substring of this if it can be made relative to the uri passed in.
boolean equals (in nsIURI other)
 URI equivalence test (not a strict string comparison).
boolean schemeIs (in string scheme)
 An optimization to do scheme checks without requiring the users of nsIURI to GetScheme, thereby saving extra allocating and freeing.
nsIURI clone ()
 Clones the current URI.
AUTF8String resolve (in AUTF8String relativePath)
 This method resolves a relative string into an absolute URI string, using this URI as the base.

Public Attributes

attribute nsIURI JARFile
 Returns the root URI (the one for the actual JAR file) for this JAR.
attribute AUTF8String JAREntry
 Returns the entry specified for this JAR URI.
attribute AUTF8String filePath
 Returns a path including the directory and file portions of a URL.
attribute AUTF8String param
 Returns the parameters specified after the ; in the URL.
attribute AUTF8String query
 Returns the query portion (the part after the "?") of the URL.
attribute AUTF8String ref
 Returns the reference portion (the part after the "#") of the URL.
attribute AUTF8String directory
 Returns the directory portion of a URL.
attribute AUTF8String fileName
 Returns the file name portion of a URL.
attribute AUTF8String fileBaseName
 Returns the file basename portion of a filename in a url.
attribute AUTF8String fileExtension
 Returns the file extension portion of a filename in a url.
attribute AUTF8String spec
 Returns a string representation of the URI.
readonly attribute AUTF8String prePath
 The prePath (eg.
attribute ACString scheme
 The Scheme is the protocol to which this URI refers.
attribute AUTF8String userPass
 The username:password (or username only if value doesn't contain a ':')
attribute AUTF8String username
 The optional username and password, assuming the preHost consists of username:password.
attribute AUTF8String password
attribute AUTF8String hostPort
 The host:port (or simply the host, if port == -1).
attribute AUTF8String host
 The host is the internet domain name to which this URI refers.
attribute long port
 A port value of -1 corresponds to the protocol's default port (eg.
attribute AUTF8String path
 The path, typically including at least a leading '/' (but may also be empty, depending on the protocol).
readonly attribute ACString asciiSpec
 The URI spec with an ASCII compatible encoding.
readonly attribute ACString asciiHost
 The URI host with an ASCII compatible encoding.
readonly attribute ACString originCharset
 The charset of the document from which this URI originated.

Detailed Description

JAR URLs have the following syntax.

jar:<jar-file-uri>!/<jar-entry>

EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html

The nsIURL methods operate on the <jar-entry> part of the spec.

Definition at line 51 of file nsIJARURI.idl.


Member Function Documentation

nsIURI nsIURI::clone ( ) [inherited]

Clones the current URI.

For some protocols, this is more than just an optimization. For example, under MacOS, the spec of a file URL does not necessarily uniquely identify a file since two volumes could share the same name.

Here is the caller graph for this function:

boolean nsIURI::equals ( in nsIURI  other) [inherited]

URI equivalence test (not a strict string comparison).

eg. http://foo.com:80/ == http://foo.com/

AUTF8String nsIURL::getCommonBaseSpec ( in nsIURI  aURIToCompare) [inherited]

This method takes a uri and compares the two.

The common uri portion is returned as a string. The minimum common uri portion is the protocol, and any of these if present: login, password, host and port If no commonality is found, "" is returned. If they are identical, the whole path with file/ref/etc. is returned. For file uris, it is expected that the common spec would be at least "file:///" since '/' is a shared common root.

Examples: this.spec aURIToCompare.spec result 1) http://mozilla.org/ http://www.mozilla.org/ "" 2) http://foo.com/bar/ ftp://foo.com/bar/ "" 3) http://foo.com:8080/ http://foo.com/bar/ "" 4) ftp://user@foo.com/ ftp://user:pw@foo.com/ "" 5) ftp://foo.com/bar/ ftp://foo.com/bar ftp://foo.com/ 6) ftp://foo.com/bar/ ftp://foo.com/bar/b.html ftp://foo.com/bar/ 7) http://foo.com/a.htm#i http://foo.com/b.htm http://foo.com/ 8) ftp://foo.com/c.htm#i ftp://foo.com/c.htm ftp://foo.com/c.htm 9) file:///a/b/c.html file:///d/e/c.html file:///

AUTF8String nsIURL::getRelativeSpec ( in nsIURI  aURIToCompare) [inherited]

This method takes a uri and returns a substring of this if it can be made relative to the uri passed in.

If no commonality is found, the entire uri spec is returned. If they are identical, "" is returned. Filename, query, etc are always returned except when uris are identical.

AUTF8String nsIURI::resolve ( in AUTF8String  relativePath) [inherited]

This method resolves a relative string into an absolute URI string, using this URI as the base.

NOTE: some implementations may have no concept of a relative URI.

boolean nsIURI::schemeIs ( in string  scheme) [inherited]

An optimization to do scheme checks without requiring the users of nsIURI to GetScheme, thereby saving extra allocating and freeing.

Returns true if the schemes match (case ignored).


Member Data Documentation

readonly attribute ACString nsIURI::asciiHost [inherited]

The URI host with an ASCII compatible encoding.

Follows the IDNA draft spec for converting internationalized domain names (UTF-8) to ASCII for compatibility with existing internet infrasture.

Definition at line 220 of file nsIURI.idl.

readonly attribute ACString nsIURI::asciiSpec [inherited]

The URI spec with an ASCII compatible encoding.

Host portion follows the IDNA draft spec. Other parts are URL-escaped per the rules of RFC2396. The result is strictly ASCII.

Definition at line 213 of file nsIURI.idl.

attribute AUTF8String nsIURL::directory [inherited]

Returns the directory portion of a URL.

If the URL denotes a path to a directory and not a file, e.g. http://foo/bar/, then the Directory attribute accesses the complete /foo/bar/ portion, and the FileName is the empty string. If the trailing slash is omitted, then the Directory is /foo/ and the file is bar (i.e. this is a syntactic, not a semantic breakdown of the Path). And hence dont rely on this for something to be a definitely be a file. But you can get just the leading directory portion for sure.

Some characters may be escaped.

Definition at line 117 of file nsIURL.idl.

attribute AUTF8String nsIURL::fileBaseName [inherited]

Returns the file basename portion of a filename in a url.

Some characters may be escaped.

Definition at line 142 of file nsIURL.idl.

attribute AUTF8String nsIURL::fileExtension [inherited]

Returns the file extension portion of a filename in a url.

If a file extension does not exist, the empty string is returned.

Some characters may be escaped.

Definition at line 150 of file nsIURL.idl.

attribute AUTF8String nsIURL::fileName [inherited]

Returns the file name portion of a URL.

If the URL denotes a path to a directory and not a file, e.g. http://foo/bar/, then the Directory attribute accesses the complete /foo/bar/ portion, and the FileName is the empty string. Note that this is purely based on searching for the last trailing slash. And hence dont rely on this to be a definite file.

Some characters may be escaped.

Definition at line 130 of file nsIURL.idl.

attribute AUTF8String nsIURL::filePath [inherited]

Returns a path including the directory and file portions of a URL.

For example, the filePath of "http://foo/bar.html#baz" is "/foo/bar.html".

Some characters may be escaped.

Definition at line 73 of file nsIURL.idl.

attribute AUTF8String nsIURI::host [inherited]

The host is the internet domain name to which this URI refers.

It could be an IPv4 (or IPv6) address literal. If supported, it could be a non-ASCII internationalized domain name.

Characters are NOT escaped.

Definition at line 152 of file nsIURI.idl.

attribute AUTF8String nsIURI::hostPort [inherited]

The host:port (or simply the host, if port == -1).

Characters are NOT escaped.

Definition at line 143 of file nsIURI.idl.

Returns the entry specified for this JAR URI.

eg ocean.html

Definition at line 63 of file nsIJARURI.idl.

Returns the root URI (the one for the actual JAR file) for this JAR.

eg http://www.big.com/blue.jar

Definition at line 57 of file nsIJARURI.idl.

readonly attribute ACString nsIURI::originCharset [inherited]

The charset of the document from which this URI originated.

An empty value implies UTF-8.

If this value is something other than UTF-8 then the URI components (e.g., spec, prePath, username, etc.) will all be fully URL-escaped. Otherwise, the URI components may contain unescaped multibyte UTF-8 characters.

Definition at line 231 of file nsIURI.idl.

attribute AUTF8String nsIURL::param [inherited]

Returns the parameters specified after the ; in the URL.

Some characters may be escaped.

Definition at line 80 of file nsIURL.idl.

attribute AUTF8String nsIURI::password [inherited]

Definition at line 136 of file nsIURI.idl.

attribute AUTF8String nsIURI::path [inherited]

The path, typically including at least a leading '/' (but may also be empty, depending on the protocol).

Some characters may be escaped.

Definition at line 166 of file nsIURI.idl.

A port value of -1 corresponds to the protocol's default port (eg.

-1 implies port 80 for http URIs).

Definition at line 158 of file nsIURI.idl.

readonly attribute AUTF8String nsIURI::prePath [inherited]

The prePath (eg.

scheme://user:password:port) returns the string before the path. This is useful for authentication or managing sessions.

Some characters may be escaped.

Definition at line 114 of file nsIURI.idl.

attribute AUTF8String nsIURL::query [inherited]

Returns the query portion (the part after the "?") of the URL.

If there isn't one, an empty string is returned.

Some characters may be escaped.

Definition at line 88 of file nsIURL.idl.

attribute AUTF8String nsIURL::ref [inherited]

Returns the reference portion (the part after the "#") of the URL.

If there isn't one, an empty string is returned.

Some characters may be escaped.

Definition at line 96 of file nsIURL.idl.

attribute ACString nsIURI::scheme [inherited]

The Scheme is the protocol to which this URI refers.

The scheme is restricted to the US-ASCII charset per RFC2396.

Definition at line 120 of file nsIURI.idl.

attribute AUTF8String nsIURI::spec [inherited]

Returns a string representation of the URI.

Setting the spec causes the new spec to be parsed, initializing the URI.

Some characters may be escaped.

Definition at line 106 of file nsIURI.idl.

attribute AUTF8String nsIURI::username [inherited]

The optional username and password, assuming the preHost consists of username:password.

Some characters may be escaped.

Definition at line 135 of file nsIURI.idl.

attribute AUTF8String nsIURI::userPass [inherited]

The username:password (or username only if value doesn't contain a ':')

Some characters may be escaped.

Definition at line 127 of file nsIURI.idl.


The documentation for this interface was generated from the following file: