firefox-dev 11.0+build1-0ubuntu4 / usr / include / firefox / nsIAuthModule.h

/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /build/buildd/firefox-11.0+build1/build-tree/mozilla/netwerk/base/public/nsIAuthModule.idl
 */

#ifndef __gen_nsIAuthModule_h__
#define __gen_nsIAuthModule_h__


#ifndef __gen_nsISupports_h__
#include "nsISupports.h"
#endif

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif

/* starting interface:    nsIAuthModule */
#define NS_IAUTHMODULE_IID_STR "6e35dbc0-49ef-4e2c-b1ea-b72ec64450a2"

#define NS_IAUTHMODULE_IID \
  {0x6e35dbc0, 0x49ef, 0x4e2c, \
    { 0xb1, 0xea, 0xb7, 0x2e, 0xc6, 0x44, 0x50, 0xa2 }}

class NS_NO_VTABLE nsIAuthModule : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IAUTHMODULE_IID)

  enum {
    REQ_DEFAULT = 0U,
    REQ_MUTUAL_AUTH = 1U,
    REQ_DELEGATE = 2U
  };

  /* void init (in string aServiceName, in unsigned long aServiceFlags, in wstring aDomain, in wstring aUsername, in wstring aPassword); */
  NS_IMETHOD Init(const char * aServiceName, PRUint32 aServiceFlags, const PRUnichar * aDomain, const PRUnichar * aUsername, const PRUnichar * aPassword) = 0;

  /* void getNextToken ([const] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
  NS_IMETHOD GetNextToken(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) = 0;

  /* void wrap ([const] in voidPtr aInToken, in unsigned long aInTokenLength, in boolean confidential, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
  NS_IMETHOD Wrap(const void *aInToken, PRUint32 aInTokenLength, bool confidential, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) = 0;

  /* void unwrap ([const] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
  NS_IMETHOD Unwrap(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsIAuthModule, NS_IAUTHMODULE_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIAUTHMODULE \
  NS_IMETHOD Init(const char * aServiceName, PRUint32 aServiceFlags, const PRUnichar * aDomain, const PRUnichar * aUsername, const PRUnichar * aPassword); \
  NS_IMETHOD GetNextToken(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM); \
  NS_IMETHOD Wrap(const void *aInToken, PRUint32 aInTokenLength, bool confidential, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM); \
  NS_IMETHOD Unwrap(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIAUTHMODULE(_to) \
  NS_IMETHOD Init(const char * aServiceName, PRUint32 aServiceFlags, const PRUnichar * aDomain, const PRUnichar * aUsername, const PRUnichar * aPassword) { return _to Init(aServiceName, aServiceFlags, aDomain, aUsername, aPassword); } \
  NS_IMETHOD GetNextToken(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return _to GetNextToken(aInToken, aInTokenLength, aOutToken, aOutTokenLength); } \
  NS_IMETHOD Wrap(const void *aInToken, PRUint32 aInTokenLength, bool confidential, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return _to Wrap(aInToken, aInTokenLength, confidential, aOutToken, aOutTokenLength); } \
  NS_IMETHOD Unwrap(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return _to Unwrap(aInToken, aInTokenLength, aOutToken, aOutTokenLength); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIAUTHMODULE(_to) \
  NS_IMETHOD Init(const char * aServiceName, PRUint32 aServiceFlags, const PRUnichar * aDomain, const PRUnichar * aUsername, const PRUnichar * aPassword) { return !_to ? NS_ERROR_NULL_POINTER : _to->Init(aServiceName, aServiceFlags, aDomain, aUsername, aPassword); } \
  NS_IMETHOD GetNextToken(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNextToken(aInToken, aInTokenLength, aOutToken, aOutTokenLength); } \
  NS_IMETHOD Wrap(const void *aInToken, PRUint32 aInTokenLength, bool confidential, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->Wrap(aInToken, aInTokenLength, confidential, aOutToken, aOutTokenLength); } \
  NS_IMETHOD Unwrap(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->Unwrap(aInToken, aInTokenLength, aOutToken, aOutTokenLength); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsAuthModule : public nsIAuthModule
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIAUTHMODULE

  nsAuthModule();

private:
  ~nsAuthModule();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(nsAuthModule, nsIAuthModule)

nsAuthModule::nsAuthModule()
{
  /* member initializers and constructor code */
}

nsAuthModule::~nsAuthModule()
{
  /* destructor code */
}

/* void init (in string aServiceName, in unsigned long aServiceFlags, in wstring aDomain, in wstring aUsername, in wstring aPassword); */
NS_IMETHODIMP nsAuthModule::Init(const char * aServiceName, PRUint32 aServiceFlags, const PRUnichar * aDomain, const PRUnichar * aUsername, const PRUnichar * aPassword)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void getNextToken ([const] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
NS_IMETHODIMP nsAuthModule::GetNextToken(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void wrap ([const] in voidPtr aInToken, in unsigned long aInTokenLength, in boolean confidential, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
NS_IMETHODIMP nsAuthModule::Wrap(const void *aInToken, PRUint32 aInTokenLength, bool confidential, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void unwrap ([const] in voidPtr aInToken, in unsigned long aInTokenLength, out voidPtr aOutToken, out unsigned long aOutTokenLength); */
NS_IMETHODIMP nsAuthModule::Unwrap(const void *aInToken, PRUint32 aInTokenLength, void **aOutToken NS_OUTPARAM, PRUint32 *aOutTokenLength NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif

/**
 * nsIAuthModule implementations are registered under the following contract
 * ID prefix:
 */
#define NS_AUTH_MODULE_CONTRACTID_PREFIX \
    "@mozilla.org/network/auth-module;1?name="
/**
 * This success code may be returned by nsIAuthModule::getNextToken to 
 * indicate that the authentication is finished and thus there's no need 
 * to call getNextToken again.
 */
#define NS_SUCCESS_AUTH_FINISHED \
    NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_NETWORK, 40)

#endif /* __gen_nsIAuthModule_h__ */