Interface nsIHttpAuthManagerType

nsIHttpAuthManager

This service provides access to cached HTTP authentication user credentials (domain, username, password) for sites visited during the current browser session.

This interface exists to provide other HTTP stacks with the ability to share HTTP authentication credentials with Necko. This is currently used by the Java plugin (version 1.5 and higher) to avoid duplicate authentication prompts when the Java client fetches content from a HTTP site that the user has already logged into.

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Clear all auth cache.

    Returns void

  • Lookup auth identity.

    Parameters

    • aScheme: string

      the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for CONNECT tunneling).

    • aHost: string

      the host of the server issuing a challenge (ASCII only).

    • aPort: int32_t

      the port of the server issuing a challenge.

    • aAuthType: string

      optional string identifying auth type used (e.g., "basic")

    • aRealm: string

      optional string identifying auth realm.

    • aPath: string

      optional string identifying auth path. empty for proxy auth.

    • aUserDomain: string

      return value containing user domain.

    • aUserName: string

      return value containing user name.

    • aUserPassword: string

      return value containing user password.

    • aIsPrivate: bool

      whether to look up a private or public identity (they are stored separately, for use by private browsing)

    • aPrincipal: nsIPrincipal

      the principal from which to derive information about which app/mozbrowser is in use for this request

    Returns void

  • Store auth identity.

    Parameters

    • aScheme: string

      the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for CONNECT tunneling).

    • aHost: string

      the host of the server issuing a challenge (ASCII only).

    • aPort: int32_t

      the port of the server issuing a challenge.

    • aAuthType: string

      optional string identifying auth type used (e.g., "basic")

    • aRealm: string

      optional string identifying auth realm.

    • aPath: string

      optional string identifying auth path. empty for proxy auth.

    • aUserDomain: string

      optional string containing user domain.

    • aUserName: string

      optional string containing user name.

    • aUserPassword: string

      optional string containing user password.

    • aIsPrivate: boolean

      whether to store a private or public identity (they are stored separately, for use by private browsing)

    • aPrincipal: nsIPrincipal

      the principal from which to derive information about which app/mozbrowser is in use for this request

    Returns void

Generated using TypeDoc