include/anna/ldap/Request.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_ldap_Request_hpp
  38 #define anna_ldap_Request_hpp
  39
  40 #include <anna/ldap/defines.hpp>
  41 #include <anna/ldap/ClassCode.hpp>
  42
  43 namespace anna {
  44
  45 namespace xml {
  46 class Node;
  47 }
  48
  49 namespace ldap {
  50
  51 class Session;
  52
  53 /**
  54    Prototipo de las peticiones que podemos realizar a un servidor LDAP.
  55 */
  56 class Request {
  57 public:
  58   /**
  59    * Define las acciones a realizar en caso de que el temporizador de la petición expire.
  60    */
  61   struct OnExpiry { enum _v { Abandon, Ignore }; };
  62
  63   /**
  64      Devuelve el tipo de la clase de esta peticion indicada en el contructor.
  65      \return El tipo de la clase de esta peticion indicada en el contructor.
  66   */
  67   ClassCode::_v getClassCode() const throw() { return a_classCode; }
  68
  69   /**
  70    * Devuelve la acción a realizar en caso de que el temporizador asociado a esta petición expire.
  71    * \return la acción a realizar en caso de que el temporizador asociado a esta petición expire.
  72    */
  73   OnExpiry::_v getOnExpiry() const throw() { return a_onExpiry; }
  74
  75   /**
  76    * Establece la acción a realizar en caso de que el temporizador asociado a esta petición expire.
  77    * \param onExpiry Indica la acción a realizar en caso de que el temporizador asociado a esta petición expire.
  78    *
  79    * \warning Establecer el valor OnExpiry::Ignore podría causar pérdida de memoria y uso innecesario de recursos.
  80    */
  81   void setOnExpiry(const OnExpiry::_v onExpiry)  throw() { a_onExpiry = onExpiry; }
  82
  83   /**
  84      Devuelve una cadena con la informacion mas relevante de esta instancia.
  85      \return Una cadena con la informacion mas relevante de esta instancia.
  86   */
  87   virtual std::string asString() const throw();
  88
  89   /**
  90      Devuelve un documento XML con la informacion mas relevante de esta instancia.
  91      \param parent Nodo XML del que colgar la informacion referente a esta instancia.
  92      \return Un documento XML con la informacion mas relevante de esta instancia.
  93   */
  94   virtual xml::Node* asXML(xml::Node* parent) const throw();
  95
  96   /**
  97      Inicializa los parametros de esta peticion.
  98   */
  99   virtual void clear() throw() = 0;
 100
 101   /**
 102      Devuelve \em NULL si la \em std::string recibida como parametro esta vacia o el contenido de la
 103      misma en otro caso.
 104      \return \em NULL si la \em std::string recibida como parametro esta vacia o el contenido de la
 105      misma en otro caso.
 106      \warning Uso interno.
 107   */
 108   static const char* asCString(const std::string& value) throw() {
 109     return (value.empty() == true) ? NULL : value.c_str();
 110   }
 111
 112   /**
 113      Devuelve \em "<null>" si la std::string recibida como parametro esta vacia o el contenido de la
 114      misma en otro caso.
 115      \return \em "<null>" si la std::string recibida como parametro esta vacia o el contenido de la
 116      misma en otro caso.
 117   */
 118   static const char* asText(const std::string& value) throw() {
 119     return (value.empty() == true) ? "<null>" : value.c_str();
 120   }
 121
 122 protected:
 123   /**
 124      Constructor.
 125      \param classCode Tipo de clase de esta peticion.
 126      \param onExpiry Indica la acción a realizar si el temporizador de esta transación expira.
 127   */
 128   Request(const ClassCode::_v classCode, const OnExpiry::_v onExpiry) : a_classCode(classCode), a_onExpiry(onExpiry) {;}
 129
 130 private:
 131   ClassCode::_v a_classCode;
 132   OnExpiry::_v a_onExpiry;
 133
 134   virtual IdMessage send(Session&) const throw() = 0;
 135
 136   friend class Session;
 137 };
 138
 139 }
 140 }
 141
 142 #endif
 143