include/anna/ldap/Attribute.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_Attribute_hpp
  38 #define anna_ldap_Attribute_hpp
  39
  40 #include <string>
  41
  42 #include <anna/core/util/Recycler.hpp>
  43
  44 namespace anna {
  45
  46 namespace ldap {
  47
  48 class Session;
  49 class Response;
  50
  51 /**
  52    Modela los atributos retornados en una peticion de busqueda.
  53
  54    Recordar que en LDAP un mismo atributo puede tener asociados un numero indeterminado de valores.
  55
  56    \see ldap::Response
  57 */
  58 class Attribute {
  59 public:
  60   typedef Recycler<std::string> value_container;
  61   typedef value_container::const_iterator const_value_iterator;
  62
  63   /**
  64      Devuelve el nombre del atributo.
  65      \return El nombre del atributo.
  66   */
  67   const std::string& getName() const throw() { return a_name; }
  68
  69   /**
  70      Devuelve el iterador al comienzo de la lista de valores asociados a este atributo.
  71      \return El iterador al comienzo de la lista de valores asociados a este atributo.
  72   */
  73   const_value_iterator value_begin() const throw() { return a_values.begin(); }
  74
  75   /**
  76      Devuelve el iterador al final de la lista de valores asociados a este atributo.
  77      \return El iterador al final de la lista de valores asociados a este atributo.
  78   */
  79   const_value_iterator value_end() const throw() { return a_values.end(); }
  80
  81   /**
  82      Devuelve el valor asociado al iterador recibido como parametro.
  83      \param ii Instancia del iterador usado para recorrer los datos. Estara comprendido
  84      entre [#value_begin, #value_end).
  85      \return El valor referenciado por el iterador.
  86   */
  87   static const std::string& value(const_value_iterator ii) throw() { return *value_container::data(ii); }
  88
  89 private:
  90   std::string a_name;
  91   value_container a_values;
  92
  93   Attribute() {;}
  94
  95   void setName(const std::string& name) throw() { a_name = name; }
  96
  97   void add(const std::string& value) throw(RuntimeException) {
  98     std::string* newValue = a_values.create();
  99     *newValue = value;
 100   }
 101   void clear() throw() { a_name.clear(); a_values.clear(); }
 102
 103   friend class Session;
 104   friend class Response;
 105   friend class Allocator<Attribute>;
 106 };
 107
 108 }
 109 }
 110
 111 #endif
 112