Interface nsIHttpAuthenticableChannelType

Hierarchy

Properties

URI WWWChallenges httpProxyConnectResponseCode isSSL loadFlags loadGroup notificationCallbacks proxyChallenges proxyInfo proxyMethodIsConnect requestMethod serverResponseHeader

Methods

AddRef QueryInterface Release cancel closeStickyConnection connectionRestartable onAuthAvailable onAuthCancelled setProxyCredentials setWWWCredentials

Properties

Readonly URI

URI: nsIURI

The URI corresponding to the channel. See nsIChannel.

Readonly WWWChallenges

WWWChallenges: string

The WWW-Authenticate response header.

Readonly httpProxyConnectResponseCode

httpProxyConnectResponseCode: int32_t

The HTTP response code returned from the proxy to the CONNECT method. The response code is only available when we get the response from the proxy server, so this value is known in and after OnStartRequest.

If CONNECT method is not used, httpProxyConnectResponseCode is always -1. After OnStartRequest, httpProxyConnectResponseCode is the real HTTP response code or 0 if we can't reach to the proxy.

Readonly isSSL

isSSL: boolean

If the channel being authenticated is using SSL.

Readonly loadFlags

loadFlags: nsLoadFlags

The load flags of this request. See nsIRequest.

Readonly loadGroup

loadGroup: nsILoadGroup

The load group of this request. It is here for querying its notificationCallbacks. See nsIRequest.

Readonly notificationCallbacks

notificationCallbacks: nsIInterfaceRequestor

The notification callbacks for the channel. See nsIChannel.

Readonly proxyChallenges

proxyChallenges: string

The Proxy-Authenticate response header.

Readonly proxyInfo

proxyInfo: nsIProxyInfo

Gets the proxy info the channel was constructed with. null or a proxyInfo with type "direct" mean no proxy.

The returned proxy info must not be modified.

Readonly proxyMethodIsConnect

proxyMethodIsConnect: boolean

Returns if the proxy HTTP method used is CONNECT. If no proxy is being used it must return PR_FALSE.

Readonly requestMethod

requestMethod: string

The HTTP request method. See nsIHttpChannel.

Readonly serverResponseHeader

serverResponseHeader: string

The "Server" response header. Return NS_ERROR_NOT_AVAILABLE if not available.

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

cancel

  • Cancels the current request. See nsIRequest.

    Parameters

    • aStatus: number

    Returns void

closeStickyConnection

  • Tells the channel to drop and close any sticky connection, since this connection oriented schema cannot be negotiated second time on the same connection.

    Returns void

connectionRestartable

  • Tells the channel to mark the connection as allowed to restart on authentication retry. This is allowed when the request is a start of a new authentication round.

    Parameters

    • restartable: boolean

    Returns void

onAuthAvailable

  • Called when authentication information is ready and has been set on this object using setWWWCredentials/setProxyCredentials. Implementations can continue with the request and send the given information to the server.

    It is called asynchronously from nsIHttpChannelAuthProvider::processAuthentication if that method returns NS_ERROR_IN_PROGRESS.

    Note

    Any exceptions thrown from this method should be ignored.

    Returns void

onAuthCancelled

  • Notifies that the prompt was cancelled. It is called asynchronously from nsIHttpChannelAuthProvider::processAuthentication if that method returns NS_ERROR_IN_PROGRESS.

    Parameters

    • userCancel: boolean

      If the user was cancelled has cancelled the authentication prompt.

    Returns void

setProxyCredentials

  • Sets the Proxy-Authorization request header. An empty string will clear it.

    Parameters

    • credentials: string

    Returns void

setWWWCredentials

  • Sets the Authorization request header. An empty string will clear it.

    Parameters

    • credentials: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc