Add shorthand methods for obtaining properties using standard precedence rules.

[shibboleth/sp.git] / shibsp / AbstractSPRequest.h

diff --git a/shibsp/AbstractSPRequest.h b/shibsp/AbstractSPRequest.h
index 3dc1c68..318f68c 100644 (file)
--- a/shibsp/AbstractSPRequest.h
+++ b/shibsp/AbstractSPRequest.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2007 Internet2
+ *  Copyright 2001-2009 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,18 +17,18 @@
 /**
  * @file shibsp/AbstractSPRequest.h
  * 
- * Abstract base for SPRequest implementations  
+ * Abstract base for SPRequest implementations.
  */
 
 #ifndef __shibsp_abstreq_h__
 #define __shibsp_abstreq_h__
 
-#include <shibsp/exceptions.h>
 #include <shibsp/SPRequest.h>
-#include <shibsp/util/CGIParser.h>
 
 namespace shibsp {
     
+    class SHIBSP_API CGIParser;
+
 #if defined (_MSC_VER)
     #pragma warning( push )
     #pragma warning( disable : 4251 )
@@ -40,33 +40,36 @@ namespace shibsp {
     class SHIBSP_API AbstractSPRequest : public virtual SPRequest
     {
     protected:
-        AbstractSPRequest();
+        /**
+         * Constructor.
+         *
+         * @param category  logging category to use
+         */
+        AbstractSPRequest(const char* category);
         
+        /**
+         * Stores a normalized request URI to ensure it contains no %-encoded characters
+         * or other undesirable artifacts.
+         *
+         * @param uri   the request URI as obtained from the client
+         */
+        void setRequestURI(const char* uri);
+
     public:
         virtual ~AbstractSPRequest();
 
-        const ServiceProvider& getServiceProvider() const {
-            return *m_sp;
-        }
-
+        // Virtual function overrides.
+        const ServiceProvider& getServiceProvider() const;
         RequestMapper::Settings getRequestSettings() const;
-
         const Application& getApplication() const;
-        
-        Session* getSession(bool checkTimeout=true) const;
-
+        Session* getSession(bool checkTimeout=true, bool ignoreAddress=false, bool cache=true);
+        const char* getRequestURI() const;
         const char* getRequestURL() const;
-        
+        std::string getRemoteAddr() const;
         const char* getParameter(const char* name) const;
-
         std::vector<const char*>::size_type getParameters(const char* name, std::vector<const char*>& values) const;
-
-        const char* getCookie(const char* name) const;
-
         const char* getHandlerURL(const char* resource=NULL) const;
-
         void log(SPLogLevel level, const std::string& msg) const;
-
         bool isPriorityEnabled(SPLogLevel level) const;
 
     private:
@@ -76,10 +79,10 @@ namespace shibsp {
         mutable const Application* m_app;
         mutable bool m_sessionTried;
         mutable Session* m_session;
+        std::string m_uri;
         mutable std::string m_url;
         void* m_log; // declared void* to avoid log4cpp header conflicts in Apache
         mutable std::string m_handlerURL;
-        mutable std::map<std::string,std::string> m_cookieMap;
         mutable CGIParser* m_parser;
     };