ldapsdk  0.0.1
Public Member Functions | Friends | List of all members
LDAPEntry Class Reference

This class is used to store every kind of LDAP Entry. More...

#include <LDAPEntry.h>

Public Member Functions

 LDAPEntry (const LDAPEntry &entry)
 Copy-constructor. More...
 
 LDAPEntry (const std::string &dn=std::string(), const LDAPAttributeList *attrs=0)
 Constructs a new entry (also used as standard constructor). More...
 
 LDAPEntry (const LDAPAsynConnection *ld, LDAPMessage *msg)
 Used internally only. More...
 
 ~LDAPEntry ()
 Destructor. More...
 
LDAPEntryoperator= (const LDAPEntry &from)
 Assignment operator. More...
 
void setDN (const std::string &dn)
 Sets the DN-attribute. More...
 
void setAttributes (LDAPAttributeList *attrs)
 Sets the attributes of the entry. More...
 
const LDAPAttributegetAttributeByName (const std::string &name) const
 Get an Attribute by its AttributeType (simple wrapper around LDAPAttributeList::getAttributeByName() ) More...
 
void addAttribute (const LDAPAttribute &attr)
 Adds one Attribute to the List of Attributes (simple wrapper around LDAPAttributeList::addAttribute() ). More...
 
void delAttribute (const std::string &type)
 Deletes all values of an Attribute from the list of Attributes (simple wrapper around LDAPAttributeList::delAttribute() ). More...
 
void replaceAttribute (const LDAPAttribute &attr)
 Replace an Attribute in the List of Attributes (simple wrapper around LDAPAttributeList::replaceAttribute() ). More...
 
const std::string & getDN () const
 
const LDAPAttributeListgetAttributes () const
 

Friends

std::ostream & operator<< (std::ostream &s, const LDAPEntry &le)
 This method can be used to dump the data of a LDAPResult-Object. More...
 

Detailed Description

This class is used to store every kind of LDAP Entry.

Constructor & Destructor Documentation

◆ LDAPEntry() [1/3]

LDAPEntry::LDAPEntry ( const LDAPEntry entry)

Copy-constructor.

References DEBUG, and LDAP_DEBUG_CONSTRUCT.

◆ LDAPEntry() [2/3]

LDAPEntry::LDAPEntry ( const std::string &  dn = std::string(),
const LDAPAttributeList attrs = 0 
)

Constructs a new entry (also used as standard constructor).

Parameters
dnThe Distinguished Name for the new entry.
attrsThe attributes for the new entry.

◆ LDAPEntry() [3/3]

LDAPEntry::LDAPEntry ( const LDAPAsynConnection ld,
LDAPMessage *  msg 
)

Used internally only.

The constructor is used internally to create a LDAPEntry from the C-API's data structurs.

References DEBUG, LDAPAsynConnection::getSessionHandle(), and LDAP_DEBUG_CONSTRUCT.

◆ ~LDAPEntry()

LDAPEntry::~LDAPEntry ( )

Destructor.

References DEBUG, and LDAP_DEBUG_DESTROY.

Member Function Documentation

◆ addAttribute()

void LDAPEntry::addAttribute ( const LDAPAttribute attr)

Adds one Attribute to the List of Attributes (simple wrapper around LDAPAttributeList::addAttribute() ).

Parameters
attrThe attribute to add to the list.

◆ delAttribute()

void LDAPEntry::delAttribute ( const std::string &  type)

Deletes all values of an Attribute from the list of Attributes (simple wrapper around LDAPAttributeList::delAttribute() ).

Parameters
typeThe attribute to delete.

◆ getAttributeByName()

const LDAPAttribute * LDAPEntry::getAttributeByName ( const std::string &  name) const

Get an Attribute by its AttributeType (simple wrapper around LDAPAttributeList::getAttributeByName() )

Parameters
nameThe name of the Attribute to look for
Returns
a pointer to the LDAPAttribute with the AttributeType "name" or 0, if there is no Attribute of that Type

◆ getAttributes()

const LDAPAttributeList * LDAPEntry::getAttributes ( ) const
Returns
A const pointer to the attributes of the entry.

References DEBUG, and LDAP_DEBUG_TRACE.

Referenced by LDAPAddRequest::sendRequest(), and LdifWriter::writeRecord().

◆ getDN()

const string & LDAPEntry::getDN ( ) const
Returns
The current DN of the entry.

References DEBUG, and LDAP_DEBUG_TRACE.

Referenced by LDAPAddRequest::sendRequest(), and LdifWriter::writeRecord().

◆ operator=()

LDAPEntry & LDAPEntry::operator= ( const LDAPEntry from)

Assignment operator.

◆ replaceAttribute()

void LDAPEntry::replaceAttribute ( const LDAPAttribute attr)

Replace an Attribute in the List of Attributes (simple wrapper around LDAPAttributeList::replaceAttribute() ).

Parameters
attrThe attribute to add to the list.

◆ setAttributes()

void LDAPEntry::setAttributes ( LDAPAttributeList attrs)

Sets the attributes of the entry.

Parameters
attrA pointer to a std::list of the new attributes.

References DEBUG, LDAP_DEBUG_PARAMETER, and LDAP_DEBUG_TRACE.

Referenced by LdifReader::getEntryRecord().

◆ setDN()

void LDAPEntry::setDN ( const std::string &  dn)

Sets the DN-attribute.

Parameters
dnThe new DN for the entry.

References DEBUG, LDAP_DEBUG_PARAMETER, and LDAP_DEBUG_TRACE.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  s,
const LDAPEntry le 
)
friend

This method can be used to dump the data of a LDAPResult-Object.

It is only useful for debugging purposes at the moment


The documentation for this class was generated from the following files: