*/
/**
- * @file MetadataProvider.h
+ * @file saml/saml2/metadata/MetadataProvider.h
*
* Supplies an individual source of metadata.
*/
class SAML_API MetadataProvider : public virtual xmltooling::Lockable
{
MAKE_NONCOPYABLE(MetadataProvider);
+
protected:
- MetadataProvider() : m_filter(NULL) {}
+ /**
+ * Constructor. If a DOM is supplied, a set of default logic will be
+ * used to identify and build MetadataFilter plugins and install them
+ * into the provider. The following XML content is supported:
+ *
+ * <ul>
+ * <li><MetadataFilter> elements with a type attribute
+ * <li><Exclude> elements representing a BlacklistMetadataFilter
+ * <li><BlacklistMetadataFilter> element containing <Exclude> elements
+ * <li><Include> elements representing a WhitelistMetadataFilter
+ * <li><WhitelistMetadataFilter> element containing <Include> elements
+ * </ul>
+ *
+ * XML namespaces are ignored in the processing of these elements.
+ *
+ * @param e DOM to supply configuration for provider
+ */
+ MetadataProvider(const DOMElement* e=NULL);
public:
- virtual ~MetadataProvider() {
- delete m_filter;
- }
+ /**
+ * Destructor will delete any installed filters.
+ */
+ virtual ~MetadataProvider();
/**
- * Gets the metadata filter applied to the resolved metadata.
+ * Adds a metadata filter to apply to any resolved metadata. Will not be applied
+ * to metadata that is already loaded.
*
- * @return the metadata filter applied to the resolved metadata
+ * @param newFilter metadata filter to add
*/
- const MetadataFilter* getMetadataFilter() const {
- return m_filter;
+ virtual void addMetadataFilter(MetadataFilter* newFilter) {
+ m_filters.push_back(newFilter);
}
-
+
/**
- * Sets the metadata filter applied to the resolved metadata.
+ * Removes a metadata filter. The caller must delete the filter if necessary.
*
- * @param newFilter the metadata filter applied to the resolved metadata
+ * @param oldFilter metadata filter to remove
+ * @return the old filter
*/
- void setMetadataFilter(MetadataFilter* newFilter) {
- delete m_filter;
- m_filter=newFilter;
+ virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) {
+ for (std::vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
+ if (oldFilter==(*i)) {
+ m_filters.erase(i);
+ return oldFilter;
+ }
+ }
+ return NULL;
}
/**
- * Should be called after instantiating provider and setting filter, but before
+ * Should be called after instantiating provider and adding filters, but before
* performing any lookup operations. Allows the provider to defer initialization
* processes that are likely to result in exceptions until after the provider is
* safely created. Providers SHOULD perform as much processing as possible in
* this method so as to report/log any errors that would affect later processing.
- * Also, any inputs supplied to the factory MUST persist until the completion of
- * this method, but the caller is then free to modify or delete them.
*/
virtual void init()=0;
virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
protected:
- MetadataFilter* m_filter;
+ /**
+ * Applies any installed filters to a metadata instance.
+ *
+ * @param xmlObject the metadata to be filtered
+ */
+ void doFilters(xmltooling::XMLObject& xmlObject) const;
+
+ private:
+ std::vector<MetadataFilter*> m_filters;
};
/**