LDAPRequest Class Reference
For internal use only. More...
#include <LDAPRequest.h>
Public Member Functions | |
| LDAPRequest (const LDAPRequest &req) | |
| LDAPRequest (LDAPAsynConnection *conn, const LDAPConstraints *cons, bool isReferral=false, const LDAPRequest *parent=0) | |
| virtual | ~LDAPRequest () |
| const LDAPConstraints * | getConstraints () const |
| const LDAPAsynConnection * | getConnection () const |
| virtual LDAPMsg * | getNextMessage () const |
| int | getType () const |
| int | getMsgID () const |
| int | getHopCount () const |
| const LDAPRequest * | getParent () const |
| bool | isReferral () const |
| void | unbind () const |
| virtual LDAPMessageQueue * | sendRequest ()=0 |
| This method encodes the request an calls the apprpriate functions of the C-API to send the Request to a LDAP-Server. | |
| virtual LDAPRequest * | followReferral (LDAPMsg *ref) |
| virtual bool | equals (const LDAPRequest *req) const |
| Compare this request with another on. | |
| bool | isCycle () const |
Static Public Attributes | |
| static const int | BIND = 0 |
| static const int | UNBIND = 2 |
| static const int | SEARCH = 3 |
| static const int | MODIFY = 7 |
| static const int | ADD = 8 |
| static const int | DELETE = 10 |
| static const int | COMPARE = 14 |
Protected Member Functions | |
| LDAPRequest () | |
Protected Attributes | |
| bool | m_isReferral |
| int | m_requestType |
| LDAPConstraints * | m_cons |
| LDAPAsynConnection * | m_connection |
| const LDAPRequest * | m_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 | ) |
References DEBUG, LDAP_DEBUG_CONSTRUCT, m_connection, m_cons, m_hopCount, m_isReferral, m_msgID, and m_parent.
| LDAPRequest::LDAPRequest | ( | LDAPAsynConnection * | conn, | |
| const LDAPConstraints * | cons, | |||
| bool | isReferral = false, |
|||
| const LDAPRequest * | parent = 0 | |||
| ) |
References DEBUG, LDAPAsynConnection::getConstraints(), getHopCount(), LDAP_DEBUG_CONSTRUCT, m_connection, m_cons, m_hopCount, m_isReferral, and m_parent.
| LDAPRequest::~LDAPRequest | ( | ) | [virtual] |
References DEBUG, LDAP_DEBUG_DESTROY, and m_cons.
| LDAPRequest::LDAPRequest | ( | ) | [protected] |
References DEBUG, and LDAP_DEBUG_CONSTRUCT.
Member Function Documentation
| const LDAPConstraints * LDAPRequest::getConstraints | ( | ) | const |
References DEBUG, LDAP_DEBUG_TRACE, and m_cons.
Referenced by LDAPMessageQueue::chaseReferral(), and LDAPMessageQueue::getNext().
| const LDAPAsynConnection * LDAPRequest::getConnection | ( | ) | const |
References DEBUG, LDAP_DEBUG_TRACE, and m_connection.
Referenced by LDAPSearchRequest::followReferral(), LDAPModifyRequest::followReferral(), LDAPModDNRequest::followReferral(), LDAPExtRequest::followReferral(), LDAPDeleteRequest::followReferral(), LDAPCompareRequest::followReferral(), LDAPAddRequest::followReferral(), LDAPExtResult::LDAPExtResult(), LDAPResult::LDAPResult(), LDAPSaslBindResult::LDAPSaslBindResult(), LDAPSearchReference::LDAPSearchReference(), and LDAPSearchResult::LDAPSearchResult().
| LDAPMsg * LDAPRequest::getNextMessage | ( | ) | const [virtual] |
Reimplemented in LDAPSaslInteractiveBind.
References LDAPMsg::create(), DEBUG, LDAPAsynConnection::getSessionHandle(), LDAP_DEBUG_DESTROY, m_connection, and m_msgID.
Referenced by LDAPMessageQueue::getNext().
| int LDAPRequest::getType | ( | ) | const |
| int LDAPRequest::getMsgID | ( | ) | const |
| int LDAPRequest::getHopCount | ( | ) | const |
References DEBUG, LDAP_DEBUG_TRACE, and m_hopCount.
Referenced by LDAPMessageQueue::chaseReferral(), and LDAPRequest().
| const LDAPRequest * LDAPRequest::getParent | ( | ) | const |
- Returns:
- The LDAPRequest that has created this object. Or 0 if this object was not created by another request.
References DEBUG, LDAP_DEBUG_TRACE, and m_parent.
Referenced by isCycle().
| bool LDAPRequest::isReferral | ( | ) | const |
- Returns:
- true if this object was created during the automatic chasing of referrals. Otherwise false
References DEBUG, LDAP_DEBUG_TRACE, and m_isReferral.
Referenced by LDAPMessageQueue::getNext(), and LDAPSearchRequest::sendRequest().
| void LDAPRequest::unbind | ( | ) | const |
References DEBUG, LDAP_DEBUG_TRACE, m_connection, and LDAPAsynConnection::unbind().
Referenced by LDAPMessageQueue::getNext().
| 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, LDAPSaslBindRequest, LDAPSaslInteractiveBind, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.
Referenced by LDAPMessageQueue::chaseReferral().
| LDAPRequest * LDAPRequest::followReferral | ( | LDAPMsg * | ref | ) | [virtual] |
Reimplemented in LDAPAddRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.
References DEBUG, and LDAP_DEBUG_TRACE.
Referenced by LDAPMessageQueue::chaseReferral().
| 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.
References DEBUG, LDAPAsynConnection::getHost(), LDAPAsynConnection::getPort(), getType(), LDAP_DEBUG_TRACE, m_connection, and m_requestType.
Referenced by LDAPSearchRequest::equals(), and isCycle().
| bool LDAPRequest::isCycle | ( | ) | const |
References DEBUG, equals(), getParent(), LDAP_DEBUG_TRACE, and m_parent.
Referenced by LDAPMessageQueue::chaseReferral().
Member Data Documentation
const int LDAPRequest::BIND = 0 [static] |
const int LDAPRequest::UNBIND = 2 [static] |
const int LDAPRequest::SEARCH = 3 [static] |
const int LDAPRequest::MODIFY = 7 [static] |
const int LDAPRequest::ADD = 8 [static] |
Referenced by LDAPAddRequest::LDAPAddRequest().
const int LDAPRequest::DELETE = 10 [static] |
const int LDAPRequest::COMPARE = 14 [static] |
bool LDAPRequest::m_isReferral [protected] |
Referenced by isReferral(), and LDAPRequest().
int LDAPRequest::m_requestType [protected] |
Referenced by equals(), getType(), and LDAPAddRequest::LDAPAddRequest().
LDAPConstraints* LDAPRequest::m_cons [protected] |
Referenced by LDAPSearchRequest::followReferral(), LDAPModifyRequest::followReferral(), LDAPModDNRequest::followReferral(), LDAPExtRequest::followReferral(), LDAPDeleteRequest::followReferral(), LDAPCompareRequest::followReferral(), LDAPAddRequest::followReferral(), getConstraints(), LDAPRequest(), LDAPSearchRequest::sendRequest(), LDAPModifyRequest::sendRequest(), LDAPModDNRequest::sendRequest(), LDAPExtRequest::sendRequest(), LDAPDeleteRequest::sendRequest(), LDAPCompareRequest::sendRequest(), LDAPSaslInteractiveBind::sendRequest(), LDAPSaslBindRequest::sendRequest(), LDAPBindRequest::sendRequest(), LDAPAddRequest::sendRequest(), and ~LDAPRequest().
LDAPAsynConnection* LDAPRequest::m_connection [protected] |
Referenced by equals(), getConnection(), getNextMessage(), LDAPRequest(), LDAPSearchRequest::sendRequest(), LDAPModifyRequest::sendRequest(), LDAPModDNRequest::sendRequest(), LDAPExtRequest::sendRequest(), LDAPDeleteRequest::sendRequest(), LDAPCompareRequest::sendRequest(), LDAPSaslInteractiveBind::sendRequest(), LDAPSaslBindRequest::sendRequest(), LDAPBindRequest::sendRequest(), LDAPAddRequest::sendRequest(), and unbind().
const LDAPRequest* LDAPRequest::m_parent [protected] |
Referenced by getParent(), isCycle(), and LDAPRequest().
int LDAPRequest::m_hopCount [protected] |
Referenced by getHopCount(), and LDAPRequest().
int LDAPRequest::m_msgID [protected] |
Referenced by getMsgID(), getNextMessage(), LDAPRequest(), LDAPSearchRequest::sendRequest(), LDAPModifyRequest::sendRequest(), LDAPModDNRequest::sendRequest(), LDAPExtRequest::sendRequest(), LDAPDeleteRequest::sendRequest(), LDAPCompareRequest::sendRequest(), LDAPSaslBindRequest::sendRequest(), LDAPBindRequest::sendRequest(), and LDAPAddRequest::sendRequest().
The documentation for this class was generated from the following files:
