Main Page | Modules | Namespace List | Data Structures | File List | Data Fields | Globals | Related Pages

apr_ldap_url.h

00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APR_LDAP_URL_H
00056 #define APR_LDAP_URL_H
00057 
00058 #include "apr_ldap.h"
00059 
00060 #if APR_HAS_LDAP
00061 #if APR_HAS_LDAP_URL_PARSE
00062 
00063 #define apr_ldap_url_desc_t             LDAPURLDesc
00064 #define apr_ldap_is_ldap_url(url)       ldap_is_ldap_url(url)
00065 #define apr_ldap_is_ldaps_url(url)      ldap_is_ldaps_url(url)
00066 #define apr_ldap_is_ldapi_url(url)      ldap_is_ldapi_url(url)
00067 #define apr_ldap_url_parse(url, ludpp)  ldap_url_parse(url, ludpp)
00068 #define apr_ldap_free_urldesc(ludp)     ldap_free_urldesc(ludp)
00069 
00070 #else /* ! APR_HAS_LDAP_URL_PARSE */
00071 
00072 /*
00073  * types for ldap URL handling
00074  */
00075 typedef struct apr_ldap_url_desc_t {
00076     struct  apr_ldap_url_desc_t  *lud_next;
00077     char    *lud_scheme;
00078     char    *lud_host;
00079     int     lud_port;
00080     char    *lud_dn;
00081     char    **lud_attrs;
00082     int     lud_scope;
00083     char    *lud_filter;
00084     char    **lud_exts;
00085     int     lud_crit_exts;
00086 } apr_ldap_url_desc_t;
00087 
00088 #ifndef LDAP_URL_SUCCESS
00089 #define LDAP_URL_SUCCESS          0x00    /* Success */
00090 #define LDAP_URL_ERR_MEM          0x01    /* can't allocate memory space */
00091 #define LDAP_URL_ERR_PARAM        0x02    /* parameter is bad */
00092 #define LDAP_URL_ERR_BADSCHEME    0x03    /* URL doesn't begin with "ldap[si]://" */
00093 #define LDAP_URL_ERR_BADENCLOSURE 0x04    /* URL is missing trailing ">" */
00094 #define LDAP_URL_ERR_BADURL       0x05    /* URL is bad */
00095 #define LDAP_URL_ERR_BADHOST      0x06    /* host port is bad */
00096 #define LDAP_URL_ERR_BADATTRS     0x07    /* bad (or missing) attributes */
00097 #define LDAP_URL_ERR_BADSCOPE     0x08    /* scope string is invalid (or missing) */
00098 #define LDAP_URL_ERR_BADFILTER    0x09    /* bad or missing filter */
00099 #define LDAP_URL_ERR_BADEXTS      0x0a    /* bad or missing extensions */
00100 #endif
00101 
00102 /*
00103  * in url.c
00104  *
00105  * need _ext varients
00106  */
00107 APU_DECLARE(int) apr_ldap_is_ldap_url(const char *url);
00108 
00109 APU_DECLARE(int) apr_ldap_is_ldaps_url(const char *url);
00110 
00111 APU_DECLARE(int) apr_ldap_is_ldapi_url(const char *url);
00112 
00113 APU_DECLARE(int) apr_ldap_url_parse(const char *url, 
00114                                     apr_ldap_url_desc_t **ludpp);
00115 
00116 APU_DECLARE(void) apr_ldap_free_urldesc(apr_ldap_url_desc_t *ludp);
00117 
00118 #endif /* ! APR_HAS_LDAP_URL_PARSE */
00119 
00120 #endif /* APR_HAS_LDAP */
00121 
00122 #endif /* APR_LDAP_URL_H */

Generated on Wed Dec 8 00:35:22 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1