ANNA Suite  2020b
Multipurpose development suite for Telco applications
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
anna::ldap::Response Class Reference

#include <Response.hpp>

Public Types

typedef Recycler< Attributeattribute_container
 
typedef attribute_container::iterator attribute_iterator
 
typedef attribute_container::const_iterator const_attribute_iterator
 
typedef Recycler< std::string > referral_container
 
typedef referral_container::const_iterator const_referral_iterator
 

Public Member Functions

ClassCode::_v getClassCode () const
 
IdMessage getIdMessage () const
 
const SessiongetSession () const
 
const ResultCodegetResultCode () const
 
const std::string & getName () const
 
const RequestgetRequest () const
 
SessiongetSession ()
 
int attribute_size () const
 
const_attribute_iterator attribute_begin () const
 
const_attribute_iterator attribute_end () const
 
int referral_size () const
 
const_referral_iterator referral_begin () const
 
const_referral_iterator referral_end () const
 
std::string asString () const
 

Static Public Member Functions

static const Attributeattribute (const_attribute_iterator ii)
 
static const std::string & referral (const_referral_iterator ii)
 

Friends

class Session
 
class Allocator< Response >
 

Detailed Description

Modela las respuesta que podemos recibir de un servidor LDAP.

La respuesta correspondiente a una peticion se genera automaticamente al invocar a ldap::Session::send. El nucleo de ANNA.ldap notifica el resultado de la operacion solicitada mediante la invocacion al metodo-menejador ldap::Session::eventResponse de nuestra sesion.

Member Typedef Documentation

◆ attribute_container

◆ attribute_iterator

◆ const_attribute_iterator

◆ const_referral_iterator

◆ referral_container

Member Function Documentation

◆ asString()

std::string anna::ldap::Response::asString ( ) const

Devuelve una cadena con la informacion relevante sobre esta instancia.

Returns
Una cadena con la informacion relevante sobre esta instancia.

◆ attribute()

static const Attribute* anna::ldap::Response::attribute ( const_attribute_iterator  ii)
inlinestatic

Devuelve el atributo asociado al iterador recibido como parametro.

Parameters
iiInstancia del iterador usado para recorrer los datos. Estara comprendido entre [attribute_begin, attribute_end).
Returns
El atributo referenciado por el iterador.
131 { return attribute_container::data(ii); }
static Attribute * data(iterator ii)
Definition: Recycler.hpp:233
Here is the call graph for this function:

◆ attribute_begin()

const_attribute_iterator anna::ldap::Response::attribute_begin ( ) const
inline

Devuelve el iterador al comienzo de la lista de atributos asociados a esta respuesta.

Returns
El iterador al comienzo de la lista de atributos asociados a esta respuesta.
99 { return a_attributes.begin(); }
iterator begin()
Definition: Recycler.hpp:209
Here is the call graph for this function:

◆ attribute_end()

const_attribute_iterator anna::ldap::Response::attribute_end ( ) const
inline

Devuelve el iterador al final de la lista de atributos asociados a esta respuesta.

Returns
El iterador al final de la lista de atributos asociados a esta respuesta.
105 { return a_attributes.end(); }
iterator end()
Definition: Recycler.hpp:221
Here is the call graph for this function:

◆ attribute_size()

int anna::ldap::Response::attribute_size ( ) const
inline

Devuelve el nº de atributos que contiene la respuesta.

Returns
el nº de atributos que contiene la respuesta.
93 { return a_attributes.size(); }
int size() const
Definition: Recycler.hpp:77
Here is the call graph for this function:

◆ getClassCode()

ClassCode::_v anna::ldap::Response::getClassCode ( ) const
inline

Devuelve el tipo de la clase de esta respuesta.

Returns
El tipo de la clase de esta respuesta.
48 { return a_classCode; }

◆ getIdMessage()

IdMessage anna::ldap::Response::getIdMessage ( ) const
inline

Devuelve la identificacion del mensaje LDAP. Esta identificacion sera generada automaticamente al enviar la peticion.

Returns
Identificacion del mensaje asociado a esta peticion/respuesta.
See also
ldap::Session::send
56 { return a_idMessage; }

◆ getName()

const std::string& anna::ldap::Response::getName ( void  ) const
inline

Devuelve el nombre del DN asociado a esta peticion.

Returns
El nombre del DN asociado a esta peticion.
74 { return a_name; }

◆ getRequest()

const Request* anna::ldap::Response::getRequest ( ) const
inline

Devuelve la peticion que origino la creacion de esta respuesta.

Returns
La peticion que origino la creacion de esta respuesta.
See also
ldap::Session::send
81 { return a_request; }

◆ getResultCode()

const ResultCode& anna::ldap::Response::getResultCode ( ) const
inline

Devuelve el resultado de la peticion LDAP solicitada.

Returns
El resultado de la peticion LDAP solicitada.
68 { return a_resultCode; }

◆ getSession() [1/2]

const Session* anna::ldap::Response::getSession ( ) const
inline

Devuelve la sesion que genera esta respuesta.

Returns
La instancia de la sesion que genera esta respuesta.
62 { return a_session; }

◆ getSession() [2/2]

Session* anna::ldap::Response::getSession ( )
inline

Devuelve la sesion que origino la creacion de esta respuesta.

Returns
La sesion que origino la creacion de esta respuesta.
87 { return a_session; }

◆ referral()

static const std::string& anna::ldap::Response::referral ( const_referral_iterator  ii)
inlinestatic

Devuelve la referencia asociada al iterador recibido como parametro.

Parameters
iiInstancia del iterador usado para recorrer los datos. Estara comprendido entre [referral_begin, referral_end).
Returns
La referencia apuntada por el iterador.
139 { return *referral_container::data(ii); }
static std::string * data(iterator ii)
Definition: Recycler.hpp:233
Here is the call graph for this function:

◆ referral_begin()

const_referral_iterator anna::ldap::Response::referral_begin ( ) const
inline

Devuelve el iterador al comienzo de la lista de referencias asociados a esta respuesta.

Returns
El iterador al comienzo de la lista de referencias asociados a esta respuesta.
117 { return a_referrals.begin(); }
iterator begin()
Definition: Recycler.hpp:209
Here is the call graph for this function:

◆ referral_end()

const_referral_iterator anna::ldap::Response::referral_end ( ) const
inline

Devuelve el iterador al final de la lista de referencias asociados a esta respuesta.

Returns
El iterador al final de la lista de referencias asociados a esta respuesta.
123 { return a_referrals.end(); }
iterator end()
Definition: Recycler.hpp:221
Here is the call graph for this function:

◆ referral_size()

int anna::ldap::Response::referral_size ( ) const
inline

Devuelve el nº de referencias que contiene la respuesta.

Returns
el nº de referencias que contiene la respuesta.
111 { return a_referrals.size(); }
int size() const
Definition: Recycler.hpp:77
Here is the call graph for this function:

Friends And Related Function Documentation

◆ Allocator< Response >

friend class Allocator< Response >
friend

◆ Session

friend class Session
friend

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