shibsp/attribute/filtering/AttributeFilter.h

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