gecko-dev/netwerk/base/public/nsINSSErrorsService.idl

87 lines
3.5 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Red Hat, Inc.
* Portions created by the Initial Developer are Copyright (C) 2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Kai Engert <kengert@redhat.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
[scriptable, uuid(3a5c7a0f-f5da-4a8b-a748-d7c5a528f33b)]
interface nsINSSErrorsService : nsISupports
{
/**
* @param aNSPRCode An error code obtained using PR_GetError()
* @return True if it is error code defined by the NSS library
*/
boolean isNSSErrorCode(in PRInt32 aNSPRCode);
/**
* Function will fail if aNSPRCode is not an NSS error code.
* @param aNSPRCode An error code obtained using PR_GetError()
* @return The result of the conversion, an XPCOM error code
*/
nsresult getXPCOMFromNSSError(in PRInt32 aNSPRCode);
/**
* Function will fail if aXPCOMErrorCode is not an NSS error code.
* @param aXPCOMErrorCode An error code obtain using getXPCOMFromNSSError
* return A localized human readable error explanation.
*/
AString getErrorMessage(in nsresult aXPCOMErrorCode);
/**
* Function will fail if aXPCOMErrorCode is not an NSS error code.
* @param aXPCOMErrorCode An error code obtain using getXPCOMFromNSSError
* return the
*/
PRUint32 getErrorClass(in nsresult aXPCOMErrorCode);
const unsigned long ERROR_CLASS_SSL_PROTOCOL = 1;
const unsigned long ERROR_CLASS_BAD_CERT = 2;
/**
* The following values define the range of NSPR error codes used by NSS.
* NSS remains the authorative source for these numbers, as a result,
* the values might change in the future.
* The security module will perform a runtime check and assertion
* to ensure the values are in synch with NSS.
*/
const long NSS_SEC_ERROR_BASE = -(0x2000);
const long NSS_SEC_ERROR_LIMIT = (NSS_SEC_ERROR_BASE + 1000);
const long NSS_SSL_ERROR_BASE = -(0x3000);
const long NSS_SSL_ERROR_LIMIT = (NSS_SSL_ERROR_BASE + 1000);
};