2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file shibsp/attribute/Attribute.h
20 * A resolved attribute.
23 #ifndef __shibsp_attribute_h__
24 #define __shibsp_attribute_h__
26 #include <shibsp/exceptions.h>
27 #include <shibsp/remoting/ddf.h>
35 #if defined (_MSC_VER)
36 #pragma warning( push )
37 #pragma warning( disable : 4251 )
41 * A resolved attribute.
43 * <p>Resolved attributes are a neutral construct that represent both simple and
44 * complex attribute data structures that might be found in SAML assertions
45 * or obtained from other sources.
47 * <p>Attributes consist of an id/name that is locally unique (that is, unique to a
48 * configuration at any given point in time) and zero or more values. Values can
49 * be of any type or structure, but will generally be made available to applications
50 * only if a serialized string form exists. More complex values can be used with
51 * access control plugins that understand them, however.
53 class SHIBSP_API Attribute
55 MAKE_NONCOPYABLE(Attribute);
60 * @param id Attribute identifier
62 Attribute(const char* id) : m_id(id ? id : "") {
66 * Constructs based on a remoted Attribute.
68 * <p>This allows Attribute objects to be recreated after marshalling.
69 * The DDF supplied must be a struct containing a single list member named
70 * with the Attribute's "id" and containing the values.
72 * @param in input object containing marshalled Attribute
75 const char* id = in.first().name();
79 throw AttributeException("No id found in marshalled attribute content.");
84 * Maintains a copy of serialized attribute values, when possible.
86 * <p>Implementations should maintain the array when values are added or removed.
88 mutable std::vector<std::string> m_serialized;
91 virtual ~Attribute() {}
94 * Returns the Attribute identifier.
96 * @return Attribute identifier
98 const char* getId() const {
103 * Indicates whether case sensitivity should apply to basic value comparisons.
105 * @return true iff value comparisons should be case sensitive
107 virtual bool isCaseSensitive() const {
112 * Returns the number of values.
114 * @return number of values
116 virtual size_t valueCount() const {
117 return m_serialized.size();
121 * Returns serialized Attribute values encoded as UTF-8 strings.
123 * @return an immutable vector of values
125 virtual const std::vector<std::string>& getSerializedValues() const {
130 * Informs the Attribute that values have changed and any serializations
133 virtual void clearSerializedValues()=0;
136 * Marshalls an Attribute for remoting.
138 * <p>This allows Attribute objects to be communicated across process boundaries
139 * without excess XML parsing. The DDF returned must be a struct containing
140 * a single list member named with the Attribute's "id". The name of the struct
141 * should contain the registered name of the Attribute implementation.
143 virtual DDF marshall() const {
145 ddf.structure().addmember(m_id.c_str()).list();
150 * Unmarshalls a remoted Attribute.
152 * @param in remoted Attribute data
153 * @return a resolved Attribute of the proper subclass
155 static Attribute* unmarshall(DDF& in);
157 /** A function that unmarshalls remoted data into the proper Attribute subclass. */
158 typedef Attribute* AttributeFactory(DDF& in);
161 * Registers an AttributeFactory function for a given attribute "type".
163 * @param type string used at the root of remoted Attribute structures
164 * @param factory factory function
166 static void registerFactory(const char* type, AttributeFactory* factory) {
167 m_factoryMap[type] = factory;
171 * Deregisters an AttributeFactory function for a given attribute "type".
173 * @param type string used at the root of remoted Attribute structures
175 static void deregisterFactory(const char* type) {
176 m_factoryMap.erase(type);
180 * Clears the map of factories.
182 static void deregisterFactories() {
183 m_factoryMap.clear();
187 static std::map<std::string,AttributeFactory*> m_factoryMap;
191 #if defined (_MSC_VER)
192 #pragma warning( pop )
195 /** Registers built-in Attribute types into the runtime. */
196 void registerAttributeFactories();
200 #endif /* __shibsp_attribute_h__ */