-/*
- * Copyright 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * UCAID licenses this file to you 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
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
*/
/**
#include <saml/saml2/metadata/MetadataProvider.h>
+#include <boost/shared_ptr.hpp>
+
namespace opensaml {
+ namespace saml2 {
+ class SAML_API Attribute;
+ };
+
namespace saml2md {
+
+ class SAML_API EntityAttributes;
+ class SAML_API EntityMatcher;
#if defined (_MSC_VER)
#pragma warning( push )
class SAML_API DiscoverableMetadataProvider : public virtual MetadataProvider
{
protected:
- DiscoverableMetadataProvider();
+ /**
+ * Constructor.
+ *
+ * If a DOM is supplied, the following XML content is supported:
+ *
+ * <dl>
+ * <dt>legacyOrgNames</dt>
+ * <dd>true iff IdPs without a UIInfo extension should
+ * be identified using <md:OrganizationDisplayName></dd>
+ * <dt>entityAttributes</dt>
+ * <dd>true iff tags found in <mdattr:EntityAttributes>
+ * extensions should be included in the feed</dd>
+ * <dt><DiscoveryFilter type="..." matcher="..." ></dt>
+ * <dd>Zero or more filters of type "Whitelist" or "Blacklist" that
+ * affect which entities get exposed by the feed. The actual matching
+ * is driven by an EntityMatcher plugin identified by the matcher
+ * attribute. Other element content will be present to configure
+ * that plugin.</dd>
+ * </dl>
+ *
+ * @param e DOM to supply configuration for provider
+ */
+ DiscoverableMetadataProvider(const xercesc::DOMElement* e=nullptr);
/**
* Generates a JSON feed of IdP discovery information for the current metadata.
* Outputs the cached feed.
* <p>The provider <strong>MUST</strong> be locked.
*
- * @param os stream to output feed into
- * @return a reference to the output stream
+ * @param os stream to output feed into
+ * @param first on input, indicates if the feed is first in position,
+ * on output will be false if the feed was non-empty
+ * @param wrapArray true iff the feed array should be opened/closed by this provider
*/
- virtual std::ostream& outputFeed(std::ostream& os) const;
+ virtual void outputFeed(std::ostream& os, bool& first, bool wrapArray=true) const;
protected:
/** Storage for feed. */
/** ETag for feed. */
mutable std::string m_feedTag;
+
+ private:
+ void discoEntity(std::string& s, const EntityDescriptor* entity, bool& first) const;
+ void discoGroup(std::string& s, const EntitiesDescriptor* group, bool& first) const;
+ void discoEntityAttributes(std::string& s, const EntityAttributes& ea, bool& first) const;
+ void discoAttributes(std::string& s, const std::vector<saml2::Attribute*>& attrs, bool& first) const;
+
+ bool m_legacyOrgNames, m_entityAttributes;
+ std::vector< std::pair< bool, boost::shared_ptr<EntityMatcher> > > m_discoFilters;
};
#if defined (_MSC_VER)