shibsp/attribute/BinaryAttribute.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/BinaryAttribute.h
  23  *
  24  * An Attribute whose values are binary data.
  25  */
  26
  27 #ifndef __shibsp_binattr_h__
  28 #define __shibsp_binattr_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 binary data.
  41      *
  42      * <p>Binary attributes use base64 encoding to serialize their values.
  43      * The original binary values are accessible in the underlying value
  44      * collection.
  45      */
  46     class SHIBSP_API BinaryAttribute : public Attribute
  47     {
  48     public:
  49         /**
  50          * Constructor.
  51          *
  52          * @param ids   array with primary identifier in first position, followed by any aliases
  53          */
  54         BinaryAttribute(const std::vector<std::string>& ids);
  55
  56         /**
  57          * Constructs based on a remoted BinaryAttribute.
  58          *
  59          * @param in    input object containing marshalled BinaryAttribute
  60          */
  61         BinaryAttribute(DDF& in);
  62
  63         virtual ~BinaryAttribute();
  64
  65         /**
  66          * Returns the set of raw binary values.
  67          *
  68          * @return  a mutable vector of the values
  69          */
  70         std::vector<std::string>& getValues();
  71
  72         /**
  73          * Returns the set of raw binary values.
  74          *
  75          * @return  an immutable vector of the values
  76          */
  77         const std::vector<std::string>& getValues() const;
  78
  79         // Virtual function overrides.
  80         size_t valueCount() const;
  81         void clearSerializedValues();
  82         const char* getString(size_t index) const;
  83         void removeValue(size_t index);
  84         const std::vector<std::string>& getSerializedValues() const;
  85         DDF marshall() const;
  86
  87     private:
  88         std::vector<std::string> m_values;
  89     };
  90
  91 #if defined (_MSC_VER)
  92     #pragma warning( pop )
  93 #endif
  94
  95 };
  96
  97 #endif /* __shibsp_scopedattr_h__ */