Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

XSECCanon.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2002 Berin Lautenbach.  All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  *
00010  * 1. Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *
00018  * 3. The end-user documentation included with the redistribution,
00019  *    if any, must include the following acknowledgment:
00020  *       "This product includes software developed by
00021  *                   Berin Lautenbach"
00022  *    Alternately, this acknowledgment may appear in the software itself,
00023  *    if and wherever such third-party acknowledgments normally appear.
00024  *
00025  * 4. The names "XSEC", "xml-security-c" and Berin Lautenbach must
00026  *    not be used to endorse or promote products derived from this
00027  *    software without prior written permission. For written
00028  *    permission, please contact berin@users.sourceforge.net.
00029  *
00030  * 5. Products derived from this software may not be called "xml-security-c",
00031  *    nor may "xml-security-c" appear in their name, without prior written
00032  *    permission of Berin Lautenbach.
00033  *
00034  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00035  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00036  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00037  * DISCLAIMED.  IN NO EVENT SHALL BERIN LAUTENBACH OR OTHER
00038  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00039  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00040  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00041  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00042  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00043  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00044  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00045  * SUCH DAMAGE.
00046  * ====================================================================
00047  */
00048 
00049 /*
00050  * XSEC
00051  *
00052  * XSECCanon := Base (abstract) class for canonicalisation objects
00053  *
00054  */
00055 
00056 // XSEC includes
00057 #include <xsec/framework/XSECDefs.hpp>
00058 #include <xsec/utils/XSECSafeBuffer.hpp>
00059 
00060 // Xerces Includes
00061 #include <xercesc/dom/DOM.hpp>
00062 
00063 // --------------------------------------------------------------------------------
00064 //           Defines
00065 // --------------------------------------------------------------------------------
00066 
00067 #define XSECCANNON_BUFFER_START_SIZE        8192        /* Default size for the outBuffer */
00068 
00069 
00070 // --------------------------------------------------------------------------------
00071 //           XSECCanon Virtual Class definition
00072 // --------------------------------------------------------------------------------
00073 
00074 // Most of the interface work is done within this class.  However the actual
00075 // processing is done via the processNextNode virtual function that must be
00076 // implemented by all children classes.
00077 
00078 class CANON_EXPORT XSECCanon {
00079 
00080 protected:
00081 
00082     // Data structures
00083 
00084     DOMDocument         *mp_doc;            // Xerces DOM Node that defines the document
00085     DOMNode             *mp_startNode,      // Node to start processing from
00086                         *mp_nextNode;       // Next Node to be processeed
00087     safeBuffer          m_buffer;           // Buffer holding parsed output
00088     int                 m_bufferLength,     // Length of input currently in buffer
00089                         m_bufferPoint;      // Next "character" to copy out
00090     bool                m_allNodesDone;     // Have we completed?
00091 
00092 
00093 public:
00094 
00095     // Constructors
00096 
00097     XSECCanon();
00098     XSECCanon(DOMDocument *newDoc);
00099     XSECCanon(DOMDocument *newDoc, DOMNode *newStartNode);
00100 
00101     // Destructors
00102 
00103     virtual ~XSECCanon();
00104 
00105     // Public Methods
00106 
00107     // outputBuffer is used by all canonicalisers to output the next numBytes bytes of
00108     // canonicalised XML to the nominated buffer
00109 
00110     int outputBuffer(unsigned char *outBuffer, int numBytes);
00111     
00112     // setStartNode sets the starting point for the output if it is a sub-document 
00113     // that needs canonicalisation and we want to re-start
00114     
00115     bool setStartNode(DOMNode *newStartNode);
00116 
00117 protected:
00118 
00119     // processNextNode is the pure virtual function that must be implemented by all canons
00120 
00121     virtual int processNextNode() = 0;
00122 
00123 };
00124 

Generated on Sat Jan 11 20:34:07 2003 for XML-Security-C by doxygen1.2.15