openldap/contrib/ldapc++/src/LDAPRequest.h
Josh Soref 10566c8be3 ITS#8605 - spelling fixes
* javascript
* kernel
* ldap
* length
* macros
* maintained
* manager
* matching
* maximum
* mechanism
* memory
* method
* mimic
* minimum
* modifiable
* modifiers
* modifying
* multiple
* necessary
* normalized
* objectclass
* occurrence
* occurring
* offered
* operation
* original
* overridden
* parameter
* permanent
* preemptively
* printable
* protocol
* provider
* really
* redistribution
* referenced
* refresh
* regardless
* registered
* request
* reserved
* resource
* response
* sanity
* separated
* setconcurrency
* should
* specially
* specifies
* structure
* structures
* subordinates
* substitution
* succeed
* successful
* successfully
* sudoers
* sufficient
* superiors
* supported
* synchronization
* terminated
* they're
* through
* traffic
* transparent
* unsigned
* unsupported
* version
* absence
* achieves
* adamson
* additional
* address
* against
* appropriate
* architecture
* associated
* async
* attribute
* authentication
* authorized
* auxiliary
* available
* begin
* beginning
* buffered
* canonical
* certificate
* charray
* check
* class
* compatibility
* compilation
* component
* configurable
* configuration
* configure
* conjunction
* constraints
* constructor
* contained
* containing
* continued
* control
* convenience
* correspond
* credentials
* cyrillic
* database
* definitions
* deloldrdn
* dereferencing
* destroy
* distinguish
* documentation
* emmanuel
* enabled
* entry
* enumerated
* everything
* exhaustive
* existence
* existing
* explicitly
* extract
* fallthru
* fashion
* february
* finally
* function
* generically
* groupname
* happened
* implementation
* including
* initialization
* initializes
* insensitive
* instantiated
* instantiation
* integral
* internal
* iterate
2017-10-11 14:39:38 -07:00

89 lines
2.5 KiB
C++

// $OpenLDAP$
/*
* Copyright 2000-2017 The OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#ifndef LDAP_REQUEST_H
#define LDAP_REQUEST_H
#include <LDAPConstraints.h>
#include <LDAPAsynConnection.h>
#include <LDAPMessageQueue.h>
class LDAPUrl;
/**
* 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 class
* for these specialized request classes.
*/
class LDAPRequest{
public :
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;
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;
/**
* @return The LDAPRequest that has created this object. Or 0 if
* this object was not created by another request.
*/
const LDAPRequest* getParent() const;
/**
* @return true if this object was created during the automatic
* chasing of referrals. Otherwise false
*/
bool isReferral() const;
void unbind() const;
/**
* This method encodes the request an calls the apprpriate
* functions of the C-API to send the Request to a LDAP-Server
*/
virtual LDAPMessageQueue* sendRequest()=0;
virtual LDAPRequest* followReferral(LDAPMsg* ref);
/**
* Compare this request with another on. And returns true if they
* have the same parameters.
*/
virtual bool equals(const LDAPRequest* req) const;
bool isCycle() const;
protected :
bool m_isReferral;
int m_requestType;
LDAPConstraints *m_cons;
LDAPAsynConnection *m_connection;
const LDAPRequest* m_parent;
int m_hopCount;
int m_msgID; //the associated C-API Message ID
LDAPRequest();
};
#endif //LDAP_REQUEST_H