nsIHttpAuthManager
| IID: | 7ce8e9d1-8b4b-4883-a307-66fe12a50153 |
| Inherits From: | nsISupports |
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.
This interface is implemented by the following components:
Methods
void clearAll ( )
void getAuthIdentity ( ACString scheme , ACString host , PRInt32 port , ACString authType , ACString realm , ACString path , out AString userDomain , out AString userName , out AString userPassword )
void setAuthIdentity ( ACString scheme , ACString host , PRInt32 port , ACString authType , ACString realm , ACString path , AString userDomain , AString userName , AString userPassword )
void getAuthIdentity ( ACString scheme , ACString host , PRInt32 port , ACString authType , ACString realm , ACString path , out AString userDomain , out AString userName , out AString userPassword )
Lookup auth identity.
- Arguments:
- scheme: the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for SSL tunneling).
- host: the host of the server issuing a challenge (ASCII only).
- port: the port of the server issuing a challenge.
- authType: optional string identifying auth type used (e.g., "basic")
- realm: optional string identifying auth realm.
- path: optional string identifying auth path. empty for proxy auth.
- userDomain: return value containing user domain.
- userName: return value containing user name.
- userPassword: return value containing user password.
void setAuthIdentity ( ACString scheme , ACString host , PRInt32 port , ACString authType , ACString realm , ACString path , AString userDomain , AString userName , AString userPassword )
Store auth identity.
- Arguments:
- scheme: the URL scheme (e.g., "http"). NOTE: for proxy authentication, this should be "http" (this includes authentication for SSL tunneling).
- host: the host of the server issuing a challenge (ASCII only).
- port: the port of the server issuing a challenge.
- authType: optional string identifying auth type used (e.g., "basic")
- realm: optional string identifying auth realm.
- path: optional string identifying auth path. empty for proxy auth.
- userDomain: optional string containing user domain.
- userName: optional string containing user name.
- userPassword: optional string containing user password.
Reference documentation is generated from Mozilla's source.