ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cpanel / ea-apr16 / include / apr-1

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * The APR LDAP rebind functions provide an implementation of
 * a rebind procedure that can be used to allow clients to chase referrals,
 * using the same credentials used to log in originally.
 *
 * Use of this implementation is optional.
 *
 * @file apr_ldap_rebind.h
 * @brief Apache LDAP library
 */

#ifndef APU_LDAP_REBIND_H
#define APU_LDAP_REBIND_H

/**
 * @addtogroup APR_Util_LDAP
 * @{
 **/

#if defined(DOXYGEN)
#include "apr_ldap.h"
#endif

/*
 * Handle the case when LDAP is enabled
 */
#if APR_HAS_LDAP

/**
 * APR LDAP initialize rebind lock
 *
 * This function creates the lock for controlling access to the xref list..
 * @param pool Pool to use when creating the xref_lock.
 */
APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_init(apr_pool_t *pool);

/**
 * APR LDAP rebind_add function
 *
 * This function creates a cross reference entry for the specified ldap
 * connection. The rebind callback function will look up this ldap 
 * connection so it can retrieve the bindDN and bindPW for use in any 
 * binds while referrals are being chased.
 *
 * This function will add the callback to the LDAP handle passed in.
 *
 * A cleanup is registered within the pool provided to remove this
 * entry when the pool is removed. Alternatively apr_ldap_rebind_remove()
 * can be called to explicitly remove the entry at will.
 *
 * @param pool The pool to use
 * @param ld The LDAP connectionhandle
 * @param bindDN The bind DN to be used for any binds while chasing 
 *               referrals on this ldap connection.
 * @param bindPW The bind Password to be used for any binds while 
 *               chasing referrals on this ldap connection.
 */
APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_add(apr_pool_t *pool,
                                                   LDAP *ld,
                                                   const char *bindDN,
                                                   const char *bindPW);

/**
 * APR LDAP rebind_remove function
 *
 * This function removes the rebind cross reference entry for the
 * specified ldap connection.
 *
 * If not explicitly removed, this function will be called automatically
 * when the pool is cleaned up.
 *
 * @param ld The LDAP connectionhandle
 */
APU_DECLARE_LDAP(apr_status_t) apr_ldap_rebind_remove(LDAP *ld);

#endif /* APR_HAS_LDAP */

/** @} */

#endif /* APU_LDAP_REBIND_H */

[-] apr_cstr.h [edit]
[-] apr_inherit.h [edit]
[-] apr_version.h [edit]
[-] apr_queue.h [edit]
[-] apr_xlate.h [edit]
[-] apr_sdbm.h [edit]
[-] apr_network_io.h [edit]
[-] apr_atomic.h [edit]
[-] apr_poll.h [edit]
[-] apr_fnmatch.h [edit]
[-] apr_pools.h [edit]
[-] apr_getopt.h [edit]
[-] apr_portable.h [edit]
[-] apr_proc_mutex.h [edit]
[+] ..
[-] apr_optional_hooks.h [edit]
[-] apr.h [edit]
[-] apr_ldap.h [edit]
[-] apr_ldap_url.h [edit]
[-] apr_ldap_init.h [edit]
[-] apr_file_io.h [edit]
[-] apr_encode.h [edit]
[-] apr_general.h [edit]
[-] apr_optional.h [edit]
[-] apr_time.h [edit]
[-] apr_mmap.h [edit]
[-] apr_memcache.h [edit]
[-] apr_thread_pool.h [edit]
[-] apr_errno.h [edit]
[-] apr_tables.h [edit]
[-] apr_random.h [edit]
[-] apr_strings.h [edit]
[-] apu_want.h [edit]
[-] apr_reslist.h [edit]
[-] apr_escape.h [edit]
[-] apr_base64.h [edit]
[-] apr_uri.h [edit]
[-] apr_strmatch.h [edit]
[-] apr_crypto.h [edit]
[-] apr_md5.h [edit]
[-] apr_xml.h [edit]
[-] apr_siphash.h [edit]
[-] apr_thread_mutex.h [edit]
[-] apr_redis.h [edit]
[-] apr_date.h [edit]
[-] apr_support.h [edit]
[-] apr_shm.h [edit]
[-] apr_uuid.h [edit]
[-] apu_version.h [edit]
[-] apr_sha1.h [edit]
[-] apr_rmm.h [edit]
[-] apr_dbm.h [edit]
[-] apr_thread_rwlock.h [edit]
[-] apr_hash.h [edit]
[-] apr_thread_proc.h [edit]
[-] apr-x86_64.h [edit]
[-] apr_lib.h [edit]
[-] apr_dso.h [edit]
[-] apr_user.h [edit]
[-] apr_global_mutex.h [edit]
[-] apr_allocator.h [edit]
[-] apr_file_info.h [edit]
[-] apr_anylock.h [edit]
[-] apu_errno.h [edit]
[-] apr_env.h [edit]
[-] apr_want.h [edit]
[-] apr_signal.h [edit]
[-] apr_hooks.h [edit]
[-] apr_buckets.h [edit]
[-] apr_ldap_rebind.h [edit]
[-] apr_thread_cond.h [edit]
[-] apr_md4.h [edit]
[-] apr_ring.h [edit]
[-] apr_skiplist.h [edit]
[-] apr_ldap_option.h [edit]
[-] apr_perms_set.h [edit]
[-] apu.h [edit]
[-] apr_dbd.h [edit]