shibsp/AbstractSPRequest.h

   1 /*
   2  *  Copyright 2001-2009 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/AbstractSPRequest.h
  19  *
  20  * Abstract base for SPRequest implementations
  21  */
  22
  23 #ifndef __shibsp_abstreq_h__
  24 #define __shibsp_abstreq_h__
  25
  26 #include <shibsp/exceptions.h>
  27 #include <shibsp/SPRequest.h>
  28 #include <shibsp/util/CGIParser.h>
  29
  30 namespace shibsp {
  31
  32 #if defined (_MSC_VER)
  33     #pragma warning( push )
  34     #pragma warning( disable : 4251 )
  35 #endif
  36
  37     /**
  38      * Abstract base for SPRequest implementations
  39      */
  40     class SHIBSP_API AbstractSPRequest : public virtual SPRequest
  41     {
  42     protected:
  43         /**
  44          * Constructor.
  45          *
  46          * @param category  logging category to use
  47          */
  48         AbstractSPRequest(const char* category);
  49
  50         /**
  51          * Stores a normalized request URI to ensure it contains no %-encoded characters
  52          * or other undesirable artifacts, such as ;jsessionid appendage.
  53          *
  54          * @param uri   the request URI as obtained from the client
  55          */
  56         void setRequestURI(const char* uri);
  57
  58     public:
  59         virtual ~AbstractSPRequest();
  60
  61         const ServiceProvider& getServiceProvider() const;
  62         RequestMapper::Settings getRequestSettings() const;
  63         const Application& getApplication() const;
  64         Session* getSession(bool checkTimeout=true, bool ignoreAddress=false, bool cache=true);
  65         const char* getRequestURI() const;
  66         const char* getRequestURL() const;
  67         std::string getRemoteAddr() const;
  68         const char* getParameter(const char* name) const;
  69         std::vector<const char*>::size_type getParameters(const char* name, std::vector<const char*>& values) const;
  70         const char* getHandlerURL(const char* resource=NULL) const;
  71         void log(SPLogLevel level, const std::string& msg) const;
  72         bool isPriorityEnabled(SPLogLevel level) const;
  73
  74     private:
  75         ServiceProvider* m_sp;
  76         mutable RequestMapper* m_mapper;
  77         mutable RequestMapper::Settings m_settings;
  78         mutable const Application* m_app;
  79         mutable bool m_sessionTried;
  80         mutable Session* m_session;
  81         std::string m_uri;
  82         mutable std::string m_url;
  83         void* m_log; // declared void* to avoid log4cpp header conflicts in Apache
  84         mutable std::string m_handlerURL;
  85         mutable CGIParser* m_parser;
  86     };
  87
  88 #if defined (_MSC_VER)
  89     #pragma warning( pop )
  90 #endif
  91
  92 };
  93
  94 #endif /* __shibsp_abstreq_h__ */