shibsp/attribute/filtering/FilterPolicyContext.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/FilterPolicyContext.h
  19  *
  20  * Context for lookup of instantiated MatchFunctor objects.
  21  */
  22
  23 #ifndef __shibsp_filtpolctx_h__
  24 #define __shibsp_filtpolctx_h__
  25
  26 #include <shibsp/attribute/filtering/MatchFunctor.h>
  27
  28 #include <map>
  29 #include <string>
  30
  31 namespace shibsp {
  32
  33     /**
  34      * Context for lookup of instantiated MatchFunctor objects.
  35      */
  36     class SHIBSP_API FilterPolicyContext
  37     {
  38         MAKE_NONCOPYABLE(FilterPolicyContext);
  39     public:
  40         /**
  41          * Constructor.
  42          *
  43          * @param functors  reference to a map of id/functor pairs
  44          */
  45         FilterPolicyContext(std::multimap<std::string,MatchFunctor*>& functors) : m_functors(functors) {
  46         }
  47
  48         virtual ~FilterPolicyContext() {}
  49
  50         /**
  51          * Gets a mutable map to store id/functor pairs.
  52          *
  53          * <p>When storing new instances, use an empty string for unnamed objects.
  54          *
  55          * @return  reference to a mutable map containing available MatchFunctors
  56          */
  57         std::multimap<std::string,MatchFunctor*>& getMatchFunctors() const {
  58             return m_functors;
  59         }
  60
  61     private:
  62         std::multimap<std::string,MatchFunctor*>& m_functors;
  63     };
  64
  65 };
  66
  67 #endif /* __shibsp_filtpolctx_h__ */