src/eldap.h

   1 /* Definitions for the LDAP client interface for XEmacs.
   2    Copyright (C) 1998 Free Software Foundation, Inc.
   3
   4 This file is part of XEmacs.
   5
   6 XEmacs is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with XEmacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef INCLUDED_eldap_h_
  22 #define INCLUDED_eldap_h_
  23
  24 #include <lber.h>
  25 #include <ldap.h>
  26
  27 /*
  28  * The following structure records pertinent information about a
  29  * LDAP connection.
  30  */
  31
  32 struct Lisp_LDAP
  33 {
  34   /* lcrecord header */
  35   struct lcrecord_header header;
  36   /* The LDAP connection handle used by the LDAP API */
  37   LDAP *ld;
  38   /* Name of the host we connected to */
  39   Lisp_Object host;
  40 };
  41 typedef struct Lisp_LDAP Lisp_LDAP;
  42
  43
  44 DECLARE_LRECORD (ldap, Lisp_LDAP);
  45 #define XLDAP(x) XRECORD (x, ldap, Lisp_LDAP)
  46 #define XSETLDAP(x, p) XSETRECORD (x, p, ldap)
  47 #define LDAPP(x) RECORDP (x, ldap)
  48 #define CHECK_LDAP(x) CHECK_RECORD (x, ldap)
  49 #define CONCHECK_LDAP(x) CONCHECK_RECORD (x, ldap)
  50
  51 #define CHECK_LIVE_LDAP(ldap) do {                                      \
  52   CHECK_LDAP (ldap);                                                    \
  53   if (!XLDAP (ldap)->ld)                                                \
  54     signal_simple_error ("Attempting to access closed LDAP connection", \
  55                          ldap);                                         \
  56 } while (0)
  57
  58
  59 Lisp_Object Fldapp (Lisp_Object object);
  60 Lisp_Object Fldap_host (Lisp_Object ldap);
  61 Lisp_Object Fldap_status (Lisp_Object ldap);
  62 Lisp_Object Fldap_open (Lisp_Object host,
  63                         Lisp_Object ldap_plist);
  64 Lisp_Object Fldap_close (Lisp_Object ldap);
  65 Lisp_Object Fldap_search_basic (Lisp_Object ldap,
  66                                 Lisp_Object filter,
  67                                 Lisp_Object base,
  68                                 Lisp_Object scope,
  69                                 Lisp_Object attrs,
  70                                 Lisp_Object attrsonly,
  71                                 Lisp_Object withdn,
  72                                 Lisp_Object verbose);
  73 Lisp_Object Fldap_add (Lisp_Object ldap,
  74                        Lisp_Object dn,
  75                        Lisp_Object entry);
  76 Lisp_Object Fldap_modify (Lisp_Object ldap,
  77                           Lisp_Object dn,
  78                           Lisp_Object entry);
  79 Lisp_Object Fldap_delete (Lisp_Object ldap,
  80                           Lisp_Object dn);
  81
  82 #endif /* INCLUDED_eldap_h_ */