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

TXFMDocObject.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  * TXFMDocObject := Class that takes an input Document object ID to start a txfm pipe
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $Id: TXFMDocObject.hpp,v 1.4 2003/03/02 08:21:02 blautenb Exp $
00068  *
00069  */
00070 
00071 #include <xsec/transformers/TXFMBase.hpp>
00072 #include <xsec/utils/XSECSafeBuffer.hpp>
00073 
00074 // Xerces
00075 
00076 #include <xercesc/dom/DOM.hpp>
00077 
00084 class DSIG_EXPORT TXFMDocObject : public TXFMBase {
00085 
00086 public:
00087 
00088     TXFMDocObject(DOMDocument *doc);
00089     ~TXFMDocObject();
00090 
00091     // Methods to set the inputs
00092 
00093     void setInput(TXFMBase *newInput);
00094     void setInput(DOMDocument *doc, const XMLCh * newFragmentId);
00095     void setInput(DOMDocument *doc, DOMNode *newFragmentObject);
00096     void setInput(DOMDocument *doc);
00097 
00098     // Methods to get tranform output type and input requirement
00099 
00100     TXFMBase::ioType getInputType(void);
00101     TXFMBase::ioType getOutputType(void);
00102     TXFMBase::nodeType getNodeType(void);
00103 
00104     // Methods to get output data
00105 
00106     unsigned int readBytes(XMLByte * const toFill, const unsigned int maxToFill);
00107     virtual DOMDocument * getDocument();
00108     virtual DOMNode * getFragmentNode();
00109     virtual const XMLCh * getFragmentId();
00110     
00111 private:
00112 
00113     XMLCh   * fragmentId;               // The identifier of the object
00114     DOMDocument * document;             // The DOM document we are working with
00115     DOMNode * fragmentObject;           // The object that contains the doc fragment to use
00116     TXFMBase::nodeType type;            // The type of nodes this holds
00117 
00118     
00119     TXFMDocObject();
00120 };
00121 

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