2 * Copyright 2001-2009 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/filtering/AttributeFilter.h
20 * Engine for filtering attribute values.
23 #ifndef __shibsp_attrfilt_h__
24 #define __shibsp_attrfilt_h__
26 #include <shibsp/base.h>
29 #include <xmltooling/Lockable.h>
33 class SHIBSP_API Attribute;
34 class SHIBSP_API FilteringContext;
37 * Engine for filtering attribute values.
39 class SHIBSP_API AttributeFilter : public virtual xmltooling::Lockable
41 MAKE_NONCOPYABLE(AttributeFilter);
45 virtual ~AttributeFilter();
48 * Filters values out of a set of attributes.
50 * @param context a FilteringContext interface
51 * @param attributes a mutable array containing the attributes to filter
53 * @throws AttributeFileringException thrown if there is a problem filtering attributes
55 virtual void filterAttributes(const FilteringContext& context, std::vector<Attribute*>& attributes) const=0;
59 * Registers AttributeFilter classes into the runtime.
61 void SHIBSP_API registerAttributeFilters();
63 /** AttributeFilter based on an XML mapping schema. */
64 #define XML_ATTRIBUTE_FILTER "XML"
66 /** AttributeFilter based on chaining together other filters. */
67 #define CHAINING_ATTRIBUTE_FILTER "Chaining"
70 #endif /* __shibsp_attrfilt_h__ */