include/anna/diameter/stack/AvpRule.hpp

   1 // ANNA - Anna is Not 'N' 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_diameter_stack_AvpRule_hpp
  38 #define anna_diameter_stack_AvpRule_hpp
  39
  40
  41 // Local
  42 #include <anna/diameter/defines.hpp>
  43
  44 #include <anna/core/RuntimeException.hpp>
  45 #include <anna/core/define.autoenum.hpp>
  46
  47 // STL
  48 #include <string>
  49 #include <map>
  50
  51
  52 // Five spaces:
  53 #define DICTIONARY_AVPRULE_TAB      "     "
  54
  55
  56
  57 namespace anna {
  58 namespace xml {
  59 class Node;
  60 }
  61 }
  62
  63
  64
  65 namespace anna {
  66
  67 namespace diameter {
  68
  69 namespace stack {
  70
  71 class Dictionary;
  72
  73 //------------------------------------------------------------------------------
  74 //---------------------------------------------------------------- class AvpRule
  75 //------------------------------------------------------------------------------
  76 /**
  77 * Avp rule information
  78 */
  79 class AvpRule {
  80
  81 public:
  82
  83   struct Presence {
  84     enum _v {
  85       None = -1,
  86       Fixed,
  87       Mandatory,
  88       Optional
  89     };
  90
  91     anna_declare_enum(Presence);
  92
  93     /**
  94     * Presence description
  95     * @param v Presence type
  96     * @return Presence description
  97     */
  98     static const char* asText(const Presence::_v v) throw(anna::RuntimeException) {
  99       return asCString(v);
 100     }
 101   };
 102
 103 private:
 104
 105   const Dictionary *a_dictionary;
 106   std::string a_avpName; // reference
 107   Presence::_v a_presence;
 108   std::string a_qual;
 109
 110   void _initialize(const Dictionary *d) throw() {
 111     a_dictionary = d;
 112     a_avpName = "";
 113     a_presence = Presence::None;
 114     a_qual = "";
 115   }
 116
 117 public:
 118
 119
 120   AvpRule(const Dictionary *d = NULL) { _initialize(d); }
 121   ~AvpRule() {};
 122
 123
 124   // get
 125   const std::string & getAvpName(void) const throw() { return a_avpName; }
 126   const Presence::_v & getPresence(void) const throw() { return a_presence; }
 127   const std::string & getQual(void) const throw() { return a_qual; }
 128
 129   // helpers
 130   AvpId getId(void) const throw();
 131   bool isAny(void) const throw(); // generic Avp
 132   bool isFixed(void) const throw() { return (a_presence == Presence::Fixed); }
 133   bool isMandatory(void) const throw() { return (a_presence == Presence::Mandatory); }
 134   bool isOptional(void) const throw() { return (a_presence == Presence::Optional); }
 135   int getQualMin(void) const throw();
 136   int getQualMax(void) const throw(); // -1 is infinite
 137
 138   std::string asString(bool showPair = true) const throw();
 139   anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
 140
 141   // operators
 142
 143   // set
 144   void initialize(const Dictionary *d = NULL) throw() { _initialize(d); }
 145   void setAvpName(const std::string & an) throw() { a_avpName = an; }
 146   void setPresence(const Presence::_v & p) throw() { a_presence = p; }
 147   void setQual(const std::string & q) throw(anna::RuntimeException);
 148 };
 149
 150
 151 }
 152 }
 153 }
 154
 155
 156 #endif
 157