1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
/*
* Copyright 2002-2005 The Apache Software Foundation.
*
* 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
*
* 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.
*/
/*
* XSEC
*
* DSIGXPathFilterExpr := Class that holds an XPath Filter expression
*
* $Id: DSIGXPathFilterExpr.hpp 351364 2005-06-04 11:30:26Z blautenb $
*
*/
#ifndef DSIGXPATHFILTEREXPR_INCLUDE
#define DSIGXPATHFILTEREXPR_INCLUDE
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/dsig/DSIGConstants.hpp>
#include <xsec/utils/XSECSafeBuffer.hpp>
XSEC_DECLARE_XERCES_CLASS(DOMNamedNodeMap);
XSEC_DECLARE_XERCES_CLASS(DOMNode);
XSEC_DECLARE_XERCES_CLASS(DOMElement);
class XSECEnv;
/**
* @ingroup pubsig
*/
/**
* @brief Class used to hold (and manipulate) individual expressions
* in an XPathFilter transform
*
* @see TXFMXPathFilter
* @see DSIGTransformXpathFilter
*
*/
class DSIG_EXPORT DSIGXPathFilterExpr {
public:
/** @name Constructors and Destructors */
//@{
/**
* \brief Constructor used for existing XML signatures
*
* Node already exists and is part of an existing XPathFilter tree
*
* @param env The operating environment
* @param node The node that will be used to read the expression in
*/
DSIGXPathFilterExpr(const XSECEnv * env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * node);
/**
* \brief Builder constructor
*
* Used to create the DOM structure and DSIGSignature elements
*
* @param env The operating Environment
*/
DSIGXPathFilterExpr(const XSECEnv * env);
/**
* \brief Destructor.
*
* Destroy the DSIGSignature elements.
*
* Does not destroy any associated DOM Nodes
*/
~DSIGXPathFilterExpr();
//@}
/** @name Set and get Information */
//@{
/**
* \brief Read in existing structure
*
* Reads DOM structure of the XPath expression
*/
void load(void);
/**
* \brief Get the filter type
*
* Returns the type of this particular XPath filter
*
* @returns The filter type of this expression
*/
xpathFilterType getFilterType(void);
/**
* \brief create from blank
*
* Given the filter type and XPath expression, setup the
* DOMNodes and variables to allow signing and validation
*
* @param filterType Type of this filter to add
* @param filterExpr The XPath expression
*/
XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * setFilter(xpathFilterType filterType,
const XMLCh * filterExpr);
/**
* \brief Get the filter expression
*
* Returns an XMLCh string containing the filter expression
*
* @returns The filter expression
*/
const XMLCh * getFilter(void) {return m_expr.rawXMLChBuffer();}
/**
* \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 XMLCh * prefix, const XMLCh * value);
/**
* \brief Get the list of namespaces.
*
* Returns the DOMNamedNodeMap of the attributes of the XPath transform
* node.
*
* @note This will also contain the Filter attribute
*
* @returns A pointer to the NamedNodeMap
*/
XERCES_CPP_NAMESPACE_QUALIFIER 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 XMLCh * prefix);
//@}
private:
// Just let the TXFM read directly
friend class TXFMXPathFilter;
DSIGXPathFilterExpr();
DSIGXPathFilterExpr(const DSIGXPathFilterExpr& theOther);
const XSECEnv * mp_env;
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode
* mp_xpathFilterNode;
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode
* mp_exprTextNode;
XERCES_CPP_NAMESPACE_QUALIFIER DOMNamedNodeMap
* mp_NSMap;
safeBuffer m_expr;
xpathFilterType m_filterType;
bool m_loaded;
};
#endif /* DSIGXPATHFILTEREXPR_INCLUDE */
|