anna::ldap::Request Class Reference

#include <Request.hpp>

Inheritance diagram for anna::ldap::Request:

Classes
struct	OnExpiry

Public Member Functions
ClassCode::_v	getClassCode () const
OnExpiry::_v	getOnExpiry () const
void	setOnExpiry (const OnExpiry::_v onExpiry)
virtual std::string	asString () const
virtual xml::Node *	asXML (xml::Node *parent) const
virtual void	clear ()=0

Static Public Member Functions
static const char *	asCString (const std::string &value)
static const char *	asText (const std::string &value)

Protected Member Functions
	Request (const ClassCode::_v classCode, const OnExpiry::_v onExpiry)

Friends
class	Session

Detailed Description

Prototipo de las peticiones que podemos realizar a un servidor LDAP.

Constructor & Destructor Documentation

Request()

anna::ldap::Request::Request ( const ClassCode::_v  classCode, const OnExpiry::_v  onExpiry  )

inlineprotected

Constructor.

Parameters

classCode	Tipo de clase de esta peticion.
onExpiry	Indica la acción a realizar si el temporizador de esta transación expira.

: a_classCode(classCode), a_onExpiry(onExpiry) {;}

Member Function Documentation

asCString()

static const char* anna::ldap::Request::asCString ( const std::string &  value )

inlinestatic

Devuelve NULL si la std::string recibida como parametro esta vacia o el contenido de la misma en otro caso.

Returns

NULL si la std::string recibida como parametro esta vacia o el contenido de la misma en otro caso.

Warning

Uso interno.

                                                       {
    return (value.empty() == true) ? NULL : value.c_str();
  }

asString()

virtual std::string anna::ldap::Request::asString ( ) const

virtual

Devuelve una cadena con la informacion mas relevante de esta instancia.

Returns

Una cadena con la informacion mas relevante de esta instancia.

Reimplemented in anna::ldap::Search.

asText()

static const char* anna::ldap::Request::asText ( const std::string &  value )

inlinestatic

Devuelve "<null>" si la std::string recibida como parametro esta vacia o el contenido de la misma en otro caso.

Returns

"<null>" si la std::string recibida como parametro esta vacia o el contenido de la misma en otro caso.

                                                    {
    return (value.empty() == true) ? "<null>" : value.c_str();
  }

asXML()

virtual xml::Node* anna::ldap::Request::asXML ( xml::Node *  parent ) const

virtual

Devuelve un documento XML con la informacion mas relevante de esta instancia.

Parameters

parent

Nodo XML del que colgar la informacion referente a esta instancia.

Returns

Un documento XML con la informacion mas relevante de esta instancia.

Reimplemented in anna::ldap::Search.

clear()

virtual void anna::ldap::Request::clear ( )

pure virtual

Inicializa los parametros de esta peticion.

Implemented in anna::ldap::Search.

getClassCode()

ClassCode::_v anna::ldap::Request::getClassCode ( ) const

inline

Devuelve el tipo de la clase de esta peticion indicada en el contructor.

Returns

El tipo de la clase de esta peticion indicada en el contructor.

{ return a_classCode; }

getOnExpiry()

OnExpiry::_v anna::ldap::Request::getOnExpiry ( ) const

inline

Devuelve la acción a realizar en caso de que el temporizador asociado a esta petición expire.

Returns

la acción a realizar en caso de que el temporizador asociado a esta petición expire.

{ return a_onExpiry; }

setOnExpiry()

void anna::ldap::Request::setOnExpiry ( const OnExpiry::_v  onExpiry )

inline

Establece la acción a realizar en caso de que el temporizador asociado a esta petición expire.

Parameters

onExpiry

Indica la acción a realizar en caso de que el temporizador asociado a esta petición expire.

Warning

Establecer el valor OnExpiry::Ignore podría causar pérdida de memoria y uso innecesario de recursos.

{ a_onExpiry = onExpiry; }

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/Request.hpp