X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fdiameter%2Fcodec%2FAvp.hpp;h=164234e2d82db55af0e0a9f03c9b7c17ba199ae7;hb=b9cb59210ce2a02d8246f1a9a1acfcfdcd892f3a;hp=cd6c1008c97f676f403632575cd8c89cd2b4f183;hpb=4e12ac57e93c052f716a6305ad8fc099c45899d1;p=anna.git diff --git a/include/anna/diameter/codec/Avp.hpp b/include/anna/diameter/codec/Avp.hpp index cd6c100..164234e 100644 --- a/include/anna/diameter/codec/Avp.hpp +++ b/include/anna/diameter/codec/Avp.hpp @@ -1,8 +1,8 @@ -// ANNA - Anna is Not 'N' Anymore +// ANNA - Anna is Not Nothingness Anymore // // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo // -// https://bitbucket.org/testillano/anna +// http://redmine.teslayout.com/projects/anna-suite // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions @@ -14,7 +14,7 @@ // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. -// * Neither the name of Google Inc. nor the names of its +// * Neither the name of the copyright holder nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // @@ -42,8 +42,8 @@ #include #include #include +#include #include -#include #include @@ -70,17 +70,6 @@ namespace anna { namespace diameter { -namespace helpers { -namespace tme { -namespace codectypes { -class Unsigned16; -class ISDNNumber; -class ISDNAddress; -} -} -} - - namespace stack { class Dictionary; class Format; @@ -124,7 +113,6 @@ typedef std::map::iterator find_iterator; using namespace basetypes; -using namespace helpers::tme::codectypes; /** * Diameter avp generic container @@ -201,14 +189,6 @@ class Avp { QoSFilterRule *a_QoSFilterRule; Unknown *a_Unknown; - // Derived formats //////////////////////////////////////////// - /* TME */ - ISDNNumber *a_ISDNNumber; - ISDNAddress *a_ISDNAddress; - Unsigned16 *a_Unsigned16; - - - // Grouped helpers find_container a_finds; // fast access for grouped and message first-level avps @@ -226,7 +206,7 @@ class Avp { static Avp * addAvp(avp_container &avps, int &insertionPositionForChilds, AvpId id, Engine *engine) throw(); static bool removeAvp(avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine) throw(); static void fix(avp_container &avps, find_container &finds, int &insertionPositionForChilds, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd) throw(); - static bool validLevel(const avp_container &avps, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd, Engine * engine, const std::string & parentDescription, Message *answer) throw(anna::RuntimeException); // validates mandatory/fixed and cardinality + static bool validLevel(const avp_container &avps, anna::diameter::stack::const_avprule_iterator ruleBegin, anna::diameter::stack::const_avprule_iterator ruleEnd, Engine * engine, const anna::diameter::codec::parent_t & parent, Message *answer) throw(anna::RuntimeException); // validates mandatory/fixed and cardinality static const Avp* getAvp(const avp_container &avps, find_container &finds, AvpId id, int ocurrence, Engine *engine, anna::Exception::Mode::_v emode) throw(anna::RuntimeException); static int countAvp(const avp_container &avps, AvpId id) throw(); static const Avp* firstAvp(const avp_container &avps, AvpId id) throw(); @@ -250,7 +230,6 @@ class Avp { static const Avp* avp(const_avp_iterator ii) throw() { return ii->second; } // Internal - void assertFormat(const std::string &name) const throw(anna::RuntimeException); bool flagsOK() const throw(); // flags coherence regarding dictionary. Only must be called when AVP is identified at the dictionary. int addChild(Avp *avp) throw(anna::RuntimeException) { assertFormat("Grouped"); return addChild(a_avps, a_insertionPositionForChilds, avp); } bool hasChildren() throw() { return a_avps.size() != 0; } @@ -269,12 +248,12 @@ class Avp { /** Validates an Avp regarding dictionary rules like enumerated range, flags coherence, mandatory and fixed types, cardinality qualifiers, etc. - @param parentDescription Parent description. Internally used for alarms and tracing + @param parent Parent description. Internally used for alarms, tracing and Failed-AVP construction @param answer Answer could be modified with any validation problem during requests validation @return Boolean indicating validation result */ - bool valid(const std::string & parentDescription, Message *answer) const throw(anna::RuntimeException); + bool valid(const anna::diameter::codec::parent_t & parent, Message *answer) const throw(anna::RuntimeException); /** Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved @@ -282,9 +261,10 @@ class Avp { depending on validation depth (codec::Engine::ValidationDepth). @param db Buffer data block processed + @param parent Parent description. Internally used for alarms, tracing and Failed-AVP construction @param answer Answer built for request decoding/validation */ - void decode(const anna::DataBlock &db, Message *answer) throw(anna::RuntimeException); + void decode(const anna::DataBlock &db, const anna::diameter::codec::parent_t & parent, Message *answer) throw(anna::RuntimeException); ///////////////////////////////////////////// @@ -293,80 +273,80 @@ class Avp { /** * Initializes Avp class information. - * Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + * Default implementation supports all anna::diameter formats (including derived ones). * Diameter basic formats are managed at #initialize, which will invoke this method at the end. */ - virtual void initializeByFormat() throw(); + virtual void initializeByFormat() throw() {}; /** * Gets avp data-part length. - * Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + * Default implementation supports all anna::diameter formats (including derived ones). * Diameter basic formats are managed at #initialize, which will invoke this method at the end. * * @param stackFormat Stack avp format in which data extraction is based. * * @return Avp data-part size. */ - virtual U24 getLengthByFormat(const anna::diameter::stack::Format *stackFormat) const throw(); + virtual U24 getLengthByFormat(const anna::diameter::stack::Format *stackFormat) const throw() { return 0; }; /** Gets data or hexadecimal data depending on avp format, for xml creating - Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + Default implementation supports all anna::diameter formats (including derived ones). Diameter basic formats are managed at #initialize, which will invoke this method at the end. \param isHex Hexadecimal/Natural data when apply. \param stackFormat Stack avp format in which data extraction is based. \return xml data representation */ - virtual std::string getXMLdataByFormat(bool & isHex, const anna::diameter::stack::Format *stackFormat) const throw(); + virtual std::string getXMLdataByFormat(bool & isHex, const anna::diameter::stack::Format *stackFormat) const throw() { return ""; }; /** Interpret xml data in order to dump over the class content. - Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + Default implementation supports all anna::diameter formats (including derived ones). Diameter basic formats are managed at #initialize, which will invoke this method at the end. \param data Avp data attribute \param hexData Avp hex-data attribute \param stackFormat Stack avp format in which data extraction is based. */ - virtual void fromXMLByFormat(const anna::xml::Attribute* data, const anna::xml::Attribute* hexData, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException); + virtual void fromXMLByFormat(const anna::xml::Attribute* data, const anna::xml::Attribute* hexData, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException) {}; /** Encodes buffer with the class content. - Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + Default implementation supports all anna::diameter formats (including derived ones). Diameter basic formats are managed at #initialize, which will invoke this method at the end. @param dataPart Data-part begin pointer @param stackFormat Stack avp format in which data extraction is based. */ - virtual void codeByFormat(char* dataPart, const anna::diameter::stack::Format *stackFormat) const throw(anna::RuntimeException); + virtual void codeByFormat(char* dataPart, const anna::diameter::stack::Format *stackFormat) const throw(anna::RuntimeException) {}; /** Decodes Avp data part. - Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + Default implementation supports all anna::diameter formats (including derived ones). Diameter basic formats are managed at #initialize, which will invoke this method at the end. @param buffer Avp data part start pointer @param size Avp data part size @param stackFormat Stack avp format in which data extraction is based. */ - virtual void decodeDataPartByFormat(const char * buffer, int size, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException); + virtual void decodeDataPartByFormat(const char * buffer, int size, const anna::diameter::stack::Format *stackFormat) throw(anna::RuntimeException) {}; /** Reserves memory for data part depending on avp format for the identifier provided. - Default implementation supports all anna::diameter formats (including i.e. tme.db ones). + Default implementation supports all anna::diameter formats (including derived ones). Diameter basic formats are managed at #initialize, which will invoke this method at the end. @param stackFormat Stack avp format in which data extraction is based. */ - virtual void allocationByFormat(const anna::diameter::stack::Format *stackFormat) throw(); + virtual void allocationByFormat(const anna::diameter::stack::Format *stackFormat) throw() {}; /** * Clears Avp data-part format containers. */ - virtual void clearByFormat() throw(); + virtual void clearByFormat() throw() {}; @@ -383,6 +363,10 @@ protected: */ void initialize() throw(); + /** + * Assert format regarding dictionary + */ + void assertFormat(const std::string &name) const throw(anna::RuntimeException); /** * Gets avp total length based on internal data part and header configuration. @@ -401,31 +385,16 @@ protected: */ std::string getXMLdata(bool & isHex, const anna::diameter::stack::Format *stackFormat) const throw(); - /** - Interpret xml data in order to dump over the class content. - - \param avpNode Avp root node - */ - void fromXML(const anna::xml::Node* avpNode) throw(anna::RuntimeException); - - - /** - Encodes buffer with the class content. - - * @param buffer Raw data to be encoded - * @param size Size of raw data to be encoded - */ - void code(char* buffer, int &size) const throw(anna::RuntimeException); - /** Decodes Avp data part. @param buffer Avp data part start pointer @param size Avp data part size + @param parent Parent description. Internally used for alarms, tracing and Failed-AVP construction @param answer Answer built for request decoding/validation */ - void decodeDataPart(const char * buffer, int size, Message *answer) throw(anna::RuntimeException); + void decodeDataPart(const char * buffer, int size, const anna::diameter::codec::parent_t & parent, Message *answer) throw(anna::RuntimeException); public: @@ -574,15 +543,6 @@ public: /** Access content for Unknown Avp in order to set data part */ Unknown * getUnknown() throw(anna::RuntimeException) { assertFormat("Unknown"); return a_Unknown; } - // Derived formats //////////////////////////////////////////// - /* TME */ - /** Access content for ISDNNumber Avp in order to set data part */ - ISDNNumber * getISDNNumber() throw(anna::RuntimeException) { assertFormat("ISDNNumber"); return a_ISDNNumber; } - /** Access content for ISDNAddress Avp in order to set data part */ - ISDNAddress * getISDNAddress() throw(anna::RuntimeException) { assertFormat("ISDNAddress"); return a_ISDNAddress; } - /** Access content for Unsigned16 Avp in order to set data part */ - Unsigned16 * getUnsigned16() throw(anna::RuntimeException) { assertFormat("Unsigned16"); return a_Unsigned16; } - /** Removes an Avp within grouped type (first level) and free resources. @@ -714,14 +674,35 @@ public: const Unknown * getUnknown() const throw(anna::RuntimeException) { assertFormat("Unknown"); return a_Unknown; } - // Derived formats //////////////////////////////////////////// - /* TME */ - /** Access content for ISDNNumber Avp */ - const ISDNNumber * getISDNNumber() const throw(anna::RuntimeException) { assertFormat("ISDNNumber"); return a_ISDNNumber; } - /** Access content for ISDNAddress Avp */ - const ISDNAddress * getISDNAddress() const throw(anna::RuntimeException) { assertFormat("ISDNAddress"); return a_ISDNAddress; } - /** Access content for Unsigned16 Avp */ - const Unsigned16 * getUnsigned16() const throw(anna::RuntimeException) { assertFormat("Unsigned16"); return a_Unsigned16; } + /** + Decodes buffer provided over class content. If an error ocurred, decoding will stop launching exception (fatal error) or a warning trace (perhaps the achieved + avp is valid against all odds then validation will go on). In case that validation is enabled (codec::Engine::ValidationMode) an exception will be launched + depending on validation depth (codec::Engine::ValidationDepth). + + Useful as serialization procedure with #code + + @param db Buffer data block processed + */ + void decode(const anna::DataBlock &db) throw(anna::RuntimeException); + + + /** + Interpret xml data in order to dump over the class content. + + \param avpNode Avp root node + */ + void fromXML(const anna::xml::Node* avpNode) throw(anna::RuntimeException); + + + /** + Encodes buffer with the class content. This method is internally used to encode diameter messages, but is declared as public, to allow + its use as serialization procedure. Then, it's assumed that this Avp is valid (validation shall be applied as part of a whole diameter + message but nothing will be verified now). + + * @param buffer Raw data to be encoded (shall be externally allocated) + * @param size Size of raw data to be encoded + */ + void code(char* buffer, int &size) const throw(anna::RuntimeException); // Helpers @@ -739,6 +720,26 @@ public: */ std::string asXMLString() const throw(); + /** + Comparison operator by mean serialization + + @param a1 Instance 1 for Avp class + @param a2 Instance 2 for Avp class + + @return Comparison result + */ + friend bool operator == (const Avp & a1, const Avp & a2) throw() { return (a1.asXMLString() == a2.asXMLString()); } + + /** + Match a regular expression (string pattern) regarding xml string serialization for this avp. + This works same as #Message::isLike + + @param pattern Pattern to match + + \return Returns the match result + */ + bool isLike(const std::string &pattern) const throw(); + /** Counts the number of ocurrences of Avps (first level) with the identifier provided @@ -764,12 +765,10 @@ public: Diameter Relay and redirect agents MUST NOT reject messages with unrecognized AVPs. Default implementation launch alarm and counter indicating the anomaly but don't launch exception (traces at warning level). - Realy and Redirect agents could reimplement this method to avoid oam management (another way is avoid alarm/counter registration on + Relay and Redirect agents could reimplement this method to avoid oam management (another way is avoid alarm/counter registration on these applications). Result-Code DIAMETER_AVP_UNSUPPORTED will be stored for possible answer message. - - @param answer Answer built for request decoding/validation */ - virtual void unknownAvpWithMandatoryBit(Message *answer) const throw(anna::RuntimeException); + virtual void unknownAvpWithMandatoryBit() const throw(anna::RuntimeException); friend class Message;