#include <Engine.hpp>

Inheritance diagram for anna::ldap::Engine:

[legend]

Collaboration diagram for anna::ldap::Engine:

[legend]

Classes
struct	DebugLevel

Public Member Functions
bool	getAutoBind () const

void	setAutoBind (const bool autoBind)

Session *	createSession (const char url, const char user, const char *password, const int category=0) noexcept(false)

Session *	createSession (const char url, const int id, const char user, const char *password, const int category=0) noexcept(false)

Session *	createSession (const char *url, const int category=0) noexcept(false)

Session *	findSession (const char url, const char user, Exception::Mode::_v emode=Exception::Mode::Throw) noexcept(false)

Session *	findSession (const char *url, const int id, Exception::Mode::_v emode=Exception::Mode::Throw) noexcept(false)

Session *	findSession (const char *url, Exception::Mode::_v emode=Exception::Mode::Throw) noexcept(false)

void	closeSession (Session *session) noexcept(false)

virtual xml::Node *	asXML (xml::Node *parent) const

Public Member Functions inherited from anna::app::Component
virtual	~Component ()

void	attach () noexcept(false)

virtual std::string	asString () const

Public Member Functions inherited from anna::Component
const char *	getClassName () const

Public Member Functions inherited from anna::Mutex
	Mutex (const Mode::_v mode=Mode::Recursive)

virtual	~Mutex ()

virtual void	lock () noexcept(false)

virtual void	unlock ()

bool	trylock () noexcept(false)

	operator const pthread_mutex_t * () const

Static Public Member Functions
static const char *	getClassName ()

static int	setDebugLevel (const int level) noexcept(false)

Protected Member Functions
	Engine ()

virtual Session *	allocateSession (const int category)=0

virtual void	releaseSession (Session *)=0

Protected Member Functions inherited from anna::app::Component
	Component (const char *className)

State::_v	getState () const

void	addPredecessor (const char *componentName)

void	initialize () noexcept(false)

void	stop ()

virtual void	kill ()

Protected Member Functions inherited from anna::Component
	Component (const char *className)

	Component (const Component &other)

Protected Member Functions inherited from anna::Safe
	Safe ()

Additional Inherited Members
Protected Attributes inherited from anna::Component
const std::string	a_className

Detailed Description

Gestor general de conexiones realizadas a diversos servidores LDAP.

Optimiza la creacion, busqueda y liberacion de las sesiónes establecidas contra un numero indeterminado de servidores LDAP.

El siguiente codigo muestra un ejemplo de implementacion:

class MyEngine : public ldap::Engine {
public:
   MyEngine () {;}
private:
   anna::Recycler<MySession> a_sessions;
   anna::ldap::Session* allocateSession (const int category) { return a_sessions.create (); }
   void releaseSession (anna::ldap::Session* session) {
      MySession* aux = static_cast <MySession*> (session);
      a_sessions.release (aux);
   }
};

Constructor & Destructor Documentation

◆ Engine()

anna::ldap::Engine::Engine ( )

protected

Constructor.

Member Function Documentation

◆ allocateSession()

virtual Session* anna::ldap::Engine::allocateSession ( const int category )

protectedpure virtual

Metodo invocado para instanciar sesiónes.

Para la creacion y liberacion de sesiónes es muy aconsejable usar el patron anna::Recycler.

Parameters

category Identifica la categoria o clase de sesión que deseamos instanciar. Este paremetro es el mismo indicado en el createSession. Facilita que una misma aplicacion pueda crear un numero indeterminado de sesiónes de distintos tipos, es decir, que actuen de forma distinta a la hora de recoger los resultados de las peticiones.

See also: anna::Recycler

◆ asXML()

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

virtual

Devuelve un documento XML con la informacion relevante sobre esta instancia.

Parameters

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

Returns: Un documento XML con la informacion relevante sobre esta instancia.

Reimplemented from anna::app::Component.

◆ closeSession()

void anna::ldap::Engine::closeSession ( Session * session )

noexcept

Libera todos los recursos asociados a una sesión LDAP, creada previemante con createSession. Si la sesión fuera NULL esta operación no tendrá ningún efecto.

Parameters

session Session LDAP a liberar.

◆ createSession() [1/3]

Session* anna::ldap::Engine::createSession	(	const char *	url,
		const char *	user,
		const char *	password,
		const int	category = `0`
	)

noexcept

Crea o reusa una sesión LDAP con los parámetros recibidos.

Las sesiónes LDAP estaran definidas univocamente por la pareja (url, user) si al invocar a este metodo ya existiera una sesión identificada por los mismos parámetros recibidos, se devolvera su instancia.

Si no existe una sesión identificada por la pareja (url, user) se creara mediate la llamada al metodo virtual puro (allocateSession), se realizara la peticion de conexion y se devolvera esta nueva instancia.

Dependiendo del indicador de conexión automática se solicitará la conexión al servidor o será el programador quien tenga que invocarlo mediate la llamada al método ldap::Session::bind.

Parameters

url	Direccion donde atiende peticiones el servidor LDAP.
user	Usuario requerido para establecer la conexion contra el servidor LDAP.
password	Password requerido para establecer la conexion contra el servidor LDAP.
category	Identifica el tipo de sesión a crear.

Returns: La session identificada por la url y user indicados como parametro.

Warning: La conexion no estara totalmente operativa hasta que no se reciba la notificacion correspondiente en el metodo Session::eventResponse confirmando que el ClassCode::Bind se ha realizado correctamente.

◆ createSession() [2/3]

Session* anna::ldap::Engine::createSession	(	const char *	url,
		const int	id,
		const char *	user,
		const char *	password,
		const int	category = `0`
	)

noexcept

Crea o reusa una sesión LDAP con los parámetros recibidos.

Las sesiónes LDAP estaran definidas univocamente por la pareja (url, id) si al invocar a este metodo ya existiera una sesión identificada por los mismos parámetros recibidos, se devolvera su instancia.

Si no existe una sesión identificada por la pareja (url, id) se creara mediate la llamada al metodo virtual puro (allocateSession), se realizara la peticion de conexion y se devolvera esta nueva instancia.

Dependiendo del indicador de conexión automática se solicitará la conexión al servidor o será el programador quien tenga que invocarlo mediate la llamada al método ldap::Session::bind.

Parameters

url	Direccion donde atiende peticiones el servidor LDAP.
id	Identificador usado para identificar la sesión.
user	Usuario requerido para establecer la conexion contra el servidor LDAP.
password	Password requerido para establecer la conexion contra el servidor LDAP.
category	Identifica el tipo de sesión a crear.

Returns: La session identificada por la url y id indicados como parametro.

Warning: La conexion no estara totalmente operativa hasta que no se reciba la notificacion correspondiente en el metodo Session::eventResponse confirmando que el ClassCode::Bind se ha realizado correctamente.

◆ createSession() [3/3]

Session* anna::ldap::Engine::createSession	(	const char *	url,
		const int	category = `0`
	)

inlinenoexcept

Crea o reusa una sesión LDAP con los parámetros recibidos a un servidor que no requiera identificar el usuario que solicita la conexion.

Las sesiónes LDAP estaran definidas univocamente por la pareja (url, user="") si al invocar a este metodo ya existiera una sesión identificada por los mismos parámetros recibidos, se devolvera su instancia.

Si no existe una sesión identificada por la pareja (url, user="") se creara mediate la llamada al metodo virtual puro (allocateSession), se realizara la peticion de conexion y se devolvera esta nueva instancia.

Parameters

url	Direccion donde atiende peticiones el servidor LDAP.
category	Identifica el tipo de sesión a crear.

Returns: La session identificada por la url indicada como parametro.

Warning: La conexion no estara totalmente operativa hasta que no se reciba la notificacion correspondiente en el metodo Session::eventResponse confirmando que el ClassCode::Bind se ha realizado correctamente.

                                                                                   {
     return createSession(url, NULL, NULL, category);
   }

Here is the call graph for this function:

◆ findSession() [1/3]

Session* anna::ldap::Engine::findSession	(	const char *	url,
		const char *	user,
		Exception::Mode::_v	emode = `Exception::Mode::Throw`
	)

noexcept

Devuelve la instancia de la sesión identificada por la pareja (url, user) recibidos como parámetros.

Parameters

url	Direccion de la maquina donde atiendo peticiones el servidor LDAP.
user	Usuario requerido para establecer la conexion contra el servidor LDAP.
emode	Modo de actuar en caso de que no exista una sesión que coincida con los parámetros indicados.

Returns: La instancia de la sesión identificada por la pareja (url, user) recibidos como parámetros.

Warning: Si no hay ninguna sesión identificada por la pareja (url, user) se devolvera una excepción.

◆ findSession() [2/3]

Session* anna::ldap::Engine::findSession	(	const char *	url,
		const int	id,
		Exception::Mode::_v	emode = `Exception::Mode::Throw`
	)

noexcept

Devuelve la instancia de la sesión identificada por la pareja (url, id) recibidos como parámetros.

Parameters

url	Direccion de la maquina donde atiendo peticiones el servidor LDAP.
id	Identificador indicado para establecer la conexion contra el servidor LDAP.
emode	Modo de actuar en caso de que no exista una sesión que coincida con los parámetros indicados.

Returns: La instancia de la sesión identificada por la pareja (url, id) recibidos como parámetros.

Warning: Si no hay ninguna sesión identificada por la pareja (url, id) se devolvera una excepción.

◆ findSession() [3/3]

Session* anna::ldap::Engine::findSession	(	const char *	url,
		Exception::Mode::_v	emode = `Exception::Mode::Throw`
	)

inlinenoexcept

Devuelve la instancia de la sesión identificada por la pareja (url, user="") recibidos como parámetros.

Parameters

url	Direccion de la maquina donde atiendo peticiones el servidor LDAP.
emode	Modo de actuar en caso de que no exista una sesión que coincida con los parámetros indicados.

Returns: La instancia de la sesión identificada por la pareja (url, user="") recibidos como parámetros.

Warning: Si no hay ninguna sesión identificada por la pareja (url, user) se devolvera una excepción.

                                                                                                     {
     return findSession(url, (const char*) NULL, emode);
   }

Here is the call graph for this function:

◆ getAutoBind()

bool anna::ldap::Engine::getAutoBind ( ) const

inline

Devuelve el valor del indicador de conexión automática. Por defecto este indicador será true.

Returns: el valor del indicador de conexión automática.

62 { return a_autoBind; }

◆ getClassName()

static const char* anna::ldap::Engine::getClassName ( )

inlinestatic

Devuelve el nombre lógico de este anna::app::Component.

Returns: El nombre lógico de este anna::app::Component.

214 { return "anna::ldap::Engine"; }

Here is the call graph for this function:

◆ releaseSession()

virtual void anna::ldap::Engine::releaseSession ( Session * )

protectedpure virtual

Metodo invocado para liberar sesiónes. En caso de que nuestra aplicacion requiera varios tipos de sesiónes LDAP habra que tener en cuenta el valor devuelto por ldap::Session::getCategory y liberar el tipo adecuado de sesión.

See also: anna::Recycler

◆ setAutoBind()

void anna::ldap::Engine::setAutoBind ( const bool autoBind )

inline

Establece el indicador de conexión automática. En caso de no indicarse será true.

Parameters

autoBind Valor que tomará el indicador de conexión automática.

Si es necesario cambiar el temporizador del Bind de una sesión LDAP, primero habrá que crearla sin conexión automática, cambiar el temporizador asociado e invocar al Bind invocando implícitamente al método ldap::Session::bind.

72 { a_autoBind = autoBind; }

Here is the call graph for this function:

◆ setDebugLevel()

static int anna::ldap::Engine::setDebugLevel ( const int level )

staticnoexcept

Establece el nivel de depuración de las operaciones del OpenLDAP.

Parameters

level Máscara que indica los elementos a depurar. Básicamente 0 para desactivar las trazas de depuración y -1 para activar el trazado de todo.

Returns: El nivel de depuración anterior.

See also: http://www.openldap.org/doc/admin23/runningslapd.html para más niveles.; DebugLevel

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

/tmp/anna/include/anna/ldap/Engine.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Engine()

Member Function Documentation

◆ allocateSession()

◆ asXML()

◆ closeSession()

◆ createSession() [1/3]

◆ createSession() [2/3]

◆ createSession() [3/3]

◆ findSession() [1/3]

◆ findSession() [2/3]

◆ findSession() [3/3]

◆ getAutoBind()

◆ getClassName()

◆ releaseSession()

◆ setAutoBind()

◆ setDebugLevel()