shibsp/attribute/SimpleAttribute.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file shibsp/attribute/SimpleAttribute.h
  23  *
  24  * An Attribute whose values are simple strings.
  25  */
  26
  27 #ifndef __shibsp_simpattr_h__
  28 #define __shibsp_simpattr_h__
  29
  30 #include <shibsp/attribute/Attribute.h>
  31
  32 namespace shibsp {
  33
  34     /**
  35      * An Attribute whose values are simple strings.
  36      */
  37     class SHIBSP_API SimpleAttribute : public Attribute
  38     {
  39     public:
  40         /**
  41          * Constructor.
  42          *
  43          * @param ids   array with primary identifier in first position, followed by any aliases
  44          */
  45         SimpleAttribute(const std::vector<std::string>& ids);
  46
  47         /**
  48          * Constructs based on a remoted SimpleAttribute.
  49          *
  50          * @param in    input object containing marshalled SimpleAttribute
  51          */
  52         SimpleAttribute(DDF& in);
  53
  54         virtual ~SimpleAttribute();
  55
  56         /**
  57          * Returns the set of values encoded as UTF-8 strings.
  58          *
  59          * <p>For simple values, the serialized form is just the actual string,
  60          * so the value array can be directly manipulated.
  61          *
  62          * @return  a mutable vector of the values
  63          */
  64         std::vector<std::string>& getValues();
  65
  66         // Virtual function overrides.
  67         void clearSerializedValues();
  68         DDF marshall() const;
  69     };
  70
  71 };
  72
  73 #endif /* __shibsp_simpattr_h__ */