Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

LDAPRequest Class Reference

For internal use only. More...

#include <LDAPRequest.h>

Inheritance diagram for LDAPRequest:

LDAPAddRequest LDAPBindRequest LDAPCompareRequest LDAPDeleteRequest LDAPExtRequest LDAPModDNRequest LDAPModifyRequest LDAPSearchRequest List of all members.

Public Member Functions

 LDAPRequest (const LDAPRequest &req)
 LDAPRequest (LDAPAsynConnection *conn, const LDAPConstraints *cons, bool isReferral=false, const LDAPRequest *parent=0)
virtual ~LDAPRequest ()
const LDAPConstraintsgetConstraints () const
const LDAPAsynConnectiongetConnection () const
int getType () const
int getMsgID () const
int getHopCount () const
const LDAPRequestgetParent () const
bool isReferral () const
void unbind () const
virtual LDAPMessageQueuesendRequest ()=0
 This method encodes the request an calls the apprpriate functions of the C-API to send the Request to a LDAP-Server.
virtual LDAPRequestfollowReferral (LDAPMsg *ref)=0
virtual bool equals (const LDAPRequest *req) const
 Compare this request with another on.
bool isCycle () const

Static Public Attributes

const int BIND = 0
const int UNBIND = 2
const int SEARCH = 3
const int MODIFY = 7
const int ADD = 8
const int DELETE = 10
const int COMPARE = 14

Protected Member Functions

 LDAPRequest ()

Protected Attributes

bool m_isReferral
int m_requestType
LDAPConstraintsm_cons
LDAPAsynConnectionm_connection
const LDAPRequestm_parent
int m_hopCount
int m_msgID

Detailed Description

For internal use only.

Each request that is sent to a LDAP-server by this library is represented by a special object that contains the parameters and some other info of the request. This virtual class is the common base classe for these specialized request classes.


Constructor & Destructor Documentation

LDAPRequest::LDAPRequest const LDAPRequest req  ) 
 

LDAPRequest::LDAPRequest LDAPAsynConnection conn,
const LDAPConstraints cons,
bool  isReferral = false,
const LDAPRequest parent = 0
 

LDAPRequest::~LDAPRequest  )  [virtual]
 

LDAPRequest::LDAPRequest  )  [protected]
 


Member Function Documentation

bool LDAPRequest::equals const LDAPRequest req  )  const [virtual]
 

Compare this request with another on.

And returns true if they have the same parameters.

Reimplemented in LDAPSearchRequest.

virtual LDAPRequest* LDAPRequest::followReferral LDAPMsg ref  )  [pure virtual]
 

Implemented in LDAPAddRequest, LDAPBindRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.

const LDAPAsynConnection * LDAPRequest::getConnection  )  const
 

const LDAPConstraints * LDAPRequest::getConstraints  )  const
 

int LDAPRequest::getHopCount  )  const
 

int LDAPRequest::getMsgID  )  const
 

const LDAPRequest * LDAPRequest::getParent  )  const
 

Returns:
The LDAPRequest that has created this object. Or 0 if this object was not created by another request.

int LDAPRequest::getType  )  const
 

bool LDAPRequest::isCycle  )  const
 

bool LDAPRequest::isReferral  )  const
 

Returns:
true if this object was created during the automatic chasing of referrals. Otherwise false

virtual LDAPMessageQueue* LDAPRequest::sendRequest  )  [pure virtual]
 

This method encodes the request an calls the apprpriate functions of the C-API to send the Request to a LDAP-Server.

Implemented in LDAPAddRequest, LDAPBindRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.

void LDAPRequest::unbind  )  const
 


Member Data Documentation

const int LDAPRequest::ADD = 8 [static]
 

const int LDAPRequest::BIND = 0 [static]
 

const int LDAPRequest::COMPARE = 14 [static]
 

const int LDAPRequest::DELETE = 10 [static]
 

LDAPAsynConnection* LDAPRequest::m_connection [protected]
 

LDAPConstraints* LDAPRequest::m_cons [protected]
 

int LDAPRequest::m_hopCount [protected]
 

bool LDAPRequest::m_isReferral [protected]
 

int LDAPRequest::m_msgID [protected]
 

const LDAPRequest* LDAPRequest::m_parent [protected]
 

int LDAPRequest::m_requestType [protected]
 

const int LDAPRequest::MODIFY = 7 [static]
 

const int LDAPRequest::SEARCH = 3 [static]
 

const int LDAPRequest::UNBIND = 2 [static]
 


The documentation for this class was generated from the following files:
Generated on Wed Nov 12 02:19:04 2008 for ldapsdk by  doxygen 1.3.9.1