Draft of query tool, not working yet.

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

diff --git a/shibsp/ServiceProvider.h b/shibsp/ServiceProvider.h
index 5e264b1..d4026fe 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,11 +24,14 @@
 #define __shibsp_sp_h__
 
 #include <shibsp/util/PropertySet.h>
+#include <saml/binding/SecurityPolicyRule.h>
 #include <xmltooling/signature/CredentialResolver.h>
+#include <xmltooling/util/StorageService.h>
 
 namespace shibsp {
 
     class SHIBSP_API Application;
+    class SHIBSP_API Handler;
     class SHIBSP_API ListenerService;
     class SHIBSP_API RequestMapper;
     class SHIBSP_API SessionCache;
@@ -42,7 +45,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:
@@ -65,7 +68,15 @@ namespace shibsp {
          * @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;
+
         /**
          * Returns a SessionCache instance.
          * 
@@ -91,6 +102,14 @@ namespace shibsp {
         virtual xmlsignature::CredentialResolver* getCredentialResolver(const char* id) const=0;
 
         /**
+                * Returns the security policy rules for an identified policy.
+         *
+                * @param id    identifies the policy rules to return, or NULL for the default policy
+         * @return an array of policy rules
+                */
+               virtual std::vector<const opensaml::SecurityPolicyRule*>& getPolicyRules(const char* id=NULL) const=0;
+
+        /**
          * Returns a RequestMapper instance.
          * 
          * @param required  true iff an exception should be thrown if no RequestMapper is available
@@ -98,8 +117,6 @@ namespace shibsp {
          */
         virtual RequestMapper* getRequestMapper(bool required=true) const=0;
         
-        //virtual ISessionCache* getSessionCache() const=0;
-        
         /**
          * Returns an Application instance matching the specified ID.
          * 
@@ -161,7 +178,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__ */