-/*
- * Copyright 2001-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.
*/
/**
namespace xmltooling {
+ class XMLTOOL_API Mutex;
class XMLTOOL_API ParserPool;
class XMLTOOL_API PathResolver;
class XMLTOOL_API TemplateEngine;
#ifndef XMLTOOLING_NO_XMLSEC
class XMLTOOL_API CredentialResolver;
class XMLTOOL_API KeyInfoResolver;
+ class XMLTOOL_API PathValidator;
class XMLTOOL_API TrustEngine;
class XMLTOOL_API XSECCryptoX509CRL;
#endif
*/
virtual ParserPool& getValidatingParser() const=0;
+ /**
+ * Returns a reference to a named mutex.
+ * <p>The first access to a given name will create the object.
+ *
+ * @param name name of mutex to access
+ * @return reference to a mutex object
+ */
+ virtual Mutex& getNamedMutex(const char* name)=0;
+
#ifndef XMLTOOLING_NO_XMLSEC
/**
* Returns the global KeyInfoResolver instance.
void setURLEncoder(URLEncoder* urlEncoder);
/**
+ * @deprecated
* List of catalog files to load into validating parser pool at initialization time.
* <p>Like other path settings, the separator depends on the platform
* (semicolon on Windows, colon otherwise).
*/
unsigned int clock_skew_secs;
+#ifndef XMLTOOLING_LITE
+ /**
+ * Manages factories for StorageService plugins.
+ */
+ PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
+#endif
+
#ifndef XMLTOOLING_NO_XMLSEC
/**
* Returns an X.509 CRL implementation object.
virtual XSECCryptoX509CRL* X509CRL() const=0;
/**
+ * Manages factories for CredentialResolver plugins.
+ */
+ PluginManager<CredentialResolver,std::string,const xercesc::DOMElement*> CredentialResolverManager;
+
+ /**
* Manages factories for KeyInfoResolver plugins.
*/
PluginManager<KeyInfoResolver,std::string,const xercesc::DOMElement*> KeyInfoResolverManager;
/**
- * Manages factories for CredentialResolver plugins.
+ * Manages factories for PathValidator plugins.
*/
- PluginManager<CredentialResolver,std::string,const xercesc::DOMElement*> CredentialResolverManager;
+ PluginManager<PathValidator,std::string,const xercesc::DOMElement*> PathValidatorManager;
/**
* Manages factories for TrustEngine plugins.
PluginManager<TrustEngine,std::string,const xercesc::DOMElement*> TrustEngineManager;
/**
- * Manages factories for StorageService plugins.
- */
- PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
-
- /**
* Maps an XML Signature/Encryption algorithm identifier to a library-specific
* key algorithm and size for use in resolving credentials.
*
virtual std::pair<const char*,unsigned int> mapXMLAlgorithmToKeyAlgorithm(const XMLCh* xmlAlgorithm) const=0;
/**
+ * Types of XML Security algorithms.
+ */
+ enum XMLSecurityAlgorithmType {
+ ALGTYPE_UNK,
+ ALGTYPE_DIGEST,
+ ALGTYPE_SIGN,
+ ALGTYPE_ENCRYPT,
+ ALGTYPE_KEYENCRYPT,
+ ALGTYPE_KEYAGREE,
+ ALGTYPE_AUTHNENCRYPT
+ };
+
+ /**
* Registers an XML Signature/Encryption algorithm identifier against a library-specific
* key algorithm and size for use in resolving credentials.
*
* @param xmlAlgorithm XML Signature/Encryption algorithm identifier
* @param keyAlgorithm a key algorithm
* @param size a key size (or 0 if the size is irrelevant)
+ * @param type type of algorithm, if known
*/
- virtual void registerXMLAlgorithm(const XMLCh* xmlAlgorithm, const char* keyAlgorithm, unsigned int size=0)=0;
+ virtual void registerXMLAlgorithm(
+ const XMLCh* xmlAlgorithm, const char* keyAlgorithm, unsigned int size=0, XMLSecurityAlgorithmType type=ALGTYPE_UNK
+ )=0;
/**
- * Checks for implementation support of a particular XML security algorithm.
+ * Checks for implementation support of a particular XML Security algorithm.
*
+ * @param xmlAlgorithm XML Signature/Encryption algorithm identifier
+ * @param type type of algorithm, or ALGTYPE_UNK to ignore
* @return true iff the algorithm is supported by the underlying libraries
*/
- virtual bool isXMLAlgorithmSupported(const XMLCh* xmlAlgorithm)=0;
+ virtual bool isXMLAlgorithmSupported(const XMLCh* xmlAlgorithm, XMLSecurityAlgorithmType type=ALGTYPE_UNK)=0;
#endif
/**