use URIs instead of hostname/port

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

diff --git a/contrib/ldapc++/src/LDAPRebindAuth.h b/contrib/ldapc++/src/LDAPRebindAuth.h
index c0441b90d54460953352908ae122611697e947c1..e631e67105a9baafc485eb60c770e6c4e2be80d8 100644 (file)
--- a/contrib/ldapc++/src/LDAPRebindAuth.h
+++ b/contrib/ldapc++/src/LDAPRebindAuth.h
@@ -8,18 +8,46 @@
 
 #include<string>
 
+/**
+ * This class represent Authenication information for the case that the
+ * library is chasing referrals.
+ *
+ * The LDAPRebind::getRebindAuth() method returns an object of this type.
+ * And the library uses it to authentication to the destination server of a  
+ * referral.
+ * @note currently only SIMPLE authentication is supported by the library
+ */
 class LDAPRebindAuth{
     public:
-        LDAPRebindAuth(const string& dn="", const string& pwd="");
+        /**
+         * @param dn  The DN that should be used for the authentication 
+         * @param pwd   The password that belongs to the DN
+         */
+        LDAPRebindAuth(const std::string& dn="", const std::string& pwd="");
+        
+        /**
+         * Copy-constructor
+         */
         LDAPRebindAuth(const LDAPRebindAuth& lra);
+
+        /**
+         * Destructor
+         */
         virtual ~LDAPRebindAuth();
 
-        const string& getDN() const;
-        const string& getPassword() const;
+        /**
+         * @return The DN that was set in the constructor
+         */
+        const std::string& getDN() const;
+
+        /**
+         * @return The password that was set in the constructor
+         */
+        const std::string& getPassword() const;
         
     private:
-        string m_dn;
-        string m_password;
+        std::string m_dn;
+        std::string m_password;
 };
 
 #endif //LDAP_REBIND_AUTH_H