Starting to refactor session cache, eliminated IConfig class.

[shibboleth/cpp-sp.git] / shibsp / ServiceProvider.h

diff --git a/shibsp/ServiceProvider.h b/shibsp/ServiceProvider.h
index 3fc4228..b6c55e1 100644 (file)
--- a/shibsp/ServiceProvider.h
+++ b/shibsp/ServiceProvider.h
@@ -23,12 +23,16 @@
 #ifndef __shibsp_sp_h__
 #define __shibsp_sp_h__
 
-#include <shibsp/PropertySet.h>
+#include <shibsp/util/PropertySet.h>
 #include <xmltooling/signature/CredentialResolver.h>
 
 namespace shibsp {
 
-    class ListenerService;
+    class SHIBSP_API Application;
+    class SHIBSP_API ListenerService;
+    class SHIBSP_API RequestMapper;
+    class SHIBSP_API SessionCache;
+    class SHIBSP_API SPRequest;
 
     /**
      * Interface to a Shibboleth ServiceProvider instance.
@@ -54,10 +58,18 @@ namespace shibsp {
         virtual void init()=0;
         
         /**
+         * Returns a SessionCache instance.
+         * 
+         * @param required  true iff an exception should be thrown if no SessionCache is available
+         * @return  a SessionCache
+         */
+        virtual SessionCache* getSessionCache(bool required=true) const=0;
+
+        /**
          * Returns a ListenerService instance.
          * 
          * @param required  true iff an exception should be thrown if no ListenerService is available
-         * @return  a ListenerService if available, or NULL
+         * @return  a ListenerService
          */
         virtual ListenerService* getListenerService(bool required=true) const=0;
         
@@ -69,11 +81,69 @@ namespace shibsp {
          */
         virtual xmlsignature::CredentialResolver* getCredentialResolver(const char* id) const=0;
 
+        /**
+         * Returns a RequestMapper instance.
+         * 
+         * @param required  true iff an exception should be thrown if no RequestMapper is available
+         * @param a RequestMapper
+         */
+        virtual RequestMapper* getRequestMapper(bool required=true) const=0;
+        
         //virtual ISessionCache* getSessionCache() const=0;
         
-        //virtual IRequestMapper* getRequestMapper() const=0;
+        /**
+         * Returns an Application instance matching the specified ID.
+         * 
+         * @param applicationId the ID of the application
+         * @return  pointer to the application, or NULL
+         */
+        virtual const Application* getApplication(const char* applicationId) const=0;
+
+        /**
+         * Enforces requirements for an authenticated session.
+         * 
+         * <p>If the return value's first member is true, then request processing should terminate
+         * with the second member as a status value. If false, processing can continue. 
+         * 
+         * @param request   SP request interface
+         * @param handler   true iff a request to a registered Handler location can be directly executed
+         * @return a pair containing a "request completed" indicator and a server-specific response code
+         */
+        virtual std::pair<bool,long> doAuthentication(SPRequest& request, bool handler=false) const;
+        
+        /**
+         * Enforces authorization requirements based on the authenticated session.
+         * 
+         * <p>If the return value's first member is true, then request processing should terminate
+         * with the second member as a status value. If false, processing can continue. 
+         * 
+         * @param request   SP request interface
+         * @return a pair containing a "request completed" indicator and a server-specific response code
+         */
+        virtual std::pair<bool,long> doAuthorization(SPRequest& request) const;
         
-        //virtual const IApplication* getApplication(const char* applicationId) const=0;
+        /**
+         * Publishes session contents to the request in the form of headers or environment variables.
+         * 
+         * <p>If the return value's first member is true, then request processing should terminate
+         * with the second member as a status value. If false, processing can continue. 
+         * 
+         * @param request   SP request interface
+         * @param requireSession    set to true iff an error should result if no session exists 
+         * @return a pair containing a "request completed" indicator and a server-specific response code
+         */
+        virtual std::pair<bool,long> doExport(SPRequest& request, bool requireSession=true) const;
+
+        /**
+         * Services requests for registered Handler locations. 
+         * 
+         * <p>If the return value's first member is true, then request processing should terminate
+         * with the second member as a status value. If false, processing can continue. 
+         * 
+         * @param request   SP request interface
+         * @return a pair containing a "request completed" indicator and a server-specific response code
+         */
+        virtual std::pair<bool,long> doHandler(SPRequest& request) const;
     };
 
     /**