Back to index

openldap  2.4.31
Public Member Functions | Static Public Attributes | Private Attributes
LDAPConstraints Class Reference

This class represents some options that can be set for a LDAPConnection operation. More...

#include <LDAPConstraints.h>

Collaboration diagram for LDAPConstraints:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LDAPConstraints ()
 LDAPConstraints (const LDAPConstraints &c)
 ~LDAPConstraints ()
void setAliasDeref (int deref)
void setMaxTime (int t)
void setSizeLimit (int s)
void setReferralChase (bool rc)
void setHopLimit (int hop)
void setReferralRebind (const LDAPRebind *rebind)
void setServerControls (const LDAPControlSet *ctrls)
void setClientControls (const LDAPControlSet *ctrls)
int getAliasDeref () const
int getMaxTime () const
int getSizeLimit () const
const LDAPRebindgetReferralRebind () const
const LDAPControlSetgetServerControls () const
const LDAPControlSetgetClientControls () const
LDAPControl ** getSrvCtrlsArray () const
LDAPControl ** getClCtrlsArray () const
timeval * getTimeoutStruct () const
bool getReferralChase () const
int getHopLimit () const

Static Public Attributes

static const int DEREF_NEVER = 0x00
static const int DEREF_SEARCHING = 0x01
static const int DEREF_FINDING = 0x02
static const int DEREF_ALWAYS = 0x04

Private Attributes

int m_aliasDeref
int m_maxTime
int m_maxSize
bool m_referralChase
int m_HopLimit
int m_deref
const LDAPRebindm_refRebind
LDAPControlSetm_clientControls
LDAPControlSetm_serverControls

Detailed Description

This class represents some options that can be set for a LDAPConnection operation.

Namely these are time and size limits. Options for referral chasing and a default set of client of server controls to be used with every request

Definition at line 27 of file LDAPConstraints.h.


Constructor & Destructor Documentation

Definition at line 49 of file LDAPConstraints.cpp.

                                 {
    DEBUG(LDAP_DEBUG_DESTROY,"LDAPConstraints::~LDAPConstraints()" << endl);
    delete m_clientControls;
    delete m_serverControls;
}

Member Function Documentation

Definition at line 109 of file LDAPConstraints.cpp.

                                         {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getAliasDeref()" << endl);
    return m_aliasDeref;
}

Here is the caller graph for this function:

Definition at line 148 of file LDAPConstraints.cpp.

                                                     {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPContstraints::getClCtrlsArray()" << endl);
    if(m_clientControls){
        return m_clientControls->toLDAPControlArray(); 
    }else{
        return 0;
    }
}

Here is the caller graph for this function:

Definition at line 134 of file LDAPConstraints.cpp.

                                                              {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getClientControls()" << endl);
    return m_clientControls;
}

Definition at line 174 of file LDAPConstraints.cpp.

                                      {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPContstraints::getHopLimit()" << endl);
    return m_HopLimit;
}

Here is the caller graph for this function:

Definition at line 114 of file LDAPConstraints.cpp.

                                      {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getMaxTime()" << endl);
       return m_maxTime;
}

Definition at line 169 of file LDAPConstraints.cpp.

                                             {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPContstraints::getReferralChase()" << endl);
       return m_referralChase;
}

Here is the caller graph for this function:

Definition at line 124 of file LDAPConstraints.cpp.

                                                          {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getReferralRebind()" << endl);
    return m_refRebind;
}

Here is the caller graph for this function:

Definition at line 129 of file LDAPConstraints.cpp.

                                                              {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getServerControls()" << endl);
    return m_serverControls;
}

Definition at line 119 of file LDAPConstraints.cpp.

                                        {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::getSizeLimit()" << endl);
       return m_maxSize;
}

Here is the caller graph for this function:

Definition at line 139 of file LDAPConstraints.cpp.

                                                      {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPContstraints::getSrvCtrlsArray()" << endl);
    if(m_serverControls){
        return m_serverControls->toLDAPControlArray();
    }else{
        return 0;
    }
}

Here is the caller graph for this function:

timeval * LDAPConstraints::getTimeoutStruct ( ) const

Definition at line 157 of file LDAPConstraints.cpp.

                                                 {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPContstraints::getTimeoutStruct()" << endl);
    if(m_maxTime == LDAP_NO_LIMIT){
        return 0;
    }else{
        timeval *ret = new timeval;
        ret->tv_sec=m_maxTime;
        ret->tv_usec=0;
        return ret;
    }
}

Here is the caller graph for this function:

Definition at line 104 of file LDAPConstraints.cpp.

                                                                  {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setClientControls()" << endl);
    m_clientControls=new LDAPControlSet(*ctrls);
}

Definition at line 87 of file LDAPConstraints.cpp.

                                          {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setHopLimit()" << endl);
    DEBUG(LDAP_DEBUG_TRACE | LDAP_DEBUG_PARAMETER,
            "   limit:" << limit << endl);
    m_HopLimit=limit;
}

Definition at line 69 of file LDAPConstraints.cpp.

                                     {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setMaxTime()" << endl);
    DEBUG(LDAP_DEBUG_TRACE | LDAP_DEBUG_PARAMETER,"   time:" << t << endl);
    m_maxTime=t;
}

Definition at line 81 of file LDAPConstraints.cpp.

                                             {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setReferralChase()" << endl);
    DEBUG(LDAP_DEBUG_TRACE | LDAP_DEBUG_PARAMETER,"   rc:" << rc << endl);
    m_referralChase=rc;
}

Definition at line 94 of file LDAPConstraints.cpp.

                                                               {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setReferralRebind()" << endl);
    m_refRebind = rebind;
}

Definition at line 99 of file LDAPConstraints.cpp.

                                                                  {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setServerControls()" << endl);
    m_serverControls=new LDAPControlSet(*ctrls);
}

Here is the caller graph for this function:

Definition at line 75 of file LDAPConstraints.cpp.

                                       {
    DEBUG(LDAP_DEBUG_TRACE,"LDAPConstraints::setSizeLimit()" << endl);
    DEBUG(LDAP_DEBUG_TRACE | LDAP_DEBUG_PARAMETER,"   size:" << s << endl);
       m_maxSize=s;
}

Member Data Documentation

Definition at line 33 of file LDAPConstraints.h.

Definition at line 32 of file LDAPConstraints.h.

Definition at line 30 of file LDAPConstraints.h.

Definition at line 31 of file LDAPConstraints.h.

Definition at line 71 of file LDAPConstraints.h.

Definition at line 92 of file LDAPConstraints.h.

Definition at line 86 of file LDAPConstraints.h.

Definition at line 83 of file LDAPConstraints.h.

Definition at line 77 of file LDAPConstraints.h.

Definition at line 74 of file LDAPConstraints.h.

Definition at line 80 of file LDAPConstraints.h.

Definition at line 89 of file LDAPConstraints.h.

Definition at line 95 of file LDAPConstraints.h.


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