/* * The Apache Software License, Version 1.1 * * * Copyright (c) 1999 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation and was * originally based on software copyright (c) 2001, Institute for * Data Communications Systems, . * The development of this software was partly funded by the European * Commission in the project in the ISIS Programme. * For more information on the Apache Software Foundation, please see * . */ /* * XSEC * * DSIGTransformXPath := Class that performs XPath transforms * * Author(s): Berin Lautenbach * * $Id: DSIGTransformXPath.hpp,v 1.4 2003/04/22 22:35:17 blautenb Exp $ * */ #ifndef DSIGTRANSFORMXPATH_INCLUDE #define DSIGTRANSFORMXPATH_INCLUDE #include #include XSEC_DECLARE_XERCES_CLASS(DOMNamedNodeMap); XSEC_DECLARE_XERCES_CLASS(DOMNode); /** * @ingroup pubsig * @{ */ /** * @brief Transform holder for XPath transforms. * * The DSIGTransformXPath class is used to hold XPath elements * within a document. * * @see TXFMXPath * @see DSIGTransform * */ class DSIG_EXPORT DSIGTransformXPath : public DSIGTransform { public: /** @name Constructors and Destructors */ //@{ /** * \brief Contructor used for existing XML signatures. * * The Node structure already exists, so read the nodes in. * * @param sig The Signature structure in which this transform exists. * @param node The DOM node (within doc) that is to be used as the base of the Transform. * @see #load */ DSIGTransformXPath(DSIGSignature *sig, DOMNode * node); /** * \brief Contructor used for new signatures. * * The Node structure will have to be created. * * @note DSIGTransform structures should only ever be created via calls to a * DSIGTransformList object. * * @param sig The Signature structure in which this transform exists. * @see createBlankTransform */ DSIGTransformXPath(DSIGSignature *sig); /** * \brief Destructor. * * Destroy the DSIGSignature elements. * * Does not destroy any associated DOM Nodes */ virtual ~DSIGTransformXPath(); //@} /** @name Interface Methods */ //@{ /** * \brief Determine the transform type. * * Used to determine what the type of the transform is. * */ virtual transformType getTransformType(); /** * \brief Create the XPath Transformer class. * * Create the transformer associated with this XPath transform. * Will set the expression and Namespaces as appropriate * * @returns The TXFMXPath transformer associated with this Transform */ virtual void appendTransformer(TXFMChain * input); /** * \brief Construct blank XPath Transform element. * * Instruct the implementation to create the required * transform and return the newly constructed DOMNode structure */ virtual DOMElement * createBlankTransform(DOMDocument * parentDoc); /** * \brief Load a DOM structure * * Load the expression and Namespaces. * */ virtual void load(void); //@} /** @name XPath specific methods */ //@{ /** * * \brief Set the XPath expression. * * Takes the provided string and uses it to set the expression in the * Signature and DOM structures. * * If an expression already exists, it is overwritten. * * @param expr The expression to set */ void setExpression(const char * expr); /** * \brief Get the XPath expression * * Returns a character buffer with the expression inside it. * * @note Do not delete the returned pointer - it is owned by the object. * * @returns The expression */ const char * getExpression(void); /** * \brief Add a new namespace to the list to be used * * Add a new namespace to the XPath Element. * * @param prefix NCName of the Namespace to set * @param value The string with the URI to set */ void setNamespace(const char * prefix, const char * value); /** * \brief Get the list of namespaces. * * Returns the DOMNamedNodeMap of the attributes of the XPath transform * node. This should only contain namespaces. * * @returns A pointer to the NamedNodeMap */ DOMNamedNodeMap * getNamespaces(void) { return mp_NSMap; } /** * \brief Delete a namespace to the list to be used * * Delete a namespace from the XPath Element. * * @param prefix NCName of the Namespace to delete * @throws XSECException if the NCName does not exist * */ void deleteNamespace(const char * prefix); //@} private: DSIGTransformXPath(); DSIGTransformXPath(const DSIGTransformXPath & theOther); safeBuffer m_expr; DOMNode * mp_exprTextNode; DOMNode * mp_xpathNode; DOMNamedNodeMap * mp_NSMap; }; #endif /* DSIGTRANSFORMXPATH_INCLUDE */