shibsp/attribute/ScopedAttribute.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/attribute/ScopedAttribute.h
  19  *
  20  * An Attribute whose values are relations of a value and a scope.
  21  */
  22
  23 #ifndef __shibsp_scopedattr_h__
  24 #define __shibsp_scopedattr_h__
  25
  26 #include <shibsp/attribute/Attribute.h>
  27
  28 namespace shibsp {
  29
  30 #if defined (_MSC_VER)
  31     #pragma warning( push )
  32     #pragma warning( disable : 4251 )
  33 #endif
  34
  35     /**
  36      * An Attribute whose values are relations of a value and a scope.
  37      *
  38      * <p>In practice, scoped attributes are simple pairs of strings instead
  39      * of a single string. They can be expressed as a string easily using a delimeter,
  40      * typically an '@' symbol. The scope concept allows certain kinds of filtering to
  41      * be performed more intelligently and efficiently, although not all scoped
  42      * attributes can be effectively filtered (e.g. if the set of scope values is
  43      * unconstrained).
  44      */
  45     class SHIBSP_API ScopedAttribute : public Attribute
  46     {
  47     public:
  48         /**
  49          * Constructor
  50          *
  51          * @param id        Attribute identifier
  52          * @param delimeter value/scope delimeter when serializing
  53          */
  54         ScopedAttribute(const char* id, char delimeter='@') : Attribute(id), m_delimeter(delimeter) {}
  55
  56         /**
  57          * Constructs based on a remoted ScopedAttribute.
  58          *
  59          * @param in    input object containing marshalled ScopedAttribute
  60          */
  61         ScopedAttribute(DDF& in) : Attribute(in), m_delimeter('@') {
  62             DDF val = in["_delimeter"];
  63             if (val.isint())
  64                 m_delimeter = static_cast<char>(val.integer());
  65             val = in.first().first();
  66             while (val.name() && val.string()) {
  67                 m_values.push_back(std::make_pair(val.name(), val.string()));
  68                 val = in.first().next();
  69             }
  70         }
  71
  72         virtual ~ScopedAttribute() {}
  73
  74         /**
  75          * Returns the set of values encoded as UTF-8 strings.
  76          *
  77          * <p>Each compound value is a pair containing the simple value and the scope.
  78          *
  79          * @return  a mutable vector of the values
  80          */
  81         std::vector< std::pair<std::string,std::string> >& getValues() {
  82             return m_values;
  83         }
  84
  85         size_t valueCount() const {
  86             return m_values.size();
  87         }
  88
  89         void clearSerializedValues() {
  90             m_serialized.clear();
  91         }
  92
  93         const char* getString(size_t index) const {
  94             return m_values[index].first.c_str();
  95         }
  96
  97         const char* getScope(size_t index) const {
  98             return m_values[index].second.c_str();
  99         }
 100
 101         void removeValue(size_t index) {
 102             Attribute::removeValue(index);
 103             if (index < m_values.size())
 104                 m_values.erase(m_values.begin() + index);
 105         }
 106
 107         const std::vector<std::string>& getSerializedValues() const {
 108             if (m_serialized.empty()) {
 109                 for (std::vector< std::pair<std::string,std::string> >::const_iterator i=m_values.begin(); i!=m_values.end(); ++i)
 110                     m_serialized.push_back(i->first + m_delimeter + i->second);
 111             }
 112             return Attribute::getSerializedValues();
 113         }
 114
 115         DDF marshall() const {
 116             DDF ddf = Attribute::marshall();
 117             ddf.name("Scoped");
 118             if (m_delimeter != '@')
 119                 ddf.addmember("_delimeter").integer(m_delimeter);
 120             DDF vlist = ddf.first();
 121             for (std::vector< std::pair<std::string,std::string> >::const_iterator i=m_values.begin(); i!=m_values.end(); ++i) {
 122                 DDF val = DDF(i->first.c_str()).string(i->second.c_str());
 123                 vlist.add(val);
 124             }
 125             return ddf;
 126         }
 127
 128     private:
 129         char m_delimeter;
 130         std::vector< std::pair<std::string,std::string> > m_values;
 131     };
 132
 133 #if defined (_MSC_VER)
 134     #pragma warning( pop )
 135 #endif
 136
 137 };
 138
 139 #endif /* __shibsp_scopedattr_h__ */