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

XSECSafeBufferFormatter.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  * XSECSafeBufferFormatter := Class for formatting DOMStrings into SafeBuffers
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $Id: XSECSafeBufferFormatter.hpp,v 1.4 2003/03/02 08:21:02 blautenb Exp $
00068  *
00069  */
00070 
00071 #ifndef XSECSAFEBUFFERFORMATTER_INCLUDE
00072 #define XSECSAFEBUFFERFORMATTER_INCLUDE
00073 
00074 // XSEC includes
00075 
00076 #include <xsec/utils/XSECSafeBuffer.hpp>
00077 
00078 // Xerces includes
00079 
00080 #include <xercesc/framework/XMLFormatter.hpp>
00081 
00082 XSEC_USING_XERCES(XMLFormatter);
00083 XSEC_USING_XERCES(XMLFormatTarget);
00084 
00089 class sbFormatTarget : public XMLFormatTarget
00090 {
00091 public:
00092     
00093     safeBuffer * buffer;        // Buffer to write to
00094 
00095     sbFormatTarget()  {};
00096     ~sbFormatTarget() {};
00097 
00098     void setBuffer (safeBuffer * toSet) {buffer = toSet;};
00099 
00100 
00101     // -----------------------------------------------------------------------
00102     //  Implementations of the format target interface
00103     //  Based on Xerces/Xalan example code
00104     // -----------------------------------------------------------------------
00105 
00106     void writeChars(const   XMLByte* const  toWrite,
00107                     const unsigned int    count,
00108                     XMLFormatter * const formatter)
00109     {
00110          buffer->sbMemcpyIn((char *) toWrite, (int) count);
00111          buffer->setBufferType(safeBuffer::BUFFER_CHAR);
00112         (*buffer)[count] = '\0';
00113     };
00114 
00115 private:
00116 
00117     sbFormatTarget(const sbFormatTarget& other);
00118     void operator=(const sbFormatTarget& rhs);
00119 
00120     
00121 };
00122 
00131 class XSECSafeBufferFormatter {
00132 
00133     XMLFormatter        * formatter;        // To actually perform the formatting
00134     safeBuffer          formatBuffer;       // Storage of translated strings
00135     sbFormatTarget      * sbf;              // Format target used by XMLFormatter
00136 
00137 public:
00138 
00139     // Constructor
00140 
00141     XSECSafeBufferFormatter(
00142         const XMLCh * const                     outEncoding,
00143         const XMLFormatter::EscapeFlags         escapeFlags=XMLFormatter::NoEscapes,
00144         const XMLFormatter::UnRepFlags          unrepFlags=XMLFormatter::UnRep_Fail);
00145 
00146     XSECSafeBufferFormatter(
00147         const char * const                      outEncoding,
00148         const XMLFormatter::EscapeFlags         escapeFlags=XMLFormatter::NoEscapes,
00149         const XMLFormatter::UnRepFlags          unrepFlags=XMLFormatter::UnRep_Fail);
00150 
00151     // Destructor
00152 
00153     ~XSECSafeBufferFormatter();
00154 
00155     // Reimplementation of XMLFormatter functions
00156 
00157     void  formatBuf (
00158         const XMLCh *const toFormat,
00159         const unsigned int count,
00160         const XMLFormatter::EscapeFlags escapeFlags=XMLFormatter::DefaultEscape,
00161         const XMLFormatter::UnRepFlags unrepFlags=XMLFormatter::DefaultUnRep);      // Format a buffer
00162 
00163     XSECSafeBufferFormatter&  operator<< (
00164         const XMLCh *const toFormat);                   // Format a buffer
00165     
00166     XSECSafeBufferFormatter&  operator<< (
00167         const XMLCh toFormat);                          // Format a character
00168 
00169     const XMLCh*  getEncodingName ()const;              // Get current encoding
00170 
00171     void  setEscapeFlags (const XMLFormatter::EscapeFlags newFlags);
00172     void  setUnRepFlags (const XMLFormatter::UnRepFlags newFlags);
00173 
00174     XSECSafeBufferFormatter&  operator<< (const XMLFormatter::EscapeFlags newFlags); 
00175     XSECSafeBufferFormatter&  operator<< (const XMLFormatter::UnRepFlags newFlags); 
00176     //XSECSafeBufferFormatter& operator<<  (const DOMString &s);
00177 
00178     // Friends for working with safestrings
00179 
00180     friend safeBuffer& operator<< (safeBuffer &to, const XSECSafeBufferFormatter & from);
00181 
00182 private:
00183 
00184     // Unimplemented
00185 
00186     XSECSafeBufferFormatter() {};
00187 
00188 };
00189 
00192 #endif /* XSECSAFEBUFFERFORMATTER_INCLUDE */

Generated on Wed May 7 21:43:52 2003 for XML-Security-C by doxygen1.2.18