Back to index

openldap  2.4.31
Public Member Functions | Private Attributes | Friends
LDAPReferralException Class Reference

This class extends LDAPException and is used to signalize Referrals there were received during synchronous LDAP-operations. More...

#include <LDAPException.h>

Inheritance diagram for LDAPReferralException:
Inheritance graph
[legend]
Collaboration diagram for LDAPReferralException:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LDAPReferralException (const LDAPUrlList &urls) throw ()
 Creates an object that is initialized with a list of URLs.
 ~LDAPReferralException () throw ()
 Destructor.
const LDAPUrlListgetUrls () throw ()
int getResultCode () const throw ()
const std::string & getResultMsg () const throw ()
const std::string & getServerMsg () const throw ()
virtual const char * what () const throw ()

Private Attributes

LDAPUrlList m_urlList

Friends

std::ostream & operator<< (std::ostream &s, LDAPException e) throw ()
 This method can be used to dump the data of a LDAPResult-Object.

Detailed Description

This class extends LDAPException and is used to signalize Referrals there were received during synchronous LDAP-operations.

Definition at line 84 of file LDAPException.h.


Constructor & Destructor Documentation

Creates an object that is initialized with a list of URLs.

Definition at line 83 of file LDAPException.cpp.

Destructor.

Definition at line 88 of file LDAPException.cpp.

{
}

Member Function Documentation

int LDAPException::getResultCode ( ) const throw () [inherited]
Returns:
The Result code of the object

Definition at line 53 of file LDAPException.cpp.

{
       return m_res_code;
}
const string & LDAPException::getResultMsg ( ) const throw () [inherited]
Returns:
The error message that is corresponding to the result code .

Definition at line 58 of file LDAPException.cpp.

{
       return m_res_string;
}
const string & LDAPException::getServerMsg ( ) const throw () [inherited]
Returns:
The addional error message of the error (if it was set)

Definition at line 63 of file LDAPException.cpp.

{
    return m_err_string;
}
Returns:
The List of URLs of the Referral/Search Reference

Definition at line 92 of file LDAPException.cpp.

{
    return m_urlList;
}
const char * LDAPException::what ( ) const throw () [virtual, inherited]

Definition at line 68 of file LDAPException.cpp.

{
    return this->m_res_string.c_str(); 
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s,
LDAPException  e 
) throw () [friend, inherited]

This method can be used to dump the data of a LDAPResult-Object.

It is only useful for debugging purposes at the moment

Definition at line 73 of file LDAPException.cpp.

{
       s << "Error " << e.m_res_code << ": " << e.m_res_string;
       if (!e.m_err_string.empty()) {
              s << endl <<  "additional info: " << e.m_err_string ;
       }
       return s;
}

Member Data Documentation

Definition at line 104 of file LDAPException.h.


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