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