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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file shibsp/attribute/ScopedAttribute.h
24 * An Attribute whose values are relations of a value and a scope.
27 #ifndef __shibsp_scopedattr_h__
28 #define __shibsp_scopedattr_h__
30 #include <shibsp/attribute/Attribute.h>
34 #if defined (_MSC_VER)
35 #pragma warning( push )
36 #pragma warning( disable : 4251 )
40 * An Attribute whose values are relations of a value and a scope.
42 * <p>In practice, scoped attributes are simple pairs of strings instead
43 * of a single string. They can be expressed as a string easily using a delimeter,
44 * typically an '@' symbol. The scope concept allows certain kinds of filtering to
45 * be performed more intelligently and efficiently, although not all scoped
46 * attributes can be effectively filtered (e.g. if the set of scope values is
49 class SHIBSP_API ScopedAttribute : public Attribute
55 * @param ids array with primary identifier in first position, followed by any aliases
56 * @param delimeter value/scope delimeter when serializing
58 ScopedAttribute(const std::vector<std::string>& ids, char delimeter='@');
61 * Constructs based on a remoted ScopedAttribute.
63 * @param in input object containing marshalled ScopedAttribute
65 ScopedAttribute(DDF& in);
67 virtual ~ScopedAttribute();
70 * Returns the set of values encoded as UTF-8 strings.
72 * <p>Each compound value is a pair containing the simple value and the scope.
74 * @return a mutable vector of the values
76 std::vector< std::pair<std::string,std::string> >& getValues();
79 * Returns the set of values encoded as UTF-8 strings.
81 * <p>Each compound value is a pair containing the simple value and the scope.
83 * @return an immutable vector of the values
85 const std::vector< std::pair<std::string,std::string> >& getValues() const;
87 // Virtual function overrides.
88 size_t valueCount() const;
89 void clearSerializedValues();
90 const char* getString(size_t index) const;
91 const char* getScope(size_t index) const;
92 void removeValue(size_t index);
93 const std::vector<std::string>& getSerializedValues() const;
98 std::vector< std::pair<std::string,std::string> > m_values;
101 #if defined (_MSC_VER)
102 #pragma warning( pop )
107 #endif /* __shibsp_scopedattr_h__ */