include/apr-0/apr_ldap.h

   1 /* Copyright 2002-2004 The Apache Software Foundation
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /*
  17  * apr_ldap.h is generated from apr_ldap.h.in by configure -- do not edit apr_ldap.h
  18  */
  19 /**
  20  * @file apr_ldap.h
  21  * @brief  APR-UTIL LDAP
  22  */
  23 #ifndef APU_LDAP_H
  24 #define APU_LDAP_H
  25
  26 /**
  27  * @defgroup APR_Util_LDAP LDAP
  28  * @ingroup APR_Util
  29  * @{
  30  */
  31
  32
  33 /*
  34  * This switches LDAP support on or off.
  35  */
  36
  37 /* this will be defined if LDAP support was compiled into apr-util */
  38 #define APR_HAS_LDAP              0
  39
  40 /* this whole thing disappears if LDAP is not enabled */
  41 #if !APR_HAS_LDAP
  42
  43 #define APR_HAS_NETSCAPE_LDAPSDK    0
  44 #define APR_HAS_NOVELL_LDAPSDK      0
  45 #define APR_HAS_OPENLDAP_LDAPSDK    0
  46 #define APR_HAS_MICROSOFT_LDAPSDK   0
  47 #define APR_HAS_OTHER_LDAPSDK       0
  48
  49 #define APR_HAS_LDAP_SSL            0
  50 #define APR_HAS_LDAP_URL_PARSE    0
  51
  52
  53 #else /* ldap support available */
  54
  55 #ifdef APR_NOT_READY_YET
  56 /* FIXME: this code awaits support from apu-conf.m4 */
  57
  58    /* There a several LDAPv3 SDKs available on various platforms
  59     * define which LDAP SDK is used
  60  */
  61 #define APR_HAS_NETSCAPE_LDAPSDK    @apu_has_ldap_netscape@
  62 #define APR_HAS_NOVELL_LDAPSDK      @apu_has_ldap_novell@
  63 #define APR_HAS_OPENLDAP_LDAPSDK    @apu_has_ldap_openldap@
  64 #define APR_HAS_MICROSOFT_LDAPSDK   @apu_has_ldap_microsoft@
  65 #define APR_HAS_OTHER_LDAPSDK       @apu_has_ldap_other@
  66
  67    /* define if LDAP SSL support is available
  68    */
  69 #define APR_HAS_LDAP_SSL            @apu_has_ldap_ssl@
  70
  71 #else /* APR_NOT_READY_YET */
  72
  73 /* FIXME: remove this when above code works.  Default to build with
  74  * OpenLDAP until apu-conf.m4 support exists */
  75 #define APR_HAS_OPENLDAP_LDAPSDK 1
  76 #define APR_HAS_LDAP_SSL 1
  77
  78 #endif /* APR_NOT_READY_YET */
  79
  80    /* If no APR_HAS_xxx_LDAPSDK is defined error out
  81     * Define if the SDK supports the ldap_url_parse function
  82    */
  83 #if APR_HAS_NETSCAPE_LDAPSDK
  84    #define APR_HAS_LDAP_URL_PARSE      1
  85 #elif APR_HAS_NOVELL_LDAPSDK
  86    #define APR_HAS_LDAP_URL_PARSE      1
  87 #elif APR_HAS_OPENLDAP_LDAPSDK
  88    #define APR_HAS_LDAP_URL_PARSE      1
  89 #elif APR_HAS_MICROSOFT_LDAPSDK
  90    #define APR_HAS_LDAP_URL_PARSE      0
  91 #elif APR_HAS_OTHER_LDAPSDK
  92    #define APR_HAS_LDAP_URL_PARSE      0
  93 #else
  94    #define APR_HAS_LDAP_URL_PARSE      0
  95    #error "ERROR no LDAP SDK defined!"
  96 #endif
  97
  98 /* These are garbage, our public macros are always APR_HAS_ prefixed,
  99  * and use 0/1 values, not defined/undef semantics.
 100  *
 101  * Will be deprecated in APR 1.0
 102  */
 103 #if APR_HAS_LDAP
 104 #define APU_HAS_LDAP
 105 #endif
 106
 107 /* LDAP header files */
 108
 109 #if APR_HAS_NETSCAPE_LDAPSDK
 110
 111
 112 #if APR_HAS_LDAP_SSL
 113
 114 #endif
 115 #endif
 116
 117 #if APR_HAS_NOVELL_LDAPSDK
 118
 119
 120 #if APR_HAS_LDAP_SSL
 121
 122 #endif
 123 #endif
 124
 125 #if APR_HAS_OPENLDAP_LDAPSDK
 126 #if !defined(LDAP_DEPRECATED)
 127 /* Ensure that the "deprecated" interfaces are still exposed
 128  * with OpenLDAP >= 2.3; these were exposed by default in earlier
 129  * releases. */
 130 #define LDAP_DEPRECATED 1
 131 #endif
 132
 133
 134 #endif
 135
 136 /* MS & v2 LDAP SDKs don't use const parameters in their prototypes,
 137  * LDAPv3 SDKs mostly use const.  Bridge the gap for clean compilation.
 138  */
 139
 140 #if LDAP_VERSION_MAX <= 2 || APR_HAS_MICROSOFT_LDAPSDK || defined(DOXYGEN)
 141 /**
 142  * Cast away constness to compile cleanly against v2 and MS LDAP SDKs
 143  * @param conststr The value to un-constify on older LDAP SDKs
 144  */
 145 #define APR_LDAP_UNCONST(conststr) ((char *)(conststr))
 146 #else
 147 #define APR_LDAP_UNCONST(conststr) (conststr)
 148 #endif
 149
 150 #ifndef __cplusplus
 151 /**
 152  * Cast away constness to compile against v2 and MS LDAP SDKs
 153  * @param conststr The value to un-constify on older LDAP SDKs
 154  * @bug The apr_ldap.h macro const_cast violated three rules;
 155  *   it was a C++ reserved keyword, it violated the uppercase-only
 156  *   style guideline for apr macros, and it was not namespace protected.
 157  *   It exists here soley to avoid breaking legacy sources using APR 0.9.
 158  * @deprecated @see APR_LDAP_UNCONST
 159  */
 160 #define const_cast(conststr) APR_LDAP_UNCONST(conststr)
 161 #endif
 162
 163 #include "apr_ldap_url.h"
 164
 165 /* Define some errors that are mysteriously gone from OpenLDAP 2.x */
 166 #ifndef LDAP_URL_ERR_NOTLDAP
 167 #define LDAP_URL_ERR_NOTLDAP LDAP_URL_ERR_BADSCHEME
 168 #endif
 169
 170 #ifndef LDAP_URL_ERR_NODN
 171 #define LDAP_URL_ERR_NODN LDAP_URL_ERR_BADURL
 172 #endif
 173
 174 /** @} */
 175 #endif /* APR_HAS_LDAP */
 176 #endif /* APU_LDAP_H */