shibsp/attribute/resolver/AttributeExtractor.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/attribute/resolver/AttributeExtractor.h
  19  *
  20  * A service that extracts and decodes attributes from XML objects.
  21  */
  22
  23 #ifndef __shibsp_extractor_h__
  24 #define __shibsp_extractor_h__
  25
  26 #include <shibsp/base.h>
  27
  28 #include <string>
  29 #include <vector>
  30 #include <xmltooling/Lockable.h>
  31
  32 namespace xmltooling {
  33     class XMLTOOL_API XMLObject;
  34 };
  35
  36 namespace opensaml {
  37     namespace saml2md {
  38         class SAML_API RoleDescriptor;
  39     };
  40 };
  41
  42 namespace shibsp {
  43
  44     class SHIBSP_API Application;
  45     class SHIBSP_API Attribute;
  46
  47     /**
  48      * A service that extracts and decodes attributes from XML objects.
  49      */
  50     class SHIBSP_API AttributeExtractor : public virtual xmltooling::Lockable
  51     {
  52         MAKE_NONCOPYABLE(AttributeExtractor);
  53     protected:
  54         AttributeExtractor();
  55     public:
  56         virtual ~AttributeExtractor();
  57
  58         /**
  59          * Extracts the attributes found in an XMLObject.
  60          *
  61          * @param application   Application performing the extraction
  62          * @param issuer        source of object, if known
  63          * @param xmlObject     object to extract
  64          * @param attributes    an array to populate with the extracted attributes
  65          *
  66          * @throws AttributeExtractionException thrown if there is a problem extracting attributes
  67          */
  68         virtual void extractAttributes(
  69             const Application& application,
  70             const opensaml::saml2md::RoleDescriptor* issuer,
  71             const xmltooling::XMLObject& xmlObject,
  72             std::vector<Attribute*>& attributes
  73             ) const=0;
  74
  75         /**
  76          * Populates an array with the set of Attribute IDs that might be generated.
  77          *
  78          * @param attributes    array to populate
  79          */
  80         virtual void getAttributeIds(std::vector<std::string>& attributes) const=0;
  81     };
  82
  83     /**
  84      * Registers AttributeExtractor classes into the runtime.
  85      */
  86     void SHIBSP_API registerAttributeExtractors();
  87
  88     /** AttributeExtractor based on an XML mapping schema. */
  89     #define XML_ATTRIBUTE_EXTRACTOR "XML"
  90
  91     /** AttributeExtractor for DelegationRestriction information. */
  92     #define DELEGATION_ATTRIBUTE_EXTRACTOR "Delegation"
  93
  94     /** AttributeExtractor for KeyInfo information. */
  95     #define KEYDESCRIPTOR_ATTRIBUTE_EXTRACTOR "KeyDescriptor"
  96
  97     /** AttributeExtractor based on chaining together other extractors. */
  98     #define CHAINING_ATTRIBUTE_EXTRACTOR "Chaining"
  99 };
 100
 101 #endif /* __shibsp_extractor_h__ */