00001 /* 00002 * The Apache Software License, Version 1.1 00003 * 00004 * 00005 * Copyright (c) 2002-2003 The Apache Software Foundation. All rights 00006 * reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions 00010 * are met: 00011 * 00012 * 1. Redistributions of source code must retain the above copyright 00013 * notice, this list of conditions and the following disclaimer. 00014 * 00015 * 2. Redistributions in binary form must reproduce the above copyright 00016 * notice, this list of conditions and the following disclaimer in 00017 * the documentation and/or other materials provided with the 00018 * distribution. 00019 * 00020 * 3. The end-user documentation included with the redistribution, 00021 * if any, must include the following acknowledgment: 00022 * "This product includes software developed by the 00023 * Apache Software Foundation (http://www.apache.org/)." 00024 * Alternately, this acknowledgment may appear in the software itself, 00025 * if and wherever such third-party acknowledgments normally appear. 00026 * 00027 * 4. The names "<WebSig>" and "Apache Software Foundation" must 00028 * not be used to endorse or promote products derived from this 00029 * software without prior written permission. For written 00030 * permission, please contact apache@apache.org. 00031 * 00032 * 5. Products derived from this software may not be called "Apache", 00033 * nor may "Apache" appear in their name, without prior written 00034 * permission of the Apache Software Foundation. 00035 * 00036 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 00037 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00038 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00039 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 00040 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00041 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00042 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 00043 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 00044 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00045 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 00046 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00047 * SUCH DAMAGE. 00048 * ==================================================================== 00049 * 00050 * This software consists of voluntary contributions made by many 00051 * individuals on behalf of the Apache Software Foundation and was 00052 * originally based on software copyright (c) 2001, Institute for 00053 * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>. 00054 * The development of this software was partly funded by the European 00055 * Commission in the <WebSig> project in the ISIS Programme. 00056 * For more information on the Apache Software Foundation, please see 00057 * <http://www.apache.org/>. 00058 */ 00059 00060 /* 00061 * XSEC 00062 * 00063 * TXFMBase := Base (virtual) class that defines a DSIG Transformer 00064 * 00065 * Author(s): Berin Lautenbach 00066 * 00067 * $Id: TXFMBase.hpp,v 1.7 2003/07/05 10:30:36 blautenb Exp $ 00068 * 00069 */ 00070 00071 #ifndef TXFMBASE_INCLUDE 00072 #define TXFMBASE_INCLUDE 00073 00074 #include <xercesc/dom/DOM.hpp> 00075 #include <xsec/canon/XSECC14n20010315.hpp> 00076 #include <xsec/utils/XSECNameSpaceExpander.hpp> 00077 #include <xsec/utils/XSECXPathNodeList.hpp> 00078 00079 // Xalan 00080 00081 #include <xercesc/util/BinInputStream.hpp> 00082 00083 #include <stdlib.h> 00084 00085 class TXFMChain; 00086 00106 class DSIG_EXPORT TXFMBase { 00107 00108 protected: 00109 00110 TXFMBase *input; // The input source that we read from 00111 bool keepComments; // Each transform needs to tell the next whether comments are still in 00112 XSECNameSpaceExpander * mp_nse; // For expanding document name spaces 00113 DOMDocument * mp_expansionDoc; // For expanding 00114 XSECXPathNodeList m_XPathMap; // For node lists if necessary 00115 00116 public: 00117 00118 TXFMBase(DOMDocument *doc) {input = NULL; keepComments = true; mp_nse = NULL; mp_expansionDoc = doc;} 00119 virtual ~TXFMBase(); 00120 00121 // For getting/setting input/output type 00122 00123 enum ioType { 00124 00125 NONE = 1, // For when there is no Input 00126 BYTE_STREAM = 2, 00127 DOM_NODES = 3 00128 00129 }; 00130 00131 enum nodeType { 00132 00133 DOM_NODE_NONE = 1, // No nodes set 00134 DOM_NODE_DOCUMENT = 2, // This is a dom document 00135 DOM_NODE_DOCUMENT_FRAGMENT = 3, // This is a fragment only 00136 DOM_NODE_DOCUMENT_NODE = 4, // This is a fragment id;d by DOM_Node 00137 DOM_NODE_XPATH_NODESET = 5 // This is a set of nodes 00138 00139 }; 00140 00141 00142 // Methods to set the inputs 00143 // NOTE: If this throws an exception, the implementation class 00144 // MUST have added the newInput to it's chain to ensure that 00145 // Deletion of the chain will include everything. 00146 00147 virtual void setInput(TXFMBase *newInput) = 0; 00148 00149 // Methods to get tranform output type and input requirement 00150 00151 virtual ioType getInputType(void) = 0; 00152 virtual ioType getOutputType(void) = 0; 00153 virtual nodeType getNodeType(void) = 0; 00154 00155 // Name space expansion handling 00156 virtual bool nameSpacesExpanded(void); 00157 virtual void expandNameSpaces(void); 00158 void deleteExpandedNameSpaces(void); 00159 00160 // Comment handling 00161 00162 virtual void stripComments(void) { keepComments = false;} 00163 virtual void activateComments(void); 00164 virtual bool getCommentsStatus(void) {return keepComments;} 00165 00166 // Methods to get output data 00167 00168 // BinInputStream methods: 00169 00170 virtual unsigned int readBytes(XMLByte * const toFill, const unsigned int maxToFill) = 0; 00171 virtual DOMDocument *getDocument() = 0; 00172 virtual DOMNode *getFragmentNode() = 0; 00173 virtual const XMLCh * getFragmentId() = 0; 00174 virtual XSECXPathNodeList & getXPathNodeList() {return m_XPathMap;} 00175 00176 // Friends and Statics 00177 00178 friend class TXFMChain; 00179 00180 00181 private: 00182 00183 TXFMBase(); 00184 }; 00185 00188 #endif /* #define TXFMBASE_INCLUDE */