Improve logging around XML processing of content.

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

diff --git a/shibsp/Application.h b/shibsp/Application.h
index cfd38e7..9669a3b 100644 (file)
--- a/shibsp/Application.h
+++ b/shibsp/Application.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2009 Internet2
+ *  Copyright 2001-2010 Internet2
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,15 +25,28 @@
 
 #include <shibsp/util/PropertySet.h>
 
-#include <set>
+#include <string>
+#include <vector>
 #ifndef SHIBSP_LITE
 # include <saml/binding/MessageEncoder.h>
-# include <saml/saml2/metadata/MetadataProvider.h>
-# include <xmltooling/security/CredentialResolver.h>
-# include <xmltooling/security/TrustEngine.h>
 #endif
-#include <xmltooling/io/HTTPRequest.h>
-#include <xmltooling/util/Threads.h>
+
+namespace xmltooling {
+    class XMLTOOL_API CredentialResolver;
+    class XMLTOOL_API RWLock;
+    class XMLTOOL_API SOAPTransport;
+    class XMLTOOL_API StorageService;
+    class XMLTOOL_API TrustEngine;
+};
+
+#ifndef SHIBSP_LITE
+namespace opensaml {
+    class SAML_API SecurityPolicyRule;
+    namespace saml2md {
+        class SAML_API MetadataProvider;
+    };
+};
+#endif
 
 namespace shibsp {
 
@@ -90,18 +103,14 @@ namespace shibsp {
          *
          * @return a locked ServiceProvider
          */
-        const ServiceProvider& getServiceProvider() const {
-            return *m_sp;
-        }
+        const ServiceProvider& getServiceProvider() const;
 
         /**
          * Returns the Application's ID.
          *
          * @return  the ID
          */
-        virtual const char* getId() const {
-            return getString("id").second;
-        }
+        virtual const char* getId() const;
 
         /**
          * Returns a unique hash for the Application.
@@ -117,14 +126,14 @@ namespace shibsp {
          * @param lifetime  if non-null, will be populated with a suggested lifetime for the cookie, or 0 if session-bound
          * @return  a pair containing the cookie name and the string to append to the cookie value
          */
-        virtual std::pair<std::string,const char*> getCookieNameProps(const char* prefix, time_t* lifetime=NULL) const;
+        virtual std::pair<std::string,const char*> getCookieNameProps(const char* prefix, time_t* lifetime=nullptr) const;
 
 #ifndef SHIBSP_LITE
         /**
          * Returns a MetadataProvider for use with this Application.
          *
          * @param required  true iff an exception should be thrown if no MetadataProvider is available
-         * @return  a MetadataProvider instance, or NULL
+         * @return  a MetadataProvider instance, or nullptr
          */
         virtual opensaml::saml2md::MetadataProvider* getMetadataProvider(bool required=true) const=0;
 
@@ -132,35 +141,35 @@ namespace shibsp {
          * Returns a TrustEngine for use with this Application.
          *
          * @param required  true iff an exception should be thrown if no TrustEngine is available
-         * @return  a TrustEngine instance, or NULL
+         * @return  a TrustEngine instance, or nullptr
          */
         virtual xmltooling::TrustEngine* getTrustEngine(bool required=true) const=0;
 
         /**
          * Returns an AttributeExtractor for use with this Application.
          *
-         * @return  an AttributeExtractor, or NULL
+         * @return  an AttributeExtractor, or nullptr
          */
         virtual AttributeExtractor* getAttributeExtractor() const=0;
 
         /**
          * Returns an AttributeFilter for use with this Application.
          *
-         * @return  an AttributeFilter, or NULL
+         * @return  an AttributeFilter, or nullptr
          */
         virtual AttributeFilter* getAttributeFilter() const=0;
 
         /**
          * Returns an AttributeResolver for use with this Application.
          *
-         * @return  an AttributeResolver, or NULL
+         * @return  an AttributeResolver, or nullptr
          */
         virtual AttributeResolver* getAttributeResolver() const=0;
 
         /**
          * Returns the CredentialResolver instance associated with this Application.
          *
-         * @return  a CredentialResolver, or NULL
+         * @return  a CredentialResolver, or nullptr
          */
         virtual xmltooling::CredentialResolver* getCredentialResolver() const=0;
 
@@ -184,7 +193,7 @@ namespace shibsp {
          * @deprecated
          * Returns any additional audience values associated with this Application.
          *
-         * @return additional audience values associated with the Application, or NULL
+         * @return additional audience values associated with the Application, or nullptr
          */
         virtual const std::vector<const XMLCh*>* getAudiences() const=0;
 #endif
@@ -243,7 +252,7 @@ namespace shibsp {
         /**
          * Returns the default SessionInitiator when automatically requesting a session.
          *
-         * @return the default SessionInitiator, or NULL
+         * @return the default SessionInitiator, or nullptr
          */
         virtual const SessionInitiator* getDefaultSessionInitiator() const=0;
 
@@ -251,7 +260,7 @@ namespace shibsp {
          * Returns a SessionInitiator with a particular ID when automatically requesting a session.
          *
          * @param id    an identifier unique to the Application
-         * @return the designated SessionInitiator, or NULL
+         * @return the designated SessionInitiator, or nullptr
          */
         virtual const SessionInitiator* getSessionInitiatorById(const char* id) const=0;
 
@@ -259,7 +268,7 @@ namespace shibsp {
          * Returns the default AssertionConsumerService Handler
          * for use in AuthnRequest messages.
          *
-         * @return the default AssertionConsumerService, or NULL
+         * @return the default AssertionConsumerService, or nullptr
          */
         virtual const Handler* getDefaultAssertionConsumerService() const=0;
 
@@ -268,7 +277,7 @@ namespace shibsp {
          * for use in AuthnRequest messages.
          *
          * @param index an index unique to an application
-         * @return the designated AssertionConsumerService, or NULL
+         * @return the designated AssertionConsumerService, or nullptr
          */
         virtual const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const=0;
 
@@ -286,7 +295,7 @@ namespace shibsp {
          *
          * @param path  the PATH_INFO appended to the end of a base Handler location
          *              that invokes the Handler
-         * @return the mapped Handler, or NULL
+         * @return the mapped Handler, or nullptr
          */
         virtual const Handler* getHandler(const char* path) const=0;