Imported Upstream version 2.4+dfsg

[shibboleth/sp.git] / shibsp / attribute / resolver / AttributeExtractor.h

diff --git a/shibsp/attribute/resolver/AttributeExtractor.h b/shibsp/attribute/resolver/AttributeExtractor.h
index a0b0a14..b756c5d 100644 (file)
--- a/shibsp/attribute/resolver/AttributeExtractor.h
+++ b/shibsp/attribute/resolver/AttributeExtractor.h
@@ -1,6 +1,6 @@
 /*
- *  Copyright 2001-2007 Internet2
- * 
+ *  Copyright 2001-2010 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
@@ -16,7 +16,7 @@
 
 /**
  * @file shibsp/attribute/resolver/AttributeExtractor.h
- * 
+ *
  * A service that extracts and decodes attributes from XML objects.
  */
 
@@ -24,8 +24,21 @@
 #define __shibsp_extractor_h__
 
 #include <shibsp/base.h>
+
+#include <string>
+#include <vector>
 #include <xmltooling/Lockable.h>
-#include <saml/saml2/metadata/Metadata.h>
+
+namespace xmltooling {
+    class XMLTOOL_API XMLObject;
+};
+
+namespace opensaml {
+    namespace saml2md {
+        class SAML_API RoleDescriptor;
+        class SAML_API SPSSODescriptor;
+    };
+};
 
 namespace shibsp {
 
@@ -39,18 +52,18 @@ namespace shibsp {
     {
         MAKE_NONCOPYABLE(AttributeExtractor);
     protected:
-        AttributeExtractor() {}
+        AttributeExtractor();
     public:
-        virtual ~AttributeExtractor() {}
+        virtual ~AttributeExtractor();
 
         /**
          * Extracts the attributes found in an XMLObject.
-         * 
+         *
          * @param application   Application performing the extraction
          * @param issuer        source of object, if known
          * @param xmlObject     object to extract
          * @param attributes    an array to populate with the extracted attributes
-         * 
+         *
          * @throws AttributeExtractionException thrown if there is a problem extracting attributes
          */
         virtual void extractAttributes(
@@ -66,6 +79,16 @@ namespace shibsp {
          * @param attributes    array to populate
          */
         virtual void getAttributeIds(std::vector<std::string>& attributes) const=0;
+
+        /**
+         * Generates and/or modifies metadata reflecting the extractor,
+         * typically attribute-related requirements.
+         *
+         * <p>The default implementation does nothing.
+         *
+         * @param role          metadata role to decorate
+         */
+        virtual void generateMetadata(opensaml::saml2md::SPSSODescriptor& role) const;
     };
 
     /**
@@ -76,6 +99,12 @@ namespace shibsp {
     /** AttributeExtractor based on an XML mapping schema. */
     #define XML_ATTRIBUTE_EXTRACTOR "XML"
 
+    /** AttributeExtractor for DelegationRestriction information. */
+    #define DELEGATION_ATTRIBUTE_EXTRACTOR "Delegation"
+
+    /** AttributeExtractor for KeyInfo information. */
+    #define KEYDESCRIPTOR_ATTRIBUTE_EXTRACTOR "KeyDescriptor"
+
     /** AttributeExtractor based on chaining together other extractors. */
     #define CHAINING_ATTRIBUTE_EXTRACTOR "Chaining"
 };