Imported Upstream version 2.2.1+dfsg

[shibboleth/sp.git] / shibsp / attribute / XMLAttribute.h

diff --git a/shibsp/attribute/XMLAttribute.h b/shibsp/attribute/XMLAttribute.h
new file mode 100644 (file)
index 0000000..3c9a4f6
--- /dev/null
+++ b/shibsp/attribute/XMLAttribute.h
@@ -0,0 +1,111 @@
+/*
+ *  Copyright 2009 Internet2
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file shibsp/attribute/XMLAttribute.h
+ *
+ * An Attribute whose values are serialized XML.
+ */
+
+#ifndef __shibsp_xmlattr_h__
+#define __shibsp_xmlattr_h__
+
+#include <shibsp/attribute/Attribute.h>
+
+namespace shibsp {
+
+    /**
+     * An Attribute whose values are serialized XML.
+     */
+    class SHIBSP_API XMLAttribute : public Attribute
+    {
+    public:
+        /**
+         * Constructor.
+         *
+         * @param ids   array with primary identifier in first position, followed by any aliases
+         */
+        XMLAttribute(const std::vector<std::string>& ids) : Attribute(ids) {}
+
+        /**
+         * Constructs based on a remoted XMLAttribute.
+         *
+         * @param in    input object containing marshalled XMLAttribute
+         */
+        XMLAttribute(DDF& in) : Attribute(in) {
+            DDF val = in.first().first();
+            while (val.string()) {
+                m_values.push_back(val.string());
+                val = in.first().next();
+            }
+        }
+
+        virtual ~XMLAttribute() {}
+
+        /**
+         * Returns the set of values encoded as XML.
+         *
+         * @return  a mutable vector of the values
+         */
+        std::vector<std::string>& getValues() {
+            return m_values;
+        }
+
+        /**
+         * Returns the set of values encoded as XML.
+         *
+         * @return  an immutable vector of the values
+         */
+        const std::vector<std::string>& getValues() const {
+            return m_values;
+        }
+
+        size_t valueCount() const {
+            return m_values.size();
+        }
+
+        void clearSerializedValues() {
+            m_serialized.clear();
+        }
+
+        const char* getString(size_t index) const {
+            return m_values[index].c_str();
+        }
+
+        void removeValue(size_t index) {
+            Attribute::removeValue(index);
+            if (index < m_values.size())
+                m_values.erase(m_values.begin() + index);
+        }
+
+        const std::vector<std::string>& getSerializedValues() const;
+
+        DDF marshall() const {
+            DDF ddf = Attribute::marshall();
+            ddf.name("XML");
+            DDF vlist = ddf.first();
+            for (std::vector<std::string>::const_iterator i=m_values.begin(); i!=m_values.end(); ++i)
+                vlist.add(DDF(NULL).string(i->c_str()));
+            return ddf;
+        }
+
+    private:
+        std::vector<std::string> m_values;
+    };
+
+};
+
+#endif /* __shibsp_xmlattr_h__ */