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  *
00005  * Copyright (c) 1999 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  * XSECCanon := Base (abstract) class for canonicalisation objects
00064  *
00065  *
00066  * Author(s): Berin Lautenbach
00067  *
00068  * $ID$
00069  *
00070  * $LOG$
00071  */
00072 
00073 // XSEC includes
00074 #include <xsec/framework/XSECDefs.hpp>
00075 #include <xsec/utils/XSECSafeBuffer.hpp>
00076 
00077 XSEC_DECLARE_XERCES_CLASS(DOMNode);
00078 XSEC_DECLARE_XERCES_CLASS(DOMDocument);
00079 
00080 // --------------------------------------------------------------------------------
00081 //           Defines
00082 // --------------------------------------------------------------------------------
00083 
00084 #define XSECCANNON_BUFFER_START_SIZE        8192        /* Default size for the outBuffer */
00085 
00086 
00087 // --------------------------------------------------------------------------------
00088 //           XSECCanon Virtual Class definition
00089 // --------------------------------------------------------------------------------
00090 
00091 // Most of the interface work is done within this class.  However the actual
00092 // processing is done via the processNextNode virtual function that must be
00093 // implemented by all children classes.
00094 
00095 class CANON_EXPORT XSECCanon {
00096 
00097 protected:
00098 
00099     // Data structures
00100 
00101     DOMDocument         *mp_doc;            // Xerces DOM Node that defines the document
00102     DOMNode             *mp_startNode,      // Node to start processing from
00103                         *mp_nextNode;       // Next Node to be processeed
00104     safeBuffer          m_buffer;           // Buffer holding parsed output
00105     int                 m_bufferLength,     // Length of input currently in buffer
00106                         m_bufferPoint;      // Next "character" to copy out
00107     bool                m_allNodesDone;     // Have we completed?
00108 
00109 
00110 public:
00111 
00112     // Constructors
00113 
00114     XSECCanon();
00115     XSECCanon(DOMDocument *newDoc);
00116     XSECCanon(DOMDocument *newDoc, DOMNode *newStartNode);
00117 
00118     // Destructors
00119 
00120     virtual ~XSECCanon();
00121 
00122     // Public Methods
00123 
00124     // outputBuffer is used by all canonicalisers to output the next numBytes bytes of
00125     // canonicalised XML to the nominated buffer
00126 
00127     int outputBuffer(unsigned char *outBuffer, int numBytes);
00128     
00129     // setStartNode sets the starting point for the output if it is a sub-document 
00130     // that needs canonicalisation and we want to re-start
00131     
00132     bool setStartNode(DOMNode *newStartNode);
00133 
00134 protected:
00135 
00136     // processNextNode is the pure virtual function that must be implemented by all canons
00137 
00138     virtual int processNextNode() = 0;
00139 
00140 };
00141 

Generated on Wed Mar 26 20:11:51 2003 for XML-Security-C by doxygen1.2.15