shibsp/attribute/SimpleAttribute.h

   1 /*
   2  *  Copyright 2001-2009 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 ids   array with primary identifier in first position, followed by any aliases
  40          */
  41         SimpleAttribute(const std::vector<std::string>& ids);
  42
  43         /**
  44          * Constructs based on a remoted SimpleAttribute.
  45          *
  46          * @param in    input object containing marshalled SimpleAttribute
  47          */
  48         SimpleAttribute(DDF& in);
  49
  50         virtual ~SimpleAttribute();
  51
  52         /**
  53          * Returns the set of values encoded as UTF-8 strings.
  54          *
  55          * <p>For simple values, the serialized form is just the actual string,
  56          * so the value array can be directly manipulated.
  57          *
  58          * @return  a mutable vector of the values
  59          */
  60         std::vector<std::string>& getValues();
  61
  62         // Virtual function overrides.
  63         void clearSerializedValues();
  64         DDF marshall() const;
  65     };
  66
  67 };
  68
  69 #endif /* __shibsp_simpattr_h__ */