Fix parameter name to match doc comment.

[shibboleth/cpp-opensaml.git] / saml / binding / MessageDecoder.h

diff --git a/saml/binding/MessageDecoder.h b/saml/binding/MessageDecoder.h
index ef69d61..9f3905d 100644 (file)
--- a/saml/binding/MessageDecoder.h
+++ b/saml/binding/MessageDecoder.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.
@@ -23,14 +23,13 @@
 #ifndef __saml_decoder_h__
 #define __saml_decoder_h__
 
-#include <saml/binding/GenericRequest.h>
 #include <saml/binding/SecurityPolicy.h>
 #include <xmltooling/XMLObject.h>
+#include <xmltooling/io/GenericRequest.h>
 
 namespace opensaml {
     
     class SAML_API SAMLArtifact;
-    class SAML_API X509TrustEngine;
     namespace saml1p {
         class SAML_API Response;
     };
@@ -55,6 +54,15 @@ namespace opensaml {
         virtual ~MessageDecoder() {}
 
         /**
+         * Indicates whether a web browser or similar user agent delivered the message.
+         *
+         * @return true iff the message was delivered by a user agent
+         */
+        virtual bool isUserAgentPresent() const {
+            return true;
+        }
+
+        /**
          * Interface to caller-supplied artifact resolution mechanism.
          * 
          * Resolving artifacts requires internally performing a SOAP-based
@@ -69,25 +77,11 @@ namespace opensaml {
             MAKE_NONCOPYABLE(ArtifactResolver);
         protected:
             ArtifactResolver() {}
-            
-            /** Flag controlling schema validation. */
-            bool m_validate;
 
         public:
             virtual ~ArtifactResolver() {}
 
             /**
-             * Controls schema validation of incoming XML messages.
-             * This is separate from other forms of programmatic validation of objects,
-             * but can detect a much wider range of syntax errors. 
-             * 
-             * @param validate  true iff the resolver should use a validating XML parser
-             */
-            void setValidating(bool validate=true) {
-                m_validate = validate;
-            }
-            
-            /**
              * Resolves one or more SAML 1.x artifacts into a response containing a set of
              * resolved Assertions. The caller is responsible for the resulting Response.
              * The supplied SecurityPolicy is used to access caller-supplied infrastructure
@@ -129,26 +123,11 @@ namespace opensaml {
          * 
          * @param artifactResolver   an ArtifactResolver implementation to use
          */
-        void setArtifactResolver(ArtifactResolver* artifactResolver) {
+        void setArtifactResolver(const ArtifactResolver* artifactResolver) {
             m_artifactResolver = artifactResolver;
-            if (m_artifactResolver)
-                m_artifactResolver->setValidating(m_validate);
         }
         
         /**
-         * Controls schema validation of incoming XML messages.
-         * This is separate from other forms of programmatic validation of objects,
-         * but can detect a much wider range of syntax errors. 
-         * 
-         * @param validate  true iff the decoder should use a validating XML parser
-         */
-        void setValidating(bool validate=true) {
-            m_validate = validate;
-            if (m_artifactResolver)
-                m_artifactResolver->setValidating(m_validate);
-        }
-
-        /**
          * Decodes a transport request into a SAML protocol message, and evaluates it
          * against a supplied SecurityPolicy. If the transport request does not contain
          * the information necessary to decode the request, NULL will be returned.
@@ -164,18 +143,30 @@ namespace opensaml {
          */
         virtual xmltooling::XMLObject* decode(
             std::string& relayState,
-            const GenericRequest& genericRequest,
+            const xmltooling::GenericRequest& genericRequest,
             SecurityPolicy& policy
             ) const=0;
 
     protected:
-        MessageDecoder() : m_artifactResolver(NULL), m_validate(false) {}
+        MessageDecoder() : m_artifactResolver(NULL) {}
 
         /** Pointer to an ArtifactResolver implementation. */
-        ArtifactResolver* m_artifactResolver;
-        
-        /** Flag controlling schema validation. */
-        bool m_validate;
+        const ArtifactResolver* m_artifactResolver;
+
+        /**
+         * Extracts policy-relevant message details.
+         * 
+         * @param message   the incoming message
+         * @param request   the protocol request
+         * @param protocol  the protocol family in use
+         * @param policy    SecurityPolicy to provide various components and track message data
+         */
+        virtual void extractMessageDetails (
+            const xmltooling::XMLObject& message,
+            const xmltooling::GenericRequest& request,
+            const XMLCh* protocol,
+            SecurityPolicy& policy
+            ) const=0;
     };
 
     /**