diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 16:35:32 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 16:35:32 +0000 |
commit | 5ea77a75dd2d2158401331879f3c8f47940a732c (patch) | |
tree | d89dc06e9f4850a900f161e25f84e922c4f86cc8 /contrib/ldapc++/src/LDAPEntry.h | |
parent | Initial commit. (diff) | |
download | openldap-5ea77a75dd2d2158401331879f3c8f47940a732c.tar.xz openldap-5ea77a75dd2d2158401331879f3c8f47940a732c.zip |
Adding upstream version 2.5.13+dfsg.upstream/2.5.13+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | contrib/ldapc++/src/LDAPEntry.h | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/contrib/ldapc++/src/LDAPEntry.h b/contrib/ldapc++/src/LDAPEntry.h new file mode 100644 index 0000000..7155523 --- /dev/null +++ b/contrib/ldapc++/src/LDAPEntry.h @@ -0,0 +1,116 @@ +// $OpenLDAP$ +/* + * Copyright 2000-2022 The OpenLDAP Foundation, All Rights Reserved. + * COPYING RESTRICTIONS APPLY, see COPYRIGHT file + */ + + +#ifndef LDAP_ENTRY_H +#define LDAP_ENTRY_H +#include <ldap.h> + +#include <LDAPAttributeList.h> + +class LDAPAsynConnection; + +/** + * This class is used to store every kind of LDAP Entry. + */ +class LDAPEntry{ + + public : + /** + * Copy-constructor + */ + LDAPEntry(const LDAPEntry& entry); + + /** + * Constructs a new entry (also used as standard constructor). + * + * @param dn The Distinguished Name for the new entry. + * @param attrs The attributes for the new entry. + */ + LDAPEntry(const std::string& dn=std::string(), + const LDAPAttributeList *attrs=0); + + /** + * Used internally only. + * + * The constructor is used internally to create a LDAPEntry from + * the C-API's data structures. + */ + LDAPEntry(const LDAPAsynConnection *ld, LDAPMessage *msg); + + /** + * Destructor + */ + ~LDAPEntry(); + + /** + * Assignment operator + */ + LDAPEntry& operator=(const LDAPEntry& from); + + /** + * Sets the DN-attribute. + * @param dn: The new DN for the entry. + */ + void setDN(const std::string& dn); + + /** + * Sets the attributes of the entry. + * @param attr: A pointer to a std::list of the new attributes. + */ + void setAttributes(LDAPAttributeList *attrs); + + /** + * Get an Attribute by its AttributeType (simple wrapper around + * LDAPAttributeList::getAttributeByName() ) + * @param name The name of the Attribute to look for + * @return a pointer to the LDAPAttribute with the AttributeType + * "name" or 0, if there is no Attribute of that Type + */ + const LDAPAttribute* getAttributeByName(const std::string& name) const; + + /** + * Adds one Attribute to the List of Attributes (simple wrapper around + * LDAPAttributeList::addAttribute() ). + * @param attr The attribute to add to the list. + */ + void addAttribute(const LDAPAttribute& attr); + + /** + * Deletes all values of an Attribute from the list of Attributes + * (simple wrapper around LDAPAttributeList::delAttribute() ). + * @param type The attribute to delete. + */ + void delAttribute(const std::string& type); + + /** + * Replace an Attribute in the List of Attributes (simple wrapper + * around LDAPAttributeList::replaceAttribute() ). + * @param attr The attribute to add to the list. + */ + void replaceAttribute(const LDAPAttribute& attr); + + /** + * @returns The current DN of the entry. + */ + const std::string& getDN() const ; + + /** + * @returns A const pointer to the attributes of the entry. + */ + const LDAPAttributeList* getAttributes() const; + + /** + * This method can be used to dump the data of a LDAPResult-Object. + * It is only useful for debugging purposes at the moment + */ + friend std::ostream& operator << (std::ostream& s, const LDAPEntry& le); + + private : + LDAPAttributeList *m_attrs; + std::string m_dn; +}; +#endif //LDAP_ENTRY_H |