Struct xpcom::interfaces::nsIProtocolHandler [−] [src]

#[repr(C)]

pub struct nsIProtocolHandler { /* fields omitted */ }

interface nsIProtocolHandler : nsISupports

/**
 * nsIProtocolHandler
 */

Methods

impl nsIProtocolHandler
[src]

[src]

Cast this nsIProtocolHandler to one of its base interfaces.

impl nsIProtocolHandler
[src]

URI_STD: i64 = 0
/**************************************************************************
     * Constants for the protocol flags (the first is the default mask, the
     * others are deviations):
     *
     * NOTE: Implementation must ignore any flags they do not understand.
     */
/**
     * standard full URI with authority component and concept of relative
     * URIs (http, ftp, ...)
     */


URI_NORELATIVE: i64 = 1
/**
     * no concept of relative URIs (about, javascript, finger, ...)
     */


URI_NOAUTH: i64 = 2
/**
     * no authority component (file, ...)
     */


ALLOWS_PROXY: i64 = 4
/**
     * This protocol handler can be proxied via a proxy (socks or http)
     * (e.g., irc, smtp, http, etc.).  If the protocol supports transparent
     * proxying, the handler should implement nsIProxiedProtocolHandler.
     *
     * If it supports only HTTP proxying, then it need not support
     * nsIProxiedProtocolHandler, but should instead set the ALLOWS_PROXY_HTTP
     * flag (see below).
     *
     * @see nsIProxiedProtocolHandler
     */


ALLOWS_PROXY_HTTP: i64 = 8
/**
     * This protocol handler can be proxied using a http proxy (e.g., http,
     * ftp, etc.).  nsIIOService::newChannelFromURI will feed URIs from this
     * protocol handler to the HTTP protocol handler instead.  This flag is
     * ignored if ALLOWS_PROXY is not set.
     */


URI_INHERITS_SECURITY_CONTEXT: i64 = 16
/**
     * The URIs for this protocol have no inherent security context, so
     * documents loaded via this protocol should inherit the security context
     * from the document that loads them.
     */


URI_FORBIDS_AUTOMATIC_DOCUMENT_REPLACEMENT: i64 = 32
/**
     * "Automatic" loads that would replace the document (e.g. <meta> refresh,
     * certain types of XLinks, possibly other loads that the application
     * decides are not user triggered) are not allowed if the originating (NOT
     * the target) URI has this protocol flag.  Note that the decision as to
     * what constitutes an "automatic" load is made externally, by the caller
     * of nsIScriptSecurityManager::CheckLoadURI.  See documentation for that
     * method for more information.
     *
     * A typical protocol that might want to set this flag is a protocol that
     * shows highly untrusted content in a viewing area that the user expects
     * to have a lot of control over, such as an e-mail reader.
     */


URI_LOADABLE_BY_ANYONE: i64 = 64
/**
     * +-------------------------------------------------------------------+
     * |                                                                   |
     * |  ALL PROTOCOL HANDLERS MUST SET ONE OF THE FOLLOWING FIVE FLAGS.  |
     * |                                                                   |
     * +-------------------------------------------------------------------+
     *
     * These flags are used to determine who is allowed to load URIs for this
     * protocol.  Note that if a URI is nested, only the flags for the
     * innermost URI matter.  See nsINestedURI.
     *
     * If none of these five flags are set, the URI must be treated as if it
     * had the URI_LOADABLE_BY_ANYONE flag set, for compatibility with protocol
     * handlers written against Gecko 1.8 or earlier.  In this case, there may
     * be run-time warning messages indicating that a "default insecure"
     * assumption is being made.  At some point in the futures (Mozilla 2.0,
     * most likely), these warnings will become errors.
     */
/**
     * The URIs for this protocol can be loaded by anyone.  For example, any
     * website should be allowed to trigger a load of a URI for this protocol.
     * Web-safe protocols like "http" should set this flag.
     */


URI_DANGEROUS_TO_LOAD: i64 = 128
/**
     * The URIs for this protocol are UNSAFE if loaded by untrusted (web)
     * content and may only be loaded by privileged code (for example, code
     * which has the system principal).  Various internal protocols should set
     * this flag.
     */


URI_IS_UI_RESOURCE: i64 = 256
/**
     * The URIs for this protocol point to resources that are part of the
     * application's user interface.  There are cases when such resources may
     * be made accessible to untrusted content such as web pages, so this is
     * less restrictive than URI_DANGEROUS_TO_LOAD but more restrictive than
     * URI_LOADABLE_BY_ANYONE.  See the documentation for
     * nsIScriptSecurityManager::CheckLoadURI.
     */


URI_IS_LOCAL_FILE: i64 = 512
/**
     * Loading of URIs for this protocol from other origins should only be
     * allowed if those origins should have access to the local filesystem.
     * It's up to the application to decide what origins should have such
     * access.  Protocols like "file" that point to local data should set this
     * flag.
     */


URI_LOADABLE_BY_SUBSUMERS: i64 = 1024
/**
     * The URIs for this protocol can be loaded only by callers with a
     * principal that subsumes this uri. For example, privileged code and
     * websites that are same origin as this uri.
     */


URI_DOES_NOT_RETURN_DATA: i64 = 2048
/**
     * Channels using this protocol never call OnDataAvailable
     * on the listener passed to AsyncOpen and they therefore
     * do not return any data that we can use.
     */


URI_IS_LOCAL_RESOURCE: i64 = 4096
/**
     * URIs for this protocol are considered to be local resources.  This could
     * be a local file (URI_IS_LOCAL_FILE), a UI resource (URI_IS_UI_RESOURCE),
     * or something else that would not hit the network.
     */


URI_OPENING_EXECUTES_SCRIPT: i64 = 8192
/**
     * URIs for this protocol execute script when they are opened.
     */


URI_NON_PERSISTABLE: i64 = 16384
/**
     * Loading channels from this protocol has side-effects that make
     * it unsuitable for saving to a local file.
     */

URI_FORBIDS_COOKIE_ACCESS: i64 = 32768
/**
     * This protocol handler forbids accessing cookies e.g. for mail related
     * protocols.
     */


URI_CROSS_ORIGIN_NEEDS_WEBAPPS_PERM: i64 = 65536
/**
     * URIs for this protocol require the webapps permission on the principal
     * when opening URIs for a different domain. See bug#773886
     */


URI_SYNC_LOAD_IS_OK: i64 = 131072
/**
     * Channels for this protocol don't need to spin the event loop to handle
     * Open() and reads on the resulting stream.
     */


URI_SAFE_TO_LOAD_IN_SECURE_CONTEXT: i64 = 262144
/**
     * URI is secure to load in an https page and should not be blocked
     * by nsMixedContentBlocker
     */


URI_FETCHABLE_BY_ANYONE: i64 = 524288
/**
     * This URI may be fetched and the contents are visible to anyone. This is
     * semantically equivalent to the resource being served with all-access CORS
     * headers.
     */


ORIGIN_IS_FULL_SPEC: i64 = 1048576
/**
     * If this flag is set, then the origin for this protocol is the full URI
     * spec, not just the scheme + host + port.
     *
     * Note: this is not supported in Firefox.  It is currently only available
     * in Thunderbird and SeaMonkey.
     */


URI_SCHEME_NOT_SELF_LINKABLE: i64 = 2097152
/**
     * If this flag is set, the URI does not always allow content using the same
     * protocol to link to it.
     */


URI_LOADABLE_BY_EXTENSIONS: i64 = 4194304
/**
     * The URIs for this protocol can be loaded by extensions.
     */

[src]

/**
     * The scheme of this protocol (e.g., "file").
     */

readonly attribute ACString scheme;

[src]

/**
     * The default port is the port that this protocol normally uses.
     * If a port does not make sense for the protocol (e.g., "about:")
     * then -1 will be returned.
     */

readonly attribute long defaultPort;

[src]

/**
     * Returns the protocol specific flags (see flag definitions below).
     */

readonly attribute unsigned long protocolFlags;

[src]

/**
     * Makes a URI object that is suitable for loading by this protocol,
     * where the URI string is given as an UTF-8 string.  The caller may
     * provide the charset from which the URI string originated, so that
     * the URI string can be translated back to that charset (if necessary)
     * before communicating with, for example, the origin server of the URI
     * string.  (Many servers do not support UTF-8 IRIs at the present time,
     * so we must be careful about tracking the native charset of the origin
     * server.)
     *
     * @param aSpec          - the URI string in UTF-8 encoding. depending
     *                         on the protocol implementation, unicode character
     *                         sequences may or may not be %xx escaped.
     * @param aOriginCharset - the charset of the document from which this URI
     *                         string originated.  this corresponds to the
     *                         charset that should be used when communicating
     *                         this URI to an origin server, for example.  if
     *                         null, then UTF-8 encoding is assumed (i.e.,
     *                         no charset transformation from aSpec).
     * @param aBaseURI       - if null, aSpec must specify an absolute URI.
     *                         otherwise, aSpec may be resolved relative
     *                         to aBaseURI, depending on the protocol.
     *                         If the protocol has no concept of relative
     *                         URI aBaseURI will simply be ignored.
     */

nsIURI newURI (in AUTF8String aSpec, [optional] in string aOriginCharset, [optional] in nsIURI aBaseURI);

[src]

/**
     * Constructs a new channel from the given URI for this protocol handler and
     * sets the loadInfo for the constructed channel.
     */

nsIChannel newChannel2 (in nsIURI aURI, in nsILoadInfo aLoadinfo);

[src]

/**
     * Constructs a new channel from the given URI for this protocol handler.
     */

nsIChannel newChannel (in nsIURI aURI);

[src]

/**
     * Allows a protocol to override blacklisted ports.
     *
     * This method will be called when there is an attempt to connect to a port
     * that is blacklisted.  For example, for most protocols, port 25 (Simple Mail
     * Transfer) is banned.  When a URI containing this "known-to-do-bad-things"
     * port number is encountered, this function will be called to ask if the
     * protocol handler wants to override the ban.
     */

boolean allowPort (in long port, in string scheme);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIProtocolHandler
[src]

IID: nsIID = nsID(2826047718, 31884, 16887, [134, 77, 223, 128, 144, 21, 25, 62])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIProtocolHandler
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIProtocolHandler
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.