Change license header, remove stale pkg files.

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

diff --git a/saml/binding/MessageDecoder.h b/saml/binding/MessageDecoder.h
index 0b37017..d93c7c9 100644 (file)
--- a/saml/binding/MessageDecoder.h
+++ b/saml/binding/MessageDecoder.h
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2009 Internet2
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
@@ -25,6 +29,9 @@
 
 #include <saml/base.h>
 
+#include <vector>
+#include <xercesc/util/XMLUniDefs.hpp>
+
 namespace xmltooling {
     class XMLTOOL_API GenericRequest;
     class XMLTOOL_API XMLObject;
@@ -55,7 +62,14 @@ namespace opensaml {
     {
         MAKE_NONCOPYABLE(MessageDecoder);
     public:
-        virtual ~MessageDecoder() {}
+        virtual ~MessageDecoder();
+
+        /**
+         * Returns identifier for the protocol family associated with the decoder.
+         *
+         * @return  a protocol family identifier, or nullptr
+         */
+        virtual const XMLCh* getProtocolFamily() const;
 
         /**
          * Indicates whether a web browser or similar user agent delivered the message.
@@ -78,10 +92,10 @@ namespace opensaml {
         class SAML_API ArtifactResolver {
             MAKE_NONCOPYABLE(ArtifactResolver);
         protected:
-            ArtifactResolver() {}
+            ArtifactResolver();
 
         public:
-            virtual ~ArtifactResolver() {}
+            virtual ~ArtifactResolver();
 
             /**
              * Resolves one or more SAML 1.x artifacts into a response containing a set of
@@ -109,7 +123,7 @@ namespace opensaml {
              * @param artifact          reference to a SAML 2.0 artifact
              * @param ssoDescriptor     reference to SSO role of artifact issuer (may be SP or IdP)
              * @param policy            reference to policy containing rules, MetadataProvider, TrustEngine, etc.
-             * @return the corresponding SAML protocol message or NULL
+             * @return the corresponding SAML protocol message or nullptr
              */
             virtual saml2p::ArtifactResponse* resolve(
                 const saml2p::SAML2Artifact& artifact,
@@ -133,14 +147,12 @@ namespace opensaml {
          *
          * @param artifactResolver   an ArtifactResolver implementation to use
          */
-        void setArtifactResolver(const ArtifactResolver* artifactResolver) {
-            m_artifactResolver = artifactResolver;
-        }
+        void setArtifactResolver(const ArtifactResolver* artifactResolver);
 
         /**
          * 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.
+         * the information necessary to decode the request, nullptr will be returned.
          * Errors during the decoding process will be raised as exceptions.
          *
          * <p>Artifact-based bindings require an ArtifactResolver be set to
@@ -149,7 +161,7 @@ namespace opensaml {
          * @param relayState        will be set to RelayState/TARGET value accompanying message
          * @param genericRequest    reference to interface for accessing transport request to decode
          * @param policy            reference to policy containing rules, MetadataProvider, TrustEngine, etc.
-         * @return  the decoded message, or NULL if the decoder did not recognize the request content
+         * @return  the decoded message, or nullptr if the decoder did not recognize the request content
          */
         virtual xmltooling::XMLObject* decode(
             std::string& relayState,
@@ -158,7 +170,7 @@ namespace opensaml {
             ) const=0;
 
     protected:
-        MessageDecoder() : m_artifactResolver(NULL) {}
+        MessageDecoder();
 
         /** Pointer to an ArtifactResolver implementation. */
         const ArtifactResolver* m_artifactResolver;