Public Member Functions

nsIHttpAuthManager Interface Reference

nsIHttpAuthManager More...

import "nsIHttpAuthManager.idl";

List of all members.

Public Member Functions

void getAuthIdentity (in ACString aScheme, in ACString aHost, in PRInt32 aPort, in ACString aAuthType, in ACString aRealm, in ACString aPath, out AString aUserDomain, out AString aUserName, out AString aUserPassword)
 Lookup auth identity.
void setAuthIdentity (in ACString aScheme, in ACString aHost, in PRInt32 aPort, in ACString aAuthType, in ACString aRealm, in ACString aPath, in AString aUserDomain, in AString aUserName, in AString aUserPassword)
 Store auth identity.
void clearAll ()
 Clear all auth cache.

Detailed Description

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.


Member Function Documentation

void nsIHttpAuthManager::clearAll (  ) 

Clear all auth cache.

void nsIHttpAuthManager::getAuthIdentity ( in ACString  aScheme,
in ACString  aHost,
in PRInt32  aPort,
in ACString  aAuthType,
in ACString  aRealm,
in ACString  aPath,
out AString  aUserDomain,
out AString  aUserName,
out AString  aUserPassword 
)

Lookup auth identity.

Parameters:
aScheme the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for SSL tunneling).
aHost the host of the server issuing a challenge (ASCII only).
aPort the port of the server issuing a challenge.
aAuthType optional string identifying auth type used (e.g., "basic")
aRealm optional string identifying auth realm.
aPath optional string identifying auth path. empty for proxy auth.
aUserDomain return value containing user domain.
aUserName return value containing user name.
aUserPassword return value containing user password.
void nsIHttpAuthManager::setAuthIdentity ( in ACString  aScheme,
in ACString  aHost,
in PRInt32  aPort,
in ACString  aAuthType,
in ACString  aRealm,
in ACString  aPath,
in AString  aUserDomain,
in AString  aUserName,
in AString  aUserPassword 
)

Store auth identity.

Parameters:
aScheme the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for SSL tunneling).
aHost the host of the server issuing a challenge (ASCII only).
aPort the port of the server issuing a challenge.
aAuthType optional string identifying auth type used (e.g., "basic")
aRealm optional string identifying auth realm.
aPath optional string identifying auth path. empty for proxy auth.
aUserDomain optional string containing user domain.
aUserName optional string containing user name.
aUserPassword optional string containing user password.

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