anna::ldap::ResultCode Class Reference

#include <ResultCode.hpp>

Public Member Functions
	ResultCode ()
bool	isOk () const
bool	isInvalidCredential () const
bool	isOperationsError () const
bool	isProtocolError () const
bool	isTimeLimitExceeded () const
bool	isSizeLimitExceeded () const
bool	isAuthMethodNotSupported () const
bool	isStrongAuthRequired () const
bool	isSASLBindInProgress () const
bool	isAttrError () const
bool	isNameError () const
bool	isSecurityError () const
bool	isServiceError () const
bool	isTimeout () const
bool	isUnavailable () const
bool	isServerDown () const
bool	isLocalError () const
bool	isDecodingError () const
bool	isFilterError () const
bool	isConnectError () const
int	getValue () const
const std::string &	getText () const
void	clear ()
ResultCode &	operator= (const ResultCode &other)
ResultCode &	operator= (const int ldap_result)
bool	operator== (const int n) const
bool	operator!= (const int n) const
bool	operator< (const int n) const
bool	operator<= (const int n) const
const std::string	asString () const

Friends
class	Session

Detailed Description

Modela el resultado de las peticiones enviadas a servidores LDAP.

See also

ldap::Response

ldap::Session::eventResponse

Constructor & Destructor Documentation

ResultCode()

anna::ldap::ResultCode::ResultCode ( )

inline

Contructor.

: a_value(0) {;}

Member Function Documentation

asString()

const std::string anna::ldap::ResultCode::asString

(

)

const

Devuelve una cadena con la informacion relevante sobre esta instancia.

Returns

Una cadena con la informacion relevante sobre esta instancia.

clear()

void anna::ldap::ResultCode::clear ( void  )

inline

Establece el codigo de error asociado a esta instancia.

Parameters

value	Codigo de error Establece el texto explicativo del error asociado a esta instancia.
text	Texto explicativo del error Inicializa el codigo de error y el texto de esta instancia.

{ a_value = 0; a_text.clear(); }

getText()

const std::string& anna::ldap::ResultCode::getText ( ) const

inline

Devuelve el texto explicativo del error asociado a esta instancia.

Returns

El texto explicativo del error asociado a esta instancia.

{ return a_text; }

getValue()

int anna::ldap::ResultCode::getValue ( ) const

inline

Devuelve el codigo de error asociado a esta instancia.

Returns

El codigo de error asociado a esta instancia.

{ return a_value; }

isAttrError()

bool anna::ldap::ResultCode::isAttrError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_ATTR_ERROR o false en otro caso, Puede darse al usar atributos no definidos, tipos inapropiados, comparaciones entre tipos no convertibles o errores sintáxticos en general.

Returns

true si la resulta recibida es un error de tipo LDAP_ATTR_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isAuthMethodNotSupported()

bool anna::ldap::ResultCode::isAuthMethodNotSupported

(

)

const

Devuelve true si la resulta recibida es LDAP_AUTH_METHOD_NOT_SUPPORTED o false en otro caso.

Returns

true si la resulta recibida es LDAP_AUTH_METHOD_NOT_SUPPORTED o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isConnectError()

bool anna::ldap::ResultCode::isConnectError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_CONNECT_ERROR o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_CONNECT_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isDecodingError()

bool anna::ldap::ResultCode::isDecodingError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_DECODING_ERROR o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_DECODING_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isFilterError()

bool anna::ldap::ResultCode::isFilterError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_FILTER_ERROR o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_FILTER_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isInvalidCredential()

bool anna::ldap::ResultCode::isInvalidCredential

(

)

const

Devuelve true si la respuesta recibida es un error debido a que las credenciales del usuario no son válidas para conectar al servidor o false en otro caso.

Returns

true si la respuesta recibida es un error debido a que las credenciales del usuario no son válidas para conectar al servidor o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isLocalError()

bool anna::ldap::ResultCode::isLocalError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_LOCAL_ERROR o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_LOCAL_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isNameError()

bool anna::ldap::ResultCode::isNameError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_NAME_ERROR o false en otro caso. Puede dar al usar objetos o alias no definidos o usar una sinstaxis no válida en el DN.

Returns

true si la resulta recibida es un error de tipo LDAP_NAME_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isOk()

bool anna::ldap::ResultCode::isOk ( ) const

inline

Devuelve true si la respuesta recibida es correcta o false en otro caso.

Returns

true si la respuesta recibida es correcta o false en otro caso.

{ return a_value == 0; }

Here is the call graph for this function:

isOperationsError()

bool anna::ldap::ResultCode::isOperationsError

(

)

const

Devuelve true si la resulta recibida es LDAP_OPERATIONS_ERROR o false en otro caso.

Returns

true si la resulta recibida es LDAP_OPERATIONS_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isProtocolError()

bool anna::ldap::ResultCode::isProtocolError

(

)

const

Devuelve true si la resulta recibida es LDAP_PROTOCOL_ERROR o false en otro caso.

Returns

true si la resulta recibida es LDAP_PROTOCOL_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isSASLBindInProgress()

bool anna::ldap::ResultCode::isSASLBindInProgress

(

)

const

Devuelve true si la resulta recibida es LDAP_SASL_BIND_IN_PROGRESS o false en otro caso.

Returns

true si la resulta recibida es LDAP_SASL_BIND_IN_PROGRESS o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isSecurityError()

bool anna::ldap::ResultCode::isSecurityError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_SECURITY_ERROR o false en otro caso. Puede darse por una autorización inapropiada, por presentar una credencial inválida o por intentar acceder a información sin los privilegios suficientes.

Incluye el valor del método isInvalidCredential.

Returns

true si la resulta recibida es un error de tipo LDAP_SECURITY_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isServerDown()

bool anna::ldap::ResultCode::isServerDown

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_SERVER_DOWN o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_SERVER_DOWN o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isServiceError()

bool anna::ldap::ResultCode::isServiceError

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_SERVICE_ERROR o false en otro caso. Puede darse cuando el servicio no esté disponible.

Returns

true si la resulta recibida es un error de tipo LDAP_SERVICE_ERROR o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isSizeLimitExceeded()

bool anna::ldap::ResultCode::isSizeLimitExceeded

(

)

const

Devuelve true si la resulta recibida es LDAP_SIZELIMIT_EXCEEDED o false en otro caso.

Returns

true si la resulta recibida es LDAP_SIZELIMIT_EXCEEDED o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isStrongAuthRequired()

bool anna::ldap::ResultCode::isStrongAuthRequired

(

)

const

Devuelve true si la resulta recibida es LDAP_STRONG_AUTH_REQUIRED o false en otro caso.

Returns

true si la resulta recibida es LDAP_STRONG_AUTH_REQUIRED o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isTimeLimitExceeded()

bool anna::ldap::ResultCode::isTimeLimitExceeded

(

)

const

Devuelve true si la resulta recibida es LDAP_TIMELIMIT_EXCEEDED o false en otro caso.

Returns

true si la resulta recibida es LDAP_TIMELIMIT_EXCEEDED o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isTimeout()

bool anna::ldap::ResultCode::isTimeout

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_TIMEOUT o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_TIMEOUT o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

isUnavailable()

bool anna::ldap::ResultCode::isUnavailable

(

)

const

Devuelve true si la resulta recibida es un error de tipo LDAP_UNAVAILABLE o false en otro caso.

Returns

true si la resulta recibida es un error de tipo LDAP_UNAVAILABLE o false en otro caso.

Warning

El valor retornado por este método sólo tendrá validez en caso de que el método isOk haya retornado false.

operator!=()

bool anna::ldap::ResultCode::operator!= ( const int  n ) const

inline

{ return a_value != n; }

operator<()

bool anna::ldap::ResultCode::operator< ( const int  n ) const

inline

{ return a_value < n; }

operator<=()

bool anna::ldap::ResultCode::operator<= ( const int  n ) const

inline

{ return a_value <= n; }

Here is the call graph for this function:

operator=() [1/2]

ResultCode& anna::ldap::ResultCode::operator= ( const ResultCode &  other )

inline

Operador copia.

Parameters

other

Instancia de la que copiar.

Returns

La instancia de el mismo despues de copiar los valores.

                                                  {
    a_value = other.a_value;
    a_text = other.a_text;
    return *this;
  }

operator=() [2/2]

ResultCode& anna::ldap::ResultCode::operator=

(

const int

ldap_result

)

Operador de asignación.

Parameters

ldap_result

Código de resultado con el que iniciar esta instancia.

Warning

Si el valor de ldap_result no fue obtenido como resultado de ejecutar alguna operacion LDAP el resultado de este método no está definido.

operator==()

bool anna::ldap::ResultCode::operator== ( const int  n ) const

inline

{ return a_value == n; }

Friends And Related Function Documentation

Session

friend class Session

friend

---

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

• /tmp/anna/include/anna/ldap/ResultCode.hpp