-/*
- * Copyright 2001-2006 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.
*/
/**
* @file saml/SAMLConfig.h
*
- * Library configuration
+ * Library configuration.
*/
#ifndef __saml_config_h__
#include <saml/base.h>
-#include <xmltooling/PluginManager.h>
-#include <xmltooling/XMLToolingConfig.h>
-
#include <string>
+#include <xercesc/dom/DOM.hpp>
+#include <xmltooling/PluginManager.h>
/**
* @namespace opensaml
class SAML_API MessageEncoder;
class SAML_API MessageDecoder;
class SAML_API SAMLArtifact;
- class SAML_API TrustEngine;
- class SAML_API URLEncoder;
+ class SAML_API SecurityPolicyRule;
namespace saml2md {
+ class SAML_API ContactPerson;
+ class SAML_API EntityDescriptor;
+ class SAML_API EntityMatcher;
class SAML_API MetadataProvider;
class SAML_API MetadataFilter;
+ class SAML_API RoleDescriptor;
};
#if defined (_MSC_VER)
{
MAKE_NONCOPYABLE(SAMLConfig);
public:
- virtual ~SAMLConfig() {}
+ virtual ~SAMLConfig();
/**
* Returns the global configuration object for the library.
/**
* Returns the global ArtifactMap instance.
*
- * @return global ArtifactMap or NULL
+ * @return global ArtifactMap or nullptr
*/
- ArtifactMap* getArtifactMap() const {
- return m_artifactMap;
- }
+ ArtifactMap* getArtifactMap() const;
/**
- * Sets the global URLEncoder instance.
- * This method must be externally synchronized with any code that uses the object.
- * Any previously set object is destroyed.
- *
- * @param urlEncoder new URLEncoder instance to store
- */
- void setURLEncoder(URLEncoder* urlEncoder);
-
- /**
- * Returns the global URLEncoder instance.
- *
- * @return global URLEncoder or NULL
- */
- URLEncoder* getURLEncoder() const {
- return m_urlEncoder;
- }
-
- /**
* Generate random information using the underlying security library
*
* @param buf buffer for the information
virtual XMLCh* generateIdentifier()=0;
/**
+ * @deprecated
* Generate the SHA-1 hash of a string
*
* @param s NULL-terminated string to hash
virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
/**
- * Manages factories for MessageDecoder plugins.
+ * Sets the order of contact types to use in annotating exceptions with contact information.
+ *
+ * @param contactTypes whitespace-delimited list of contact types
*/
- xmltooling::PluginManager<MessageDecoder,const DOMElement*> MessageDecoderManager;
+ virtual void setContactPriority(const XMLCh* contactTypes)=0;
/**
- * Manages factories for MessageEncoder plugins.
+ * Returns the appropriate contact to use for the entity.
+ *
+ * @param entity the entity to search
+ * @return a contact to use, or nullptr
*/
- xmltooling::PluginManager<MessageEncoder,const DOMElement*> MessageEncoderManager;
+ virtual const saml2md::ContactPerson* getContactPerson(const saml2md::EntityDescriptor& entity) const=0;
/**
- * Manages factories for SAMLArtifact plugins.
+ * Returns the appropriate contact to use for the role.
+ *
+ * @param entity the role to search
+ * @return a contact to use, or nullptr
*/
- xmltooling::PluginManager<SAMLArtifact,const char*> SAMLArtifactManager;
+ virtual const saml2md::ContactPerson* getContactPerson(const saml2md::RoleDescriptor& role) const=0;
- /**
- * Manages factories for TrustEngine plugins.
- */
- xmltooling::PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;
+ /** Manages factories for MessageDecoder plugins. */
+ xmltooling::PluginManager< MessageDecoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageDecoderManager;
- /**
- * Manages factories for MetadataProvider plugins.
- */
- xmltooling::PluginManager<saml2md::MetadataProvider,const DOMElement*> MetadataProviderManager;
+ /** Manages factories for MessageEncoder plugins. */
+ xmltooling::PluginManager< MessageEncoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageEncoderManager;
+
+ /** Manages factories for SAMLArtifact plugins. */
+ xmltooling::PluginManager<SAMLArtifact,std::string,const char*> SAMLArtifactManager;
+
+ /** Manages factories for SecurityPolicyRule plugins. */
+ xmltooling::PluginManager<SecurityPolicyRule,std::string,const xercesc::DOMElement*> SecurityPolicyRuleManager;
+
+ /** Manages factories for MetadataProvider plugins. */
+ xmltooling::PluginManager<saml2md::MetadataProvider,std::string,const xercesc::DOMElement*> MetadataProviderManager;
- /**
- * Manages factories for MetadataFilter plugins.
- */
- xmltooling::PluginManager<saml2md::MetadataFilter,const DOMElement*> MetadataFilterManager;
+ /** Manages factories for MetadataFilter plugins. */
+ xmltooling::PluginManager<saml2md::MetadataFilter,std::string,const xercesc::DOMElement*> MetadataFilterManager;
+
+ /** Manages factories for EntityMatcher plugins. */
+ xmltooling::PluginManager<saml2md::EntityMatcher,std::string,const xercesc::DOMElement*> EntityMatcherManager;
protected:
- SAMLConfig() : m_artifactMap(NULL), m_urlEncoder(NULL) {}
+ SAMLConfig();
/** Global ArtifactMap instance for use by artifact-related functions. */
ArtifactMap* m_artifactMap;
-
- /** Global URLEncoder instance for use by URL-related functions. */
- URLEncoder* m_urlEncoder;
};
#if defined (_MSC_VER)