diff options
Diffstat (limited to 'contrib/ldapc++/src/LDAPAttribute.h')
| -rw-r--r-- | contrib/ldapc++/src/LDAPAttribute.h | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/contrib/ldapc++/src/LDAPAttribute.h b/contrib/ldapc++/src/LDAPAttribute.h new file mode 100644 index 0000000..41fc0d2 --- /dev/null +++ b/contrib/ldapc++/src/LDAPAttribute.h @@ -0,0 +1,181 @@ +// $OpenLDAP$ +/* + * Copyright 2000-2018 The OpenLDAP Foundation, All Rights Reserved. + * COPYING RESTRICTIONS APPLY, see COPYRIGHT file + */ + + +#ifndef LDAP_ATTRIBUTE_H +#define LDAP_ATTRIBUTE_H + +#include<iostream> +#include<string> +#include<ldap.h> +#include<lber.h> + +#include <StringList.h> + +/** + * Represents the name an value(s) of an Attribute + */ +class LDAPAttribute{ + public : + /** + * Default constructor. + * initializes an empty object. + */ + LDAPAttribute(); + + /** + * Copy constructor. + * Copies all values of an Attribute to a new one + * @param attr The Attribute that should be copied + */ + LDAPAttribute(const LDAPAttribute& attr); + + /** + * Construct an Attribute with a single string value + * @param name The attribute's name (type) + * @param value The string value of the attribute, if "" the + * attribute will have no values, for LDAPv3 + * this values must be UTF-8 encoded + */ + LDAPAttribute(const std::string& name, const std::string& value=""); + + /** + * Construct an attribute with multiple string values + * @param name The attribute's name (type) + * @param values A 0-terminated array of char*. Each char* specifies + * one value of the attribute (UTF-8 encoded) + */ + LDAPAttribute(const char* name, char **values); + + /** + * Construct an attribute with multiple string values + * @param name The attribute's name (type) + * @param values A list of strings. Each element specifies + * one value of the attribute (UTF-8 or binary + * encoded) + */ + LDAPAttribute(const std::string& name, const StringList& values); + + /** + * Construct an attribute with multiple binary coded values + * @param name The attribute's name (type) + * @param values 0-terminated array of binary attribute values + * The BerValue struct is declared as:<BR> + * struct berval{ + * unsigned long bv_len; + * char *bv_val; + * } BerValue; + */ + LDAPAttribute(const char* name, BerValue **values); + + /** + * Destructor + */ + ~LDAPAttribute(); + + /** + * Add a single string value(bin/char) to the Attribute + * @param value Value that should be added, it is copied inside the + * object + */ + void addValue(const std::string& value); + + /** + * Add a single binary value to the Attribute + * @param value The binary coded value that should be added to the + * Attribute. + * @return 0 no problem <BR> + * -1 failure (mem. allocation problem) + */ + int addValue(const BerValue *value); + + /** + * Set the values of the attribute. If the object contains some values + * already, they are deleted + * @param values 0-terminated array of char*, each char* + * representing a string value to add to the entry + * + * @return 0 no problem <BR> + * -1 failure (mem. allocation problem) + */ + int setValues(char** values); + + /** + * Set the values of the attribute. If the object does already contain + * some values, they will be deleted + * @param values 0-terminated array of BerValue*, each BerValue + * representing a binary value to add to the entry + * + * @return 0 no problem <BR> + * -1 failure (mem. allocation problem) + */ + int setValues(BerValue** values); + + /** + * Set the values of the attribute. If the object does already contain + * some values, they will be deleted + * @param values A list of string-Objects. Each string is + * representing a string or binary value to add to + * the entry + */ + void setValues(const StringList& values); + + /** + * For interal use only. + * This method is used to translate the values of the Attribute to + * 0-terminated Array of BerValue-structs as used by the C-API + * @return The Values of the Attribute as an 0-terminated Array of + * BerValue* (is dynamically allocated, delete it after usage) + * <BR> + * 0-pointer in case of error + */ + BerValue** getBerValues() const; + + /** + * @return The values of the array as a list of strings + */ + const StringList& getValues() const; + + /** + * @return The number of values of the attribute + */ + int getNumValues() const; + + /** + * @return The name(type) of the attribute + */ + const std::string& getName() const ; + + /** + * Sets the Attribute's name (type) + * @param the new name of the object + */ + void setName(const std::string& name); + + /** + * For internal use only. + * + * This method translate the attribute of the object into a + * LDAPMod-Structure as used by the C-API + */ + LDAPMod* toLDAPMod() const ; + + /** + * @return true If the attribute contains non-printable attributes + */ + bool isNotPrintable() const ; + + private : + std::string m_name; + StringList m_values; + + /** + * 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 LDAPAttribute& attr); +}; +#endif //#ifndef LDAP_ATTRIBUTE_H |