Back to index

lightning-sunbird  0.9+nobinonly
nsLDAPMessage.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  * 
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the mozilla.org LDAP XPCOM SDK.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 2000
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Dan Mosedale <dmose@mozilla.org>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef _nsLDAPMessage_h_
00041 #define _nsLDAPMessage_h_
00042 
00043 #include "ldap.h"
00044 #include "nsILDAPMessage.h"
00045 #include "nsILDAPOperation.h"
00046 #include "nsCOMPtr.h"
00047 #include "nsHashtable.h"
00048 
00049 // 76e061ad-a59f-43b6-b812-ee6e8e69423f
00050 //
00051 #define NS_LDAPMESSAGE_CID \
00052 { 0x76e061ad, 0xa59f, 0x43b6, \
00053   { 0xb8, 0x12, 0xee, 0x6e, 0x8e, 0x69, 0x42, 0x3f }}
00054 
00055 class nsLDAPMessage : public nsILDAPMessage
00056 {
00057     friend class nsLDAPOperation;
00058     friend class nsLDAPConnection;
00059     friend class nsLDAPConnectionLoop;
00060     friend PRBool PR_CALLBACK CheckLDAPOperationResult(nsHashKey *aKey, 
00061                                                        void *aData,
00062                                                        void* aClosure);
00063 
00064   public:       
00065 
00066     NS_DECL_ISUPPORTS
00067     NS_DECL_NSILDAPMESSAGE
00068 
00069     // constructor & destructor
00070     //
00071     nsLDAPMessage();
00072     virtual ~nsLDAPMessage();
00073 
00074   protected:
00075     nsresult IterateAttrErrHandler(PRInt32 aLderrno, PRUint32 *aAttrCount, 
00076                             char** *aAttributes, BerElement *position);
00077     nsresult IterateAttributes(PRUint32 *aAttrCount, char** *aAttributes, 
00078                               PRBool getP);
00079     nsresult Init(nsILDAPConnection *aConnection, 
00080                   LDAPMessage *aMsgHandle);
00081     LDAPMessage *mMsgHandle; // the message we're wrapping
00082     nsCOMPtr<nsILDAPOperation> mOperation;  // operation this msg relates to
00083 
00084     LDAP *mConnectionHandle; // cached connection this op is on
00085 
00086     // since we're caching the connection handle (above), we need to 
00087     // hold an owning ref to the relevant nsLDAPConnection object as long
00088     // as we're around
00089     //
00090     nsCOMPtr<nsILDAPConnection> mConnection; 
00091 
00092     // the next five member vars are returned by ldap_parse_result()
00093     //
00094     int mErrorCode;
00095     char *mMatchedDn;
00096     char *mErrorMessage;
00097     char **mReferrals;
00098     LDAPControl **mServerControls;
00099 };
00100 
00101 #endif // _nsLDAPMessage_h