shibsp/attribute/ExtensibleAttribute.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/ExtensibleAttribute.h
  23  *
  24  * An Attribute whose values are arbitrary structures.
  25  */
  26
  27 #ifndef __shibsp_extattr_h__
  28 #define __shibsp_extattr_h__
  29
  30 #include <shibsp/attribute/Attribute.h>
  31
  32 namespace shibsp {
  33
  34 #if defined (_MSC_VER)
  35     #pragma warning( push )
  36     #pragma warning( disable : 4251 )
  37 #endif
  38
  39     /**
  40      * An Attribute whose values are arbitrary structures.
  41      */
  42     class SHIBSP_API ExtensibleAttribute : public Attribute
  43     {
  44     public:
  45         /**
  46          * Constructor.
  47          *
  48          * @param ids       array with primary identifier in first position, followed by any aliases
  49          * @param formatter template for serialization of values
  50          */
  51         ExtensibleAttribute(const std::vector<std::string>& ids, const char* formatter);
  52
  53         /**
  54          * Constructs based on a remoted ExtensibleAttribute.
  55          *
  56          * @param in    input object containing marshalled ExtensibleAttribute
  57          */
  58         ExtensibleAttribute(DDF& in);
  59
  60         virtual ~ExtensibleAttribute();
  61
  62         /**
  63          * Returns the set of values in a DDF list.
  64          *
  65          * @return  a mutable list object containing the values
  66          */
  67         DDF getValues();
  68
  69         // Virtual function overrides.
  70         size_t valueCount() const;
  71         void clearSerializedValues();
  72         const char* getString(size_t index) const;
  73         const char* getScope(size_t index) const;
  74         void removeValue(size_t index);
  75         const std::vector<std::string>& getSerializedValues() const;
  76         DDF marshall() const;
  77
  78     private:
  79         mutable DDF m_obj;
  80     };
  81
  82 #if defined (_MSC_VER)
  83     #pragma warning( pop )
  84 #endif
  85
  86 };
  87
  88 #endif /* __shibsp_nameidattr_h__ */