Update gitignore to account for subdirs / missing files.
[shibboleth/cpp-opensaml.git] / saml / SAMLConfig.h
index 5a40214..b1b3a43 100644 (file)
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2009 Internet2
- * 
- * 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
+/**
+ * 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.
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * 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
  *
- * 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.
+ * 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.
  */
 
 /**
@@ -42,8 +46,12 @@ namespace opensaml {
     class SAML_API SecurityPolicyRule;
 
     namespace saml2md {
+        class SAML_API ContactPerson;
+        class SAML_API EntityDescriptor;
+        class SAML_API EntityMatcher;
         class SAML_API MetadataProvider;
         class SAML_API MetadataFilter;
+        class SAML_API RoleDescriptor;
     };
 
 #if defined (_MSC_VER)
@@ -104,7 +112,7 @@ namespace opensaml {
         /**
          * Returns the global ArtifactMap instance.
          * 
-         * @return  global ArtifactMap or NULL
+         * @return  global ArtifactMap or nullptr
          */
         ArtifactMap* getArtifactMap() const;
 
@@ -143,6 +151,29 @@ namespace opensaml {
          */
         virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
 
+        /**
+         * Sets the order of contact types to use in annotating exceptions with contact information.
+         *
+         * @param contactTypes  whitespace-delimited list of contact types
+         */
+        virtual void setContactPriority(const XMLCh* contactTypes)=0;
+
+        /**
+         * Returns the appropriate contact to use for the entity.
+         *
+         * @param entity    the entity to search
+         * @return  a contact to use, or nullptr
+         */
+        virtual const saml2md::ContactPerson* getContactPerson(const saml2md::EntityDescriptor& entity) const=0;
+
+        /**
+         * Returns the appropriate contact to use for the role.
+         *
+         * @param entity    the role to search
+         * @return  a contact to use, or nullptr
+         */
+        virtual const saml2md::ContactPerson* getContactPerson(const saml2md::RoleDescriptor& role) const=0;
+
         /** Manages factories for MessageDecoder plugins. */
         xmltooling::PluginManager< MessageDecoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageDecoderManager;
 
@@ -161,6 +192,9 @@ namespace opensaml {
         /** Manages factories for MetadataFilter plugins. */
         xmltooling::PluginManager<saml2md::MetadataFilter,std::string,const xercesc::DOMElement*> MetadataFilterManager;
 
+        /** Manages factories for EntityMatcher plugins. */
+        xmltooling::PluginManager<saml2md::EntityMatcher,std::string,const xercesc::DOMElement*> EntityMatcherManager;
+
     protected:
         SAMLConfig();