shibsp/RequestMapper.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/RequestMapper.h
  23  *
  24  * Interface to a request mapping plugin
  25  */
  26
  27 #ifndef __shibsp_reqmap_h__
  28 #define __shibsp_reqmap_h__
  29
  30 #include <shibsp/base.h>
  31 #include <xmltooling/Lockable.h>
  32
  33 namespace xmltooling {
  34     class XMLTOOL_API HTTPRequest;
  35 };
  36
  37 namespace shibsp {
  38
  39     class SHIBSP_API AccessControl;
  40     class SHIBSP_API PropertySet;
  41
  42     /**
  43      * Interface to a request mapping plugin
  44      *
  45      * Request mapping plugins return configuration settings that apply to resource requests.
  46      * They can be implemented through cross-platform or platform-specific mechanisms.
  47      */
  48     class SHIBSP_API RequestMapper : public virtual xmltooling::Lockable
  49     {
  50         MAKE_NONCOPYABLE(RequestMapper);
  51     protected:
  52         RequestMapper();
  53     public:
  54         virtual ~RequestMapper();
  55
  56         /** Combination of configuration settings and effective access control. */
  57         typedef std::pair<const PropertySet*,AccessControl*> Settings;
  58
  59         /**
  60          * Map request to settings.
  61          *
  62          * @param request   SP request
  63          * @return configuration settings and effective AccessControl plugin, if any
  64          */
  65         virtual Settings getSettings(const xmltooling::HTTPRequest& request) const=0;
  66     };
  67
  68     /**
  69      * Registers RequestMapper classes into the runtime.
  70      */
  71     void SHIBSP_API registerRequestMappers();
  72
  73     /** XML-based RequestMapper implementation. */
  74     #define XML_REQUEST_MAPPER      "XML"
  75
  76     /** Hybrid of XML and platform-specific configuration. */
  77     #define NATIVE_REQUEST_MAPPER   "Native"
  78 };
  79
  80 #endif /* __shibsp_reqmap_h__ */