shibsp/attribute/SimpleAttribute.h

   1 /*
   2  *  Copyright 2001-2006 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/SimpleAttribute.h
  19  *
  20  * An Attribute whose values are simple strings.
  21  */
  22
  23 #ifndef __shibsp_simpattr_h__
  24 #define __shibsp_simpattr_h__
  25
  26 #include <shibsp/attribute/Attribute.h>
  27
  28 namespace shibsp {
  29
  30     /**
  31      * An Attribute whose values are simple strings.
  32      */
  33     class SHIBSP_API SimpleAttribute : public Attribute
  34     {
  35     public:
  36         /**
  37          * Constructor
  38          *
  39          * @param id    Attribute identifier
  40          */
  41         SimpleAttribute(const char* id) : Attribute(id) {}
  42
  43         virtual ~SimpleAttribute() {}
  44
  45         /**
  46          * Returns the set of values encoded as UTF-8 strings.
  47          *
  48          * <p>For simple values, the serialized form is just the actual string,
  49          * so the value array can be directly manipulated.
  50          *
  51          * @return  a mutable vector of the values
  52          */
  53         std::vector<std::string>& getValues() {
  54             return m_serialized;
  55         }
  56
  57         void clearSerializedValues() const {
  58             // Do nothing, since our values are already serialized.
  59         }
  60
  61         DDF marshall() const {
  62             DDF ddf = Attribute::marshall();
  63             DDF vlist = ddf.addmember("values").list();
  64             for (std::vector<std::string>::const_iterator i=m_serialized.begin(); i!=m_serialized.end(); ++i)
  65                 vlist.add(DDF(NULL).string(i->c_str()));
  66             return ddf;
  67         }
  68     };
  69
  70 };
  71
  72 #endif /* __shibsp_simpattr_h__ */