Entry rwlock is no longer needed as concurrency is managed

[openldap] / contrib / ldapc++ / src / LDAPUrl.h

diff --git a/contrib/ldapc++/src/LDAPUrl.h b/contrib/ldapc++/src/LDAPUrl.h
index fd269e05a821cf1ed42aa3b796512cb67d94b7b1..f2522d945ae019842fe98becda313d7c1b208ee1 100644 (file)
--- a/contrib/ldapc++/src/LDAPUrl.h
+++ b/contrib/ldapc++/src/LDAPUrl.h
@@ -8,30 +8,75 @@
 #define LDAP_URL_H
 
 #include <ldap.h>
-#include "StringList.h"
+#include <StringList.h>
+
+/**
+ * This class is used to analyze and store LDAP-Urls as returned by a
+ * LDAP-Server as Referrals and Search References. LDAP-URLs are defined
+ * in RFC1959 and have the following format: <BR>
+ * <code>
+ * ldap://host:port/baseDN[?attr[?scope[?filter]]] <BR>
+ * </code>
+ */
 class LDAPUrl{
-    
-    protected :
-        int m_Port;
-        int m_Scope;
-        string m_Host;
-        string m_DN;
-        string m_Filter;
-        StringList m_Attrs;
-        LDAPURLDesc *m_urlDesc;
-        string m_urlString;
 
     public : 
+        /**
+         * Create a new object from a c-std::string that contains a LDAP-Url
+         */
         LDAPUrl(const char *url);
+
+        /**
+         * Destructor
+         */
         ~LDAPUrl();
 
+        /**
+         * @return The part of the URL that is representing the network
+         * port
+         */
         int getPort() const;
+
+        /**
+         * @return The scope part of the URL is returned. 
+         */
         int getScope() const;
-        const string& getURLString() const;
-        const string& getHost() const;
-        const string& getDN() const;
-        const string& getFilter() const;
+
+        /**
+         * @return The complete URL as a std::string
+         */
+        const std::string& getURLString() const;
+
+        /**
+         * @return The hostname or IP-Address of the destination host.
+         */
+        const std::string& getHost() const;
+
+        /**
+         * @return The Base-DN part of the URL
+         */
+        const std::string& getDN() const;
+
+        
+        /**
+         * @return The Filter part of the URL
+         */
+        const std::string& getFilter() const;
+
+        /**
+         * @return The List of attributes  that was in the URL
+         */
         const StringList& getAttrs() const;
+    
+    protected :
+        int m_Port;
+        int m_Scope;
+        std::string m_Host;
+        std::string m_DN;
+        std::string m_Filter;
+        StringList m_Attrs;
+        LDAPURLDesc *m_urlDesc;
+        std::string m_urlString;
 };
 
 #endif //LDAP_URL_H