ldapsdk 0.0.1
|
This class represents any type of LDAP- Message returned from the server. More...
#include <LDAPMessage.h>
Public Member Functions | |
virtual | ~LDAPMsg () |
The destructor has no implemenation, because this is an abstract class. | |
int | getMessageType () |
int | getMsgID () |
bool | hasControls () const |
const LDAPControlSet & | getSrvControls () const |
Static Public Member Functions | |
static LDAPMsg * | create (const LDAPRequest *req, LDAPMessage *msg) |
This method is used by the library to parse the results returned by the C-API. | |
Static Public Attributes | |
static const int | BIND_RESPONSE = LDAP_RES_BIND |
static const int | SEARCH_ENTRY = LDAP_RES_SEARCH_ENTRY |
static const int | SEARCH_DONE = LDAP_RES_SEARCH_RESULT |
static const int | SEARCH_REFERENCE = LDAP_RES_SEARCH_REFERENCE |
static const int | MODIFY_RESPONSE = LDAP_RES_MODIFY |
static const int | ADD_RESPONSE = LDAP_RES_ADD |
static const int | DEL_RESPONSE = LDAP_RES_DELETE |
static const int | MODDN_RESPONSE = LDAP_RES_MODDN |
static const int | COMPARE_RESPONSE = LDAP_RES_COMPARE |
static const int | EXTENDED_RESPONSE = LDAP_RES_EXTENDED |
static const int | BIND_REQUEST = LDAP_REQ_BIND |
static const int | UNBIND_REQUEST = LDAP_REQ_UNBIND |
static const int | SEARCH_REQUEST = LDAP_REQ_SEARCH |
static const int | MODIFY_REQUEST = LDAP_REQ_MODIFY |
static const int | ADD_REQUEST = LDAP_REQ_ADD |
static const int | DELETE_REQUEST = LDAP_REQ_DELETE |
static const int | MODRDN_REQUEST = LDAP_REQ_MODRDN |
static const int | COMPARE_REQUEST = LDAP_REQ_COMPARE |
static const int | ABANDON_REQUEST = LDAP_REQ_ABANDON |
static const int | EXTENDED_REQUEST = LDAP_REQ_EXTENDED |
Protected Member Functions | |
LDAPMsg (LDAPMessage *msg) | |
This constructor make a copy of a LDAPMsg-pointer. | |
LDAPMsg (int msgType, int msgID) | |
Protected Attributes | |
LDAPControlSet | m_srvControls |
This attribute stores Server-Control that were returned with the message. | |
bool | m_hasControls |
This class represents any type of LDAP- Message returned from the server.
This class is never not instantiated directly. Only its subclasses are used. The main feature of this class is the static method create() (see below)
virtual LDAPMsg::~LDAPMsg | ( | ) | [inline, virtual] |
The destructor has no implemenation, because this is an abstract class.
LDAPMsg::LDAPMsg | ( | LDAPMessage * | msg | ) | [protected] |
This constructor make a copy of a LDAPMsg-pointer.
The object itself (no the pointer) is copied. Only for internal use.
References DEBUG, and LDAP_DEBUG_CONSTRUCT.
LDAPMsg::LDAPMsg | ( | int | msgType, |
int | msgID = 0 |
||
) | [protected] |
References DEBUG, and LDAP_DEBUG_CONSTRUCT.
LDAPMsg * LDAPMsg::create | ( | const LDAPRequest * | req, |
LDAPMessage * | msg | ||
) | [static] |
This method is used by the library to parse the results returned by the C-API.
Based on msgtype-Value of the *msg-Parameter this method creates an Object of one of the subtypes of LDAPMsg (e.g. LDAPSearchResult or LDAPResult) that represents the same Message as the *msg-Parameter. *msg is e.g. a Message returned by the C-API's ldap_result call.
req | The LDAPRequest-object this result message is associated with. |
msg | The LDAPMessage-structure from the C-API that contains the LDAP-message to parse. |
References DEBUG, and LDAP_DEBUG_TRACE.
Referenced by LDAPRequest::getNextMessage().
int LDAPMsg::getMessageType | ( | ) |
References DEBUG, and LDAP_DEBUG_TRACE.
Referenced by LDAPSearchRequest::followReferral(), LDAPMessageQueue::getNext(), and LDAPSearchResults::readMessageQueue().
int LDAPMsg::getMsgID | ( | ) |
References DEBUG, and LDAP_DEBUG_TRACE.
const LDAPControlSet & LDAPMsg::getSrvControls | ( | ) | const |
bool LDAPMsg::hasControls | ( | ) | const |
const int LDAPMsg::ABANDON_REQUEST = LDAP_REQ_ABANDON [static] |
const int LDAPMsg::ADD_REQUEST = LDAP_REQ_ADD [static] |
Referenced by LdifReader::readNextRecord().
const int LDAPMsg::ADD_RESPONSE = LDAP_RES_ADD [static] |
const int LDAPMsg::BIND_REQUEST = LDAP_REQ_BIND [static] |
const int LDAPMsg::BIND_RESPONSE = LDAP_RES_BIND [static] |
Referenced by LDAPSaslInteractiveBind::sendRequest().
const int LDAPMsg::COMPARE_REQUEST = LDAP_REQ_COMPARE [static] |
const int LDAPMsg::COMPARE_RESPONSE = LDAP_RES_COMPARE [static] |
const int LDAPMsg::DEL_RESPONSE = LDAP_RES_DELETE [static] |
const int LDAPMsg::DELETE_REQUEST = LDAP_REQ_DELETE [static] |
Referenced by LdifReader::readNextRecord().
const int LDAPMsg::EXTENDED_REQUEST = LDAP_REQ_EXTENDED [static] |
const int LDAPMsg::EXTENDED_RESPONSE = LDAP_RES_EXTENDED [static] |
bool LDAPMsg::m_hasControls [protected] |
LDAPControlSet LDAPMsg::m_srvControls [protected] |
This attribute stores Server-Control that were returned with the message.
Referenced by LDAPResult::LDAPResult(), LDAPSearchReference::LDAPSearchReference(), and LDAPSearchResult::LDAPSearchResult().
const int LDAPMsg::MODDN_RESPONSE = LDAP_RES_MODDN [static] |
const int LDAPMsg::MODIFY_REQUEST = LDAP_REQ_MODIFY [static] |
Referenced by LdifReader::readNextRecord().
const int LDAPMsg::MODIFY_RESPONSE = LDAP_RES_MODIFY [static] |
const int LDAPMsg::MODRDN_REQUEST = LDAP_REQ_MODRDN [static] |
Referenced by LdifReader::readNextRecord().
const int LDAPMsg::SEARCH_DONE = LDAP_RES_SEARCH_RESULT [static] |
Referenced by LDAPMessageQueue::getNext().
const int LDAPMsg::SEARCH_ENTRY = LDAP_RES_SEARCH_ENTRY [static] |
const int LDAPMsg::SEARCH_REFERENCE = LDAP_RES_SEARCH_REFERENCE [static] |
const int LDAPMsg::SEARCH_REQUEST = LDAP_REQ_SEARCH [static] |
const int LDAPMsg::UNBIND_REQUEST = LDAP_REQ_UNBIND [static] |