shibsp/attribute/filtering/AttributeFilter.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file shibsp/attribute/filtering/AttributeFilter.h
  19  *
  20  * Engine for filtering attribute values.
  21  */
  22
  23 #ifndef __shibsp_attrfilt_h__
  24 #define __shibsp_attrfilt_h__
  25
  26 #include <shibsp/attribute/filtering/FilteringContext.h>
  27
  28 #include <xmltooling/Lockable.h>
  29
  30 namespace shibsp {
  31
  32     /**
  33      * Engine for filtering attribute values.
  34      */
  35     class SHIBSP_API AttributeFilter : public virtual xmltooling::Lockable
  36     {
  37         MAKE_NONCOPYABLE(AttributeFilter);
  38     protected:
  39         AttributeFilter() {}
  40     public:
  41         virtual ~AttributeFilter() {}
  42
  43         /**
  44          * Filters values out of a set of attributes.
  45          *
  46          * @param context       a FilteringContext interface
  47          * @param attributes    a mutable map containing the attributes to filter
  48          *
  49          * @throws AttributeFileringException thrown if there is a problem filtering attributes
  50          */
  51         virtual void filterAttributes(const FilteringContext& context, std::multimap<std::string,Attribute*>& attributes) const=0;
  52     };
  53
  54     /**
  55      * Registers AttributeFilter classes into the runtime.
  56      */
  57     void SHIBSP_API registerAttributeFilters();
  58
  59     /** AttributeFilter based on an XML mapping schema. */
  60     #define XML_ATTRIBUTE_FILTER "XML"
  61
  62     /** AttributeFilter based on chaining together other filters. */
  63     #define CHAINING_ATTRIBUTE_FILTER "Chaining"
  64 };
  65
  66 #endif /* __shibsp_attrfilt_h__ */