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          */
  53         ScopedAttribute(const char* id) : Attribute(id) {}
  54
  55         /**
  56          * Constructs based on a remoted ScopedAttribute.
  57          *
  58          * @param in    input object containing marshalled ScopedAttribute
  59          */
  60         ScopedAttribute(DDF& in) : Attribute(in) {
  61             DDF val = in.first().first();
  62             while (val.name() && val.string()) {
  63                 m_values.push_back(std::make_pair(val.name(), val.string()));
  64                 val = val.next();
  65             }
  66         }
  67
  68         virtual ~ScopedAttribute() {}
  69
  70         /**
  71          * Returns the set of values encoded as UTF-8 strings.
  72          *
  73          * <p>Each compound value is a pair containing the simple value and the scope.
  74          *
  75          * @return  a mutable vector of the values
  76          */
  77         std::vector< std::pair<std::string,std::string> >& getValues() {
  78             return m_values;
  79         }
  80
  81         size_t valueCount() const {
  82             return m_values.size();
  83         }
  84
  85         void clearSerializedValues() {
  86             m_serialized.clear();
  87         }
  88
  89         const std::vector<std::string>& getSerializedValues() const {
  90             if (m_serialized.empty()) {
  91                 for (std::vector< std::pair<std::string,std::string> >::const_iterator i=m_values.begin(); i!=m_values.end(); ++i)
  92                     m_serialized.push_back(i->first + '@' + i->second);
  93             }
  94             return Attribute::getSerializedValues();
  95         }
  96
  97         DDF marshall() const {
  98             DDF ddf = Attribute::marshall();
  99             ddf.name("scoped");
 100             DDF vlist = ddf.first();
 101             for (std::vector< std::pair<std::string,std::string> >::const_iterator i=m_values.begin(); i!=m_values.end(); ++i) {
 102                 DDF val = DDF(i->first.c_str()).string(i->second.c_str());
 103                 vlist.add(val);
 104             }
 105             return ddf;
 106         }
 107
 108     private:
 109         std::vector< std::pair<std::string,std::string> > m_values;
 110     };
 111
 112 #if defined (_MSC_VER)
 113     #pragma warning( pop )
 114 #endif
 115
 116 };
 117
 118 #endif /* __shibsp_scopedattr_h__ */