Correct location of TransportOption feature, makes no sense inside policies.

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

diff --git a/shibsp/ServiceProvider.h b/shibsp/ServiceProvider.h
index 565b43f..9ef1dae 100644 (file)
--- a/shibsp/ServiceProvider.h
+++ b/shibsp/ServiceProvider.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2006 Internet2
+ *  Copyright 2001-2007 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,15 +24,25 @@
 #define __shibsp_sp_h__
 
 #include <shibsp/util/PropertySet.h>
-#include <xmltooling/signature/CredentialResolver.h>
+#ifndef SHIBSP_LITE
+# include <saml/binding/SecurityPolicyRule.h>
+# include <xmltooling/soap/SOAPTransport.h>
+# include <xmltooling/util/StorageService.h>
+#endif
+#include <xmltooling/Lockable.h>
 
 namespace shibsp {
 
     class SHIBSP_API Application;
+    class SHIBSP_API Handler;
     class SHIBSP_API ListenerService;
     class SHIBSP_API RequestMapper;
     class SHIBSP_API SessionCache;
     class SHIBSP_API SPRequest;
+    class SHIBSP_API TemplateParameters;
+#ifndef SHIBSP_LITE
+    class SHIBSP_API TransactionLog;
+#endif
 
     /**
      * Interface to a Shibboleth ServiceProvider instance.
@@ -40,7 +50,7 @@ namespace shibsp {
      * <p>A ServiceProvider exposes configuration and infrastructure services required
      * by the SP implementation, allowing a flexible configuration format.
      */
-    class SHIBSP_API ServiceProvider : public virtual xmltooling::Lockable, public virtual PropertySet
+       class SHIBSP_API ServiceProvider : public virtual xmltooling::Lockable, public virtual PropertySet
     {
         MAKE_NONCOPYABLE(ServiceProvider);
     protected:
@@ -56,31 +66,73 @@ namespace shibsp {
          * from the SPConfig singleton.
          */
         virtual void init()=0;
-        
+
+#ifndef SHIBSP_LITE
+        /**
+         * Returns a TransactionLog instance.
+         * 
+         * @return  a TransactionLog instance
+         */
+        virtual TransactionLog* getTransactionLog() const=0;
+
+        /**
+         * Returns a StorageService instance based on an ID.
+         * 
+         * @param id    a NULL-terminated key identifying the StorageService to the configuration 
+         * @return  a StorageService if available, or NULL
+         */
+        virtual xmltooling::StorageService* getStorageService(const char* id) const=0;
+#endif
+
+        /**
+         * 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;
         
+#ifndef SHIBSP_LITE
         /**
-         * Returns a CredentialResolver instance mapped to a key.
-         * 
-         * @param id    a NULL-terminated key identifying the CredentialResolver to the configuration 
-         * @return  a CredentialResolver if available, or NULL
+                * Returns the security policy settings for an identified policy.
+         *
+                * @param id    identifies the policy to return
+         * @return a PropertySet
+                */
+        virtual const PropertySet* getPolicySettings(const char* id) const=0;
+
+        /**
+                * Returns the security policy rules for an identified policy.
+         *
+                * @param id    identifies the policy to return
+         * @return an array of policy rules
+                */
+        virtual const std::vector<const opensaml::SecurityPolicyRule*>& getPolicyRules(const char* id) const=0;
+
+        /**
+         * Sets implementation-specific transport options.
+         *
+         * @param transport a SOAPTransport object
+         * @return  true iff all options were successfully set
          */
-        virtual xmlsignature::CredentialResolver* getCredentialResolver(const char* id) const=0;
+        virtual bool setTransportOptions(xmltooling::SOAPTransport& transport) const=0;
+#endif
 
         /**
          * Returns a RequestMapper instance.
          * 
-         * @param a RequestMapper if available, or NULL
+         * @param required  true iff an exception should be thrown if no RequestMapper is available
+         * @return  a RequestMapper
          */
-        virtual RequestMapper* getRequestMapper() const=0;
-        
-        //virtual ISessionCache* getSessionCache() const=0;
+        virtual RequestMapper* getRequestMapper(bool required=true) const=0;
         
         /**
          * Returns an Application instance matching the specified ID.
@@ -143,7 +195,7 @@ namespace shibsp {
     void SHIBSP_API registerServiceProviders();
 
     /** SP based on integrated XML and native server configuration. */
-    #define XML_SERVICE_PROVIDER "edu.internet2.middleware.shibboleth.sp.provider.XMLServiceProvider"
+    #define XML_SERVICE_PROVIDER "XML"
 };
 
 #endif /* __shibsp_sp_h__ */