Back to index

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

import "nsIHttpProtocolHandler.idl";

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

List of all members.

Public Member Functions

nsIChannel newProxiedChannel (in nsIURI uri, in nsIProxyInfo proxyInfo)
 Create a new channel with the given proxyInfo.
nsIURI newURI (in AUTF8String aSpec, in string aOriginCharset, in nsIURI aBaseURI)
 Makes a URI object that is suitable for loading by this protocol, where the URI string is given as an UTF-8 string.
nsIChannel newChannel (in nsIURI aURI)
 Constructs a new channel from the given URI for this protocol handler.
boolean allowPort (in long port, in string scheme)
 Allows a protocol to override blacklisted ports.

Public Attributes

readonly attribute ACString userAgent
 Get the HTTP advertised user agent string.
readonly attribute ACString appName
 Get the application name.
readonly attribute ACString appVersion
 Get the application version string.
attribute ACString vendor
attribute ACString vendorSub
attribute ACString vendorComment
attribute ACString product
attribute ACString productSub
attribute ACString productComment
readonly attribute ACString platform
 Get the current platform.
readonly attribute ACString oscpu
 Get the current oscpu.
attribute ACString language
 Get the translation of the application.
attribute ACString misc
 Get/Set the application comment misc portion.
readonly attribute ACString scheme
 The scheme of this protocol (e.g., "file").
readonly attribute long defaultPort
 The default port is the port that this protocol normally uses.
readonly attribute unsigned long protocolFlags
 Returns the protocol specific flags (see flag definitions below).
const unsigned long URI_STD = 0
 standard full URI with authority component and concept of relative URIs (http, ftp, ...)
const unsigned long URI_NORELATIVE = (1<<0)
 no concept of relative URIs (about, javascript, finger, ...)
const unsigned long URI_NOAUTH = (1<<1)
 no authority component (file, ...)
const unsigned long ALLOWS_PROXY = (1<<2)
 This protocol handler can be proxied via a proxy (socks or http) (e.g., irc, smtp, http, etc.).
const unsigned long ALLOWS_PROXY_HTTP = (1<<3)
 This protocol handler can be proxied using a http proxy (e.g., http, ftp, etc.).

Detailed Description

Definition at line 43 of file nsIHttpProtocolHandler.idl.


Member Function Documentation

boolean nsIProtocolHandler::allowPort ( in long  port,
in string  scheme 
) [inherited]

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.

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

Create a new channel with the given proxyInfo.

  
nsIURI nsIProtocolHandler::newURI ( in AUTF8String  aSpec,
in string  aOriginCharset,
in nsIURI  aBaseURI 
) [inherited]

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.)

Parameters:
aSpec- the URI string in UTF-8 encoding. depending on the protocol implementation, unicode character sequences may or may not be xx escaped.
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).
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.

Member Data Documentation

const unsigned long nsIProtocolHandler::ALLOWS_PROXY = (1<<2) [inherited]

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 also:
nsIProxiedProtocolHandler

Definition at line 148 of file nsIProtocolHandler.idl.

const unsigned long nsIProtocolHandler::ALLOWS_PROXY_HTTP = (1<<3) [inherited]

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.

Definition at line 156 of file nsIProtocolHandler.idl.

Get the application name.

Returns:
The name of this application (eg. "Mozilla").

Definition at line 55 of file nsIHttpProtocolHandler.idl.

Get the application version string.

Returns:
The complete version (major and minor) string. (eg. "5.0")

Definition at line 62 of file nsIHttpProtocolHandler.idl.

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.

Definition at line 61 of file nsIProtocolHandler.idl.

Get the translation of the application.

The value for language is usually a 2-letter code such as "en" and occasionally a five-character code to indicate a language subtype, such as "zh_CN".

Definition at line 114 of file nsIHttpProtocolHandler.idl.

Get/Set the application comment misc portion.

Definition at line 119 of file nsIHttpProtocolHandler.idl.

Get the current oscpu.

Returns:
The oscpu this application is running on

Definition at line 107 of file nsIHttpProtocolHandler.idl.

Get the current platform.

Returns:
The platform this application is running on (eg. "Windows", "Macintosh", "X11")

Definition at line 100 of file nsIHttpProtocolHandler.idl.

Returns:
The product name.

Definition at line 82 of file nsIHttpProtocolHandler.idl.

Returns:
A product comment.

Definition at line 92 of file nsIHttpProtocolHandler.idl.

Returns:
A product sub string.

Definition at line 87 of file nsIHttpProtocolHandler.idl.

readonly attribute unsigned long nsIProtocolHandler::protocolFlags [inherited]

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

Definition at line 66 of file nsIProtocolHandler.idl.

readonly attribute ACString nsIProtocolHandler::scheme [inherited]

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

Definition at line 54 of file nsIProtocolHandler.idl.

const unsigned long nsIProtocolHandler::URI_NOAUTH = (1<<1) [inherited]

no authority component (file, ...)

Definition at line 135 of file nsIProtocolHandler.idl.

const unsigned long nsIProtocolHandler::URI_NORELATIVE = (1<<0) [inherited]

no concept of relative URIs (about, javascript, finger, ...)

Definition at line 130 of file nsIProtocolHandler.idl.

const unsigned long nsIProtocolHandler::URI_STD = 0 [inherited]

standard full URI with authority component and concept of relative URIs (http, ftp, ...)

Definition at line 125 of file nsIProtocolHandler.idl.

Get the HTTP advertised user agent string.

Definition at line 48 of file nsIHttpProtocolHandler.idl.

Returns:
The vendor name.

Definition at line 67 of file nsIHttpProtocolHandler.idl.

Returns:
The vendor comment.

Definition at line 77 of file nsIHttpProtocolHandler.idl.

Returns:
The vendor sub string.

Definition at line 72 of file nsIHttpProtocolHandler.idl.


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