shibsp/attribute/filtering/AttributeFilter.h

   1 /*
   2  *  Copyright 2001-2010 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/base.h>
  27
  28 #include <vector>
  29 #include <xmltooling/Lockable.h>
  30
  31 namespace shibsp {
  32
  33     class SHIBSP_API Attribute;
  34     class SHIBSP_API FilteringContext;
  35
  36     /**
  37      * Engine for filtering attribute values.
  38      */
  39     class SHIBSP_API AttributeFilter : public virtual xmltooling::Lockable
  40     {
  41         MAKE_NONCOPYABLE(AttributeFilter);
  42     protected:
  43         AttributeFilter();
  44     public:
  45         virtual ~AttributeFilter();
  46
  47         /**
  48          * Filters values out of a set of attributes.
  49          *
  50          * @param context       a FilteringContext interface
  51          * @param attributes    a mutable array containing the attributes to filter
  52          *
  53          * @throws AttributeFileringException thrown if there is a problem filtering attributes
  54          */
  55         virtual void filterAttributes(const FilteringContext& context, std::vector<Attribute*>& attributes) const=0;
  56     };
  57
  58     /**
  59      * Registers AttributeFilter classes into the runtime.
  60      */
  61     void SHIBSP_API registerAttributeFilters();
  62
  63     /** AttributeFilter based on an XML mapping schema. */
  64     #define XML_ATTRIBUTE_FILTER "XML"
  65
  66     /** AttributeFilter based on rejecting/blocking all attributes. */
  67     #define DUMMY_ATTRIBUTE_FILTER "Dummy"
  68
  69     /** AttributeFilter based on chaining together other filters. */
  70     #define CHAINING_ATTRIBUTE_FILTER "Chaining"
  71 };
  72
  73 #endif /* __shibsp_attrfilt_h__ */