---

TXFMBase.hpp

Go to the documentation of this file.

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 Berin Lautenbach.  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
 *                   Berin Lautenbach"
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "XSEC", "xml-security-c" and Berin Lautenbach must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact berin@users.sourceforge.net.
 *
 * 5. Products derived from this software may not be called "xml-security-c",
 *    nor may "xml-security-c" appear in their name, without prior written
 *    permission of Berin Lautenbach.
 *
 * 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 BERIN LAUTENBACH OR OTHER
 * 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.
 * ====================================================================
 */

/*
 * XSEC
 *
 * TXFMBase := Base (virtual) class that defines a DSIG Transformer
 *
 */

#ifndef TXFMBASE_INCLUDE
#define TXFMBASE_INCLUDE

#include <xercesc/dom/DOM.hpp>
#include <xsec/canon/XSECC14n20010315.hpp>
#include <xsec/utils/XSECNameSpaceExpander.hpp>
#include <xsec/utils/XSECXPathNodeList.hpp>

// Xalan

#include <xercesc/util/BinInputStream.hpp>


#include <stdlib.h>


class DSIG_EXPORT TXFMBase {

protected:

    TXFMBase                *input;         // The input source that we read from
    bool                    keepComments;   // Each transform needs to tell the next whether comments are still in
    XSECNameSpaceExpander   * mp_nse;       // For expanding document name spaces
    DOMDocument             * mp_expansionDoc;  // For expanding
    XSECXPathNodeList       m_XPathMap;     // For node lists if necessary

public:

    TXFMBase(DOMDocument *doc) {input = NULL; keepComments = true; mp_nse = NULL; mp_expansionDoc = doc;}
    virtual ~TXFMBase();

    // For getting/setting input/output type

    enum ioType {

        NONE            = 1,            // For when there is no Input
        BYTE_STREAM     = 2,
        DOM_NODES       = 3

    };

    enum nodeType {

        DOM_NODE_NONE               = 1,            // No nodes set
        DOM_NODE_DOCUMENT           = 2,            // This is a dom document
        DOM_NODE_DOCUMENT_FRAGMENT  = 3,            // This is a fragment only
        DOM_NODE_DOCUMENT_NODE      = 4,            // This is a fragment id;d by DOM_Node
        DOM_NODE_XPATH_NODESET      = 5             // This is a set of nodes

    };


    // Methods to set the inputs

    virtual void setInput(TXFMBase *newInput) = 0;

    // Methods to get tranform output type and input requirement

    virtual ioType getInputType(void) = 0;
    virtual ioType getOutputType(void) = 0;
    virtual nodeType getNodeType(void) = 0;

    // Name space expansion handling
    virtual bool nameSpacesExpanded(void);
    virtual void expandNameSpaces(void);
    void deleteExpandedNameSpaces(void);

    // Comment handling

    virtual void stripComments(void) { keepComments = false;}
    virtual void activateComments(void);
    virtual bool getCommentsStatus(void) {return keepComments;}

    // Methods to get output data
    
    // BinInputStream methods:

    virtual unsigned int readBytes(XMLByte * const toFill, const unsigned int maxToFill) = 0;
    virtual DOMDocument *getDocument() = 0;
    virtual DOMNode *getFragmentNode() = 0;
    virtual safeBuffer getFragmentId() = 0;
    virtual XSECXPathNodeList & getXPathNodeList() {return m_XPathMap;}

    // Friends and Statics

    friend void deleteTXFMChain(TXFMBase * toDelete);


private:

    TXFMBase();
};

void deleteTXFMChain(TXFMBase * toDelete);

#endif /* #define TXFMBASE_INCLUDE */

---