saml/saml2/metadata/impl/XMLMetadataProvider.cpp

   1 /*
   2  *  Copyright 2001-2007 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  * XMLMetadataProvider.cpp
  19  *
  20  * Supplies metadata from an XML file
  21  */
  22
  23 #include "internal.h"
  24 #include "saml2/metadata/Metadata.h"
  25 #include "saml2/metadata/MetadataFilter.h"
  26 #include "saml2/metadata/AbstractMetadataProvider.h"
  27
  28 #include <xmltooling/util/NDC.h>
  29 #include <xmltooling/util/ReloadableXMLFile.h>
  30
  31 using namespace opensaml::saml2md;
  32 using namespace xmltooling::logging;
  33 using namespace xmltooling;
  34 using namespace std;
  35
  36 #if defined (_MSC_VER)
  37     #pragma warning( push )
  38     #pragma warning( disable : 4250 )
  39 #endif
  40
  41 namespace opensaml {
  42     namespace saml2md {
  43
  44         class SAML_DLLLOCAL XMLMetadataProvider : public AbstractMetadataProvider, public ReloadableXMLFile
  45         {
  46         public:
  47             XMLMetadataProvider(const DOMElement* e)
  48                 : AbstractMetadataProvider(e), ReloadableXMLFile(e, Category::getInstance(SAML_LOGCAT".MetadataProvider.XML")),
  49                     m_object(NULL) {
  50             }
  51             virtual ~XMLMetadataProvider() {
  52                 delete m_object;
  53             }
  54
  55             void init() {
  56                 load(); // guarantees an exception or the metadata is loaded
  57             }
  58
  59             const XMLObject* getMetadata() const {
  60                 return m_object;
  61             }
  62
  63         protected:
  64             pair<bool,DOMElement*> load();
  65
  66         private:
  67             using AbstractMetadataProvider::index;
  68             void index();
  69
  70             XMLObject* m_object;
  71         };
  72
  73         MetadataProvider* SAML_DLLLOCAL XMLMetadataProviderFactory(const DOMElement* const & e)
  74         {
  75             return new XMLMetadataProvider(e);
  76         }
  77
  78     };
  79 };
  80
  81 #if defined (_MSC_VER)
  82     #pragma warning( pop )
  83 #endif
  84
  85 pair<bool,DOMElement*> XMLMetadataProvider::load()
  86 {
  87     // Load from source using base class.
  88     pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
  89
  90     // If we own it, wrap it for now.
  91     XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
  92
  93     // Unmarshall objects, binding the document.
  94     auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(raw.second, true));
  95     docjanitor.release();
  96
  97     if (!dynamic_cast<const EntitiesDescriptor*>(xmlObject.get()) && !dynamic_cast<const EntityDescriptor*>(xmlObject.get()))
  98         throw MetadataException(
  99             "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
 100             );
 101
 102     // Preprocess the metadata.
 103     doFilters(*xmlObject.get());
 104     xmlObject->releaseThisAndChildrenDOM();
 105     xmlObject->setDocument(NULL);
 106
 107     // Swap it in.
 108     bool changed = m_object!=NULL;
 109     delete m_object;
 110     m_object = xmlObject.release();
 111     index();
 112     if (changed)
 113         emitChangeEvent();
 114     return make_pair(false,(DOMElement*)NULL);
 115 }
 116
 117 void XMLMetadataProvider::index()
 118 {
 119     clearDescriptorIndex();
 120     EntitiesDescriptor* group=dynamic_cast<EntitiesDescriptor*>(m_object);
 121     if (group) {
 122         AbstractMetadataProvider::index(group, SAMLTIME_MAX);
 123         return;
 124     }
 125     EntityDescriptor* site=dynamic_cast<EntityDescriptor*>(m_object);
 126     AbstractMetadataProvider::index(site, SAMLTIME_MAX);
 127 }