Change license header, remove stale pkg files.
[shibboleth/cpp-opensaml.git] / saml / saml2 / profile / SAML2AssertionPolicy.h
index 271d7e9..7b4cf0c 100644 (file)
@@ -1,17 +1,21 @@
-/*
- *  Copyright 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.
  */
 
 /**
@@ -34,62 +38,54 @@ namespace opensaml {
 
     namespace saml2 {
         class SAML_API SubjectConfirmation;
-    };
 
-    /**
-     * Policy subclass to track SAML 2.0 Assertion SubjectConfirmation.
-     */
-    class SAML_API SAML2AssertionPolicy : virtual public SecurityPolicy
-    {
-    public:
         /**
-         * Constructor for policy.
-         *
-         * @param metadataProvider  locked MetadataProvider instance
-         * @param role              identifies the role (generally IdP or SP) of the policy peer
-         * @param trustEngine       TrustEngine to authenticate policy peer
-         * @param validate          true iff XML parsing should be done with validation
+         * Policy subclass to track SAML 2.0 Assertion SubjectConfirmation.
          */
-        SAML2AssertionPolicy(
-            const saml2md::MetadataProvider* metadataProvider=NULL,
-            const xmltooling::QName* role=NULL,
-            const xmltooling::TrustEngine* trustEngine=NULL,
-            bool validate=true
-            ) : SecurityPolicy(metadataProvider, role, trustEngine, validate) {
-        }
+        class SAML_API SAML2AssertionPolicy : virtual public SecurityPolicy
+        {
+        public:
+            /**
+             * Constructor for policy.
+             *
+             * @param metadataProvider  locked MetadataProvider instance
+             * @param role              identifies the role (generally IdP or SP) of the policy peer
+             * @param trustEngine       TrustEngine to authenticate policy peer
+             * @param validate          true iff XML parsing should be done with validation
+             */
+            SAML2AssertionPolicy(
+                const saml2md::MetadataProvider* metadataProvider=nullptr,
+                const xmltooling::QName* role=nullptr,
+                const xmltooling::TrustEngine* trustEngine=nullptr,
+                bool validate=true
+                );
 
-        virtual ~SAML2AssertionPolicy() {}
+            virtual ~SAML2AssertionPolicy();
 
-        virtual void reset(bool messageOnly=false);
-        void _reset(bool messageOnly=false) {
-            m_confirmation = false;
-        }
+            virtual void reset(bool messageOnly=false);
+            void _reset(bool messageOnly=false);
 
-        /**
-         * Returns the subject confirmation that was successfully accepted by the policy.
-         *
-         * @return a successfully evaluated SubjectConfirmation
-         */
-        const saml2::SubjectConfirmation* getSubjectConfirmation() const {
-            return m_confirmation;
-        }
+            /**
+             * Returns the subject confirmation that was successfully accepted by the policy.
+             *
+             * @return a successfully evaluated SubjectConfirmation
+             */
+            const saml2::SubjectConfirmation* getSubjectConfirmation() const;
 
-        /**
-         * Sets the SubjectConfirmation that was successfully accepted by the policy.
-         *
-         * <p>The lifetime of the SubjectConfirmation object <strong>MUST</strong> be longer
-         * than the lifetime of the policy object.
-         *
-         * @param confirmation the successfully evaluated SubjectConfirmation
-         */
-        void setSubjectConfirmation(const saml2::SubjectConfirmation* confirmation) {
-            m_confirmation = confirmation;
-        }
+            /**
+             * Sets the SubjectConfirmation that was successfully accepted by the policy.
+             *
+             * <p>The lifetime of the SubjectConfirmation object <strong>MUST</strong> be longer
+             * than the lifetime of the policy object.
+             *
+             * @param confirmation the successfully evaluated SubjectConfirmation
+             */
+            void setSubjectConfirmation(const saml2::SubjectConfirmation* confirmation);
 
-    private:
-        const saml2::SubjectConfirmation* m_confirmation;
+        private:
+            const saml2::SubjectConfirmation* m_confirmation;
+        };
     };
-
 };
 
 #if defined (_MSC_VER)