LDAPEntry Class Reference

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

#include <LDAPEntry.h>

List of all members.

Public Member Functions
	LDAPEntry (const LDAPEntry &entry)
	Copy-constructor.
	LDAPEntry (const std::string &dn=std::string(), const LDAPAttributeList *attrs=new LDAPAttributeList())
	Constructs a new entry (also used as standard constructor).
	LDAPEntry (const LDAPAsynConnection *ld, LDAPMessage *msg)
	Used internally only.
	~LDAPEntry ()
	Destructor.
void	setDN (const std::string &dn)
	Sets the DN-attribute.
void	setAttributes (LDAPAttributeList *attrs)
	Sets the attributes of the entry.
const LDAPAttribute *	getAttributeByName (const std::string &name) const
	Get an Attribute by its AttributeType (simple wrapper around LDAPAttributeList::getAttributeByName() ).
void	addAttribute (const LDAPAttribute &attr)
	Adds one Attribute to the List of Attributes (simple wrapper around LDAPAttributeList::addAttribute() ).
void	replaceAttribute (const LDAPAttribute &attr)
	Replace an Attribute in the List of Attributes (simple wrapper around LDAPAttributeList::replaceAttribute() ).
const std::string &	getDN () const
const LDAPAttributeList *	getAttributes () const
Private Attributes
LDAPAttributeList *	m_attrs
std::string	m_dn
Friends
std::ostream &	operator<< (std::ostream &s, const LDAPEntry &le)
	This method can be used to dump the data of a LDAPResult-Object.

---

Detailed Description

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

---

Constructor & Destructor Documentation

LDAPEntry::LDAPEntry

(

const LDAPEntry &

entry

)

Copy-constructor.

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

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

Parameters:

	dn	The Distinguished Name for the new entry.
	attrs	The attributes for the new entry.

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.

LDAPEntry::~LDAPEntry

(

)

Destructor.

---

Member Function Documentation

void LDAPEntry::setDN

(

const std::string &

dn

)

Sets the DN-attribute.

Parameters:

dn,:

The new DN for the entry.

void LDAPEntry::setAttributes

(

LDAPAttributeList *

attrs

)

Sets the attributes of the entry.

Parameters:

attr,:

A pointer to a std::list of the new attributes.

const LDAPAttribute * LDAPEntry::getAttributeByName

(

const std::string &

name

)

const

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

Parameters:

name

The 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

void LDAPEntry::addAttribute

(

const LDAPAttribute &

attr

)

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

Parameters:

attr

The attribute to add to the list.

void LDAPEntry::replaceAttribute

(

const LDAPAttribute &

attr

)

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

Parameters:

attr

The attribute to add to the list.

const string & LDAPEntry::getDN

(

)

const

Returns:

The current DN of the entry.

const LDAPAttributeList * LDAPEntry::getAttributes

(

)

const

Returns:

A const pointer to the attributes of the entry.

---

Friends And Related Function Documentation

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

---

Member Data Documentation

LDAPAttributeList* LDAPEntry::m_attrs [private]

std::string LDAPEntry::m_dn [private]

---

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

• LDAPEntry.h
• LDAPEntry.cpp