📄 pldap_8h-source.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>pldap.h Source File</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>pldap.h</h1><a href="pldap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>00002 <span class="comment"> * pldap.h</span>00003 <span class="comment"> *</span>00004 <span class="comment"> * Lightweight Directory Access Protocol interface class.</span>00005 <span class="comment"> *</span>00006 <span class="comment"> * Portable Windows Library</span>00007 <span class="comment"> *</span>00008 <span class="comment"> * Copyright (c) 1993-2003 Equivalence Pty. Ltd.</span>00009 <span class="comment"> *</span>00010 <span class="comment"> * The contents of this file are subject to the Mozilla Public License</span>00011 <span class="comment"> * Version 1.0 (the "License"); you may not use this file except in</span>00012 <span class="comment"> * compliance with the License. You may obtain a copy of the License at</span>00013 <span class="comment"> * http://www.mozilla.org/MPL/</span>00014 <span class="comment"> *</span>00015 <span class="comment"> * Software distributed under the License is distributed on an "AS IS"</span>00016 <span class="comment"> * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See</span>00017 <span class="comment"> * the License for the specific language governing rights and limitations</span>00018 <span class="comment"> * under the License.</span>00019 <span class="comment"> *</span>00020 <span class="comment"> * The Original Code is Portable Windows Library.</span>00021 <span class="comment"> *</span>00022 <span class="comment"> * The Initial Developer of the Original Code is Equivalence Pty. Ltd.</span>00023 <span class="comment"> *</span>00024 <span class="comment"> * Contributor(s): ______________________________________.</span>00025 <span class="comment"> *</span>00026 <span class="comment"> * $Log: pldap.h,v $</span>00027 <span class="comment"> * Revision 1.9 2004/05/24 12:02:49 csoutheren</span>00028 <span class="comment"> * Add function to permit setting a limit on the number of results returned</span>00029 <span class="comment"> * from an LDAP query. Change the default number of results to unlimited,</span>00030 <span class="comment"> * rather than MAX_INT which apparently is clamped to some arbitrary low value.</span>00031 <span class="comment"> * Thanks to Damien Sandras</span>00032 <span class="comment"> *</span>00033 <span class="comment"> * Revision 1.8 2004/02/20 16:28:27 ykiryanov</span>00034 <span class="comment"> * if'd LDAP code to enable non-LDAP builds</span>00035 <span class="comment"> *</span>00036 <span class="comment"> * Revision 1.7 2003/06/05 23:17:07 rjongbloed</span>00037 <span class="comment"> * Added functions to get and set LDAP operation timeout.</span>00038 <span class="comment"> *</span>00039 <span class="comment"> * Revision 1.6 2003/06/05 05:29:30 rjongbloed</span>00040 <span class="comment"> * Fixed LDAP bind authentication methods, thanks Ravelli Rossano</span>00041 <span class="comment"> *</span>00042 <span class="comment"> * Revision 1.5 2003/04/07 12:00:04 robertj</span>00043 <span class="comment"> * Fixed search function returning an error if can't find anything for filter.</span>00044 <span class="comment"> *</span>00045 <span class="comment"> * Revision 1.4 2003/04/01 07:05:29 robertj</span>00046 <span class="comment"> * Added ability to specify host:port in opening an LDAP server</span>00047 <span class="comment"> *</span>00048 <span class="comment"> * Revision 1.3 2003/03/31 09:02:43 robertj</span>00049 <span class="comment"> * Added missing return for error number.</span>00050 <span class="comment"> *</span>00051 <span class="comment"> * Revision 1.2 2003/03/31 03:32:41 robertj</span>00052 <span class="comment"> * Major addition of functionality.</span>00053 <span class="comment"> *</span>00054 <span class="comment"> * Revision 1.1 2003/03/28 01:15:44 robertj</span>00055 <span class="comment"> * OpenLDAP support.</span>00056 <span class="comment"> *</span>00057 <span class="comment"> *</span>00058 <span class="comment"> */</span>00059 00060 <span class="preprocessor">#ifndef _PLDAP_H</span>00061 <span class="preprocessor"></span><span class="preprocessor">#define _PLDAP_H</span>00062 <span class="preprocessor"></span>00063 <span class="preprocessor">#ifdef P_USE_PRAGMA</span>00064 <span class="preprocessor"></span><span class="preprocessor">#pragma interface</span>00065 <span class="preprocessor"></span><span class="preprocessor">#endif</span>00066 <span class="preprocessor"></span>00067 <span class="preprocessor">#if P_LDAP</span>00068 <span class="preprocessor"></span>00069 <span class="preprocessor">#include <<a class="code" href="sockets_8h.html">ptlib/sockets.h</a>></span>00070 00071 00072 <span class="keyword">struct </span>ldap;00073 <span class="keyword">struct </span>ldapmsg;00074 <span class="keyword">struct </span>ldapmod;00075 <span class="keyword">struct </span>berval;00076 00077 <span class="keyword">class </span>PLDAPStructBase;00078 00079 00082 <span class="keyword">class </span>PLDAPSession : <span class="keyword">public</span> <a class="code" href="classPObject.html">PObject</a>00083 {00084 <a class="code" href="object_8h.html#a27">PCLASSINFO</a>(PLDAPSession, <a class="code" href="classPObject.html">PObject</a>);00085 <span class="keyword">public</span>:00088 PLDAPSession(00089 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & defaultBaseDN = <a class="code" href="classPString.html#z231_33">PString::Empty</a>()00090 );00091 00094 ~PLDAPSession();00095 00102 BOOL Open(00103 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & server,00104 WORD port = 000105 );00106 00109 BOOL Close();00110 00113 BOOL IsOpen()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ldapContext != NULL; }00114 00117 BOOL SetOption(00118 <span class="keywordtype">int</span> optcode,00119 <span class="keywordtype">int</span> value00120 );00121 00124 BOOL SetOption(00125 <span class="keywordtype">int</span> optcode,00126 <span class="keywordtype">void</span> * value00127 );00128 00129 <span class="keyword">enum</span> AuthenticationMethod {00130 AuthSimple,00131 AuthSASL,00132 AuthKerberos,00133 NumAuthenticationMethod00134 };00135 00138 BOOL Bind(00139 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & who = <a class="code" href="classPString.html#z231_33">PString::Empty</a>(),00140 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & passwd = <a class="code" href="classPString.html#z231_33">PString::Empty</a>(),00141 AuthenticationMethod authMethod = AuthSimple00142 );00143 00144 <span class="keyword">class </span>ModAttrib : <span class="keyword">public</span> <a class="code" href="classPObject.html">PObject</a> {00145 <a class="code" href="object_8h.html#a27">PCLASSINFO</a>(ModAttrib, <a class="code" href="classPObject.html">PObject</a>);00146 <span class="keyword">public</span>:00147 <span class="keyword">enum</span> Operation {00148 Add,00149 Replace,00150 Delete,00151 NumOperations00152 };00153 00154 <span class="keyword">protected</span>:00155 ModAttrib(00156 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00157 Operation op = NumOperations00158 );00159 00160 <span class="keyword">public</span>:00161 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & GetName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name; }00162 00163 Operation GetOperation()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> op; }00164 00165 <span class="keywordtype">void</span> SetLDAPMod(00166 <span class="keyword">struct</span> ldapmod & mod,00167 Operation defaultOp00168 );00169 00170 <span class="keyword">protected</span>:00171 <span class="keyword">virtual</span> BOOL IsBinary() <span class="keyword">const</span> = 0;00172 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLDAPModVars(<span class="keyword">struct</span> ldapmod & mod) = 0;00173 00174 <a class="code" href="classPString.html">PString</a> name;00175 Operation op;00176 };00177 00178 <span class="keyword">class </span>StringModAttrib : <span class="keyword">public</span> ModAttrib {00179 <a class="code" href="object_8h.html#a27">PCLASSINFO</a>(StringModAttrib, ModAttrib);00180 <span class="keyword">public</span>:00181 StringModAttrib(00182 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00183 Operation op = NumOperations00184 );00185 StringModAttrib(00186 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00187 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & value,00188 Operation op = NumOperations00189 );00190 StringModAttrib(00191 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00192 <span class="keyword">const</span> <a class="code" href="classPStringList.html">PStringList</a> & values,00193 Operation op = NumOperations00194 );00195 <span class="keywordtype">void</span> SetValue(00196 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & value00197 );00198 <span class="keywordtype">void</span> AddValue(00199 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & value00200 );00201 <span class="keyword">protected</span>:00202 <span class="keyword">virtual</span> BOOL IsBinary() <span class="keyword">const</span>;00203 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLDAPModVars(<span class="keyword">struct</span> ldapmod & mod);00204 00205 <a class="code" href="classPStringList.html">PStringList</a> values;00206 PBaseArray<char *> pointers;00207 };00208 00209 <span class="keyword">class </span>BinaryModAttrib : <span class="keyword">public</span> ModAttrib {00210 <a class="code" href="object_8h.html#a27">PCLASSINFO</a>(BinaryModAttrib, ModAttrib);00211 <span class="keyword">public</span>:00212 BinaryModAttrib(00213 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00214 Operation op = Add00215 );00216 BinaryModAttrib(00217 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00218 <span class="keyword">const</span> <a class="code" href="classPBYTEArray.html">PBYTEArray</a> & value,00219 Operation op = Add00220 );00221 BinaryModAttrib(00222 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & name,00223 <span class="keyword">const</span> PList<PBYTEArray> & values,00224 Operation op = Add00225 );00226 <span class="keywordtype">void</span> SetValue(00227 <span class="keyword">const</span> <a class="code" href="classPBYTEArray.html">PBYTEArray</a> & value00228 );00229 <span class="keywordtype">void</span> AddValue(00230 <span class="keyword">const</span> <a class="code" href="classPBYTEArray.html">PBYTEArray</a> & value00231 );00232 <span class="keyword">protected</span>:00233 <span class="keyword">virtual</span> BOOL IsBinary() <span class="keyword">const</span>;00234 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLDAPModVars(<span class="keyword">struct</span> ldapmod & mod);00235 00236 PList<PBYTEArray> values;00237 PBaseArray<struct berval *> pointers;00238 <a class="code" href="classPBYTEArray.html">PBYTEArray</a> bervals;00239 };00240 00243 BOOL Add(00244 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & dn,00245 <span class="keyword">const</span> PList<ModAttrib> & attributes00246 );00247 00250 BOOL Add(00251 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & dn,00252 <span class="keyword">const</span> <a class="code" href="classPStringToString.html">PStringToString</a> & attributes00253 );00254 00258 BOOL Add(00259 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & dn,00260 <span class="keyword">const</span> <a class="code" href="classPStringArray.html">PStringArray</a> & attributes00261 );00262 00266 BOOL Add(00267 <span class="keyword">const</span> <a class="code" href="classPString.html">PString</a> & dn,00268 <span class="keyword">const</span> PLDAPStructBase & data⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -