https://issues.shibboleth.net/jira/browse/CPPXT-90

[shibboleth/cpp-xmltooling.git] / xmltooling / security / CredentialResolver.h

diff --git a/xmltooling/security/CredentialResolver.h b/xmltooling/security/CredentialResolver.h
index 68d675f..89be8c2 100644 (file)
--- a/xmltooling/security/CredentialResolver.h
+++ b/xmltooling/security/CredentialResolver.h
@@ -1,17 +1,21 @@
-/*
- *  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.
- * 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.
+ *
+ * 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.
  */
 
 /**
@@ -37,18 +41,18 @@ namespace xmltooling {
     {
         MAKE_NONCOPYABLE(CredentialResolver);
     protected:
-        CredentialResolver() {}
+        CredentialResolver();
         
     public:
-        virtual ~CredentialResolver() {}
+        virtual ~CredentialResolver();
         
         /**
          * Returns a single Credential according to the supplied criteria.
          * 
          * @param criteria   an optional CredentialCriteria object 
-         * @return  a Credential, or NULL if none could be found
+         * @return  a Credential, or nullptr if none could be found
          */
-        virtual const Credential* resolve(const CredentialCriteria* criteria=NULL) const=0;
+        virtual const Credential* resolve(const CredentialCriteria* criteria=nullptr) const=0;
 
         /**
          * Returns all matching Credentials according to the supplied criteria.
@@ -58,7 +62,7 @@ namespace xmltooling {
          * @return  number of credentials found
          */
         virtual std::vector<const Credential*>::size_type resolve(
-            std::vector<const Credential*>& results, const CredentialCriteria* criteria=NULL
+            std::vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr
             ) const=0;
     };
 
@@ -69,6 +73,12 @@ namespace xmltooling {
 
     /** CredentialResolver based on local files with no criteria support. */
     #define FILESYSTEM_CREDENTIAL_RESOLVER  "File"
+
+    /** CredentialResolver that returns nothing, for use with some APIs. */
+    #define DUMMY_CREDENTIAL_RESOLVER  "Dummy"
+
+    /** CredentialResolver based on chaining together other resolvers. */
+    #define CHAINING_CREDENTIAL_RESOLVER    "Chaining"
 };
 
 #endif /* __xmltooling_credres_h__ */