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

XSECDOMUtils.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2002-2003 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  * XSECDOMUtils:= Utilities to manipulate DOM within XML-SECURITY
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $Id: XSECDOMUtils.hpp,v 1.9 2003/07/05 10:30:37 blautenb Exp $
00068  *
00069  */
00070 
00071 #ifndef XSECDOMUTILS_HEADER
00072 #define XSECDOMUTILS_HEADER
00073 
00074 // XSEC
00075 
00076 #include <xsec/utils/XSECPlatformUtils.hpp>
00077 #include <xsec/utils/XSECSafeBuffer.hpp>
00078 #include <xsec/dsig/DSIGConstants.hpp>
00079 
00080 // Xerces
00081 
00082 #include <xercesc/dom/DOM.hpp>
00083 #include <xercesc/util/XMLString.hpp>
00084 
00085 XSEC_USING_XERCES(DOMNode);
00086 XSEC_USING_XERCES(XMLString);
00087 
00088 #define COMPARE_STRING_LENGTH   256
00089 
00090 // --------------------------------------------------------------------------------
00091 //           "Quick" Transcode Class (low performance)
00092 // --------------------------------------------------------------------------------
00093 
00094 
00095 class DSIG_EXPORT XMLT {
00096 
00097 public:
00098 
00099     XMLT(const char * str);
00100     ~XMLT(void);
00101 
00102     XMLCh * getUnicodeStr(void);
00103 
00104 private:
00105 
00106     XMLCh * mp_unicodeStr;
00107     XMLT();
00108 
00109 };
00110 
00111 #define MAKE_UNICODE_STRING(str) XMLT(str).getUnicodeStr()
00112 
00113 // --------------------------------------------------------------------------------
00114 //           Utilities to manipulate namespaces
00115 // --------------------------------------------------------------------------------
00116 
00117 const XMLCh DSIG_EXPORT * getDSIGLocalName(const DOMNode *node);
00118 const XMLCh DSIG_EXPORT * getECLocalName(const DOMNode *node);
00119 const XMLCh DSIG_EXPORT * getXPFLocalName(const DOMNode *node);
00120 
00121 // --------------------------------------------------------------------------------
00122 //           Find a nominated DSIG node in a document
00123 // --------------------------------------------------------------------------------
00124 
00125 DOMNode DSIG_EXPORT * findDSIGNode(DOMNode *n, const char * nodeName);
00126 
00127 // --------------------------------------------------------------------------------
00128 //           Find particular type of node child
00129 // --------------------------------------------------------------------------------
00130 
00131 DOMNode DSIG_EXPORT * findFirstChildOfType(DOMNode *n, DOMNode::NodeType t);
00132 
00133 // --------------------------------------------------------------------------------
00134 //           Make a QName
00135 // --------------------------------------------------------------------------------
00136 
00137 safeBuffer DSIG_EXPORT &makeQName(safeBuffer & qname, safeBuffer &prefix, const char * localName);
00138 safeBuffer DSIG_EXPORT &makeQName(safeBuffer & qname, const XMLCh *prefix, const char * localName);
00139 
00140 // --------------------------------------------------------------------------------
00141 //           Gather text from children
00142 // --------------------------------------------------------------------------------
00143 
00144 void DSIG_EXPORT gatherChildrenText(DOMNode * parent, safeBuffer &output);
00145 
00146 // --------------------------------------------------------------------------------
00147 //           String decode/encode
00148 // --------------------------------------------------------------------------------
00149 
00150 /*
00151  * Distinguished names have a particular encoding that needs to be performed prior
00152  * to enclusion in the DOM
00153  */
00154 
00155 XMLCh * encodeDName(const XMLCh * toEncode);
00156 XMLCh * decodeDName(const XMLCh * toDecode);
00157 
00158 // --------------------------------------------------------------------------------
00159 //           String Functions 
00160 // --------------------------------------------------------------------------------
00161 
00162 inline
00163 bool strEquals (const XMLCh * str1, const XMLCh *str2) {
00164 
00165     return (XMLString::compareString(str1, str2) == 0);
00166 
00167 }
00168 
00169 inline
00170 bool strEquals (const char * str1, const char *str2) {
00171 
00172     return (XMLString::compareString(str1, str2) == 0);
00173 
00174 }
00175 
00176 inline 
00177 bool strEquals (const char * str1, const XMLCh * str2) {
00178 
00179     bool ret;
00180     XMLCh * str1XMLCh = XMLString::transcode(str1);
00181 
00182     if (str1XMLCh != NULL) {
00183 
00184         ret = (XMLString::compareString(str1XMLCh, str2) == 0);
00185         delete str1XMLCh;
00186 
00187     }
00188     else
00189         ret = false;
00190 
00191     return ret;
00192 
00193 }
00194 
00195 inline 
00196 bool strEquals (const XMLCh * str1, const char * str2) {
00197 
00198     bool ret;
00199     XMLCh * str2XMLCh = XMLString::transcode(str2);
00200 
00201     if (str2XMLCh != NULL) {
00202 
00203         ret = (XMLString::compareString(str1, str2XMLCh) == 0);
00204         delete [] str2XMLCh;
00205 
00206     }
00207     else
00208         ret = false;
00209 
00210     return ret;
00211 
00212 }
00213 
00214 #endif /* XSECDOMUTILS_HEADER */
00215 

Generated on Sun Aug 10 06:24:29 2003 for XML-Security-C by doxygen 1.3.2