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

DSIGKeyInfoList.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  * DSIGKeyInfoList := Class for Loading and storing a list of KeyInfo elements
00064  *                   
00065  *
00066  * Author(s): Berin Lautenbach
00067  *
00068  * $ID$
00069  *
00070  * $LOG$
00071  *
00072  */
00073 
00074 #ifndef DSIGKEYINFOLIST_INCLUDE
00075 #define DSIGKEYINFOLIST_INCLUDE
00076 
00077 
00078 // XSEC Includes
00079 #include <xsec/framework/XSECDefs.hpp>
00080 #include <xsec/dsig/DSIGKeyInfo.hpp>
00081 #include <xsec/utils/XSECSafeBufferFormatter.hpp>
00082 #include <xsec/enc/XSECCryptoKey.hpp>
00083 
00084 // Xerces
00085 #include <xercesc/dom/DOM.hpp>
00086 
00087 // General includes
00088 #include <vector>
00089 
00090 class DSIGSignature;
00091 
00103 class DSIG_EXPORT DSIGKeyInfoList {
00104 
00105 public:
00106 
00107 #if defined(XSEC_NO_NAMESPACES)
00108     typedef vector<DSIGKeyInfo *>           KeyInfoListVectorType;
00109 #else
00110     typedef std::vector<DSIGKeyInfo *>      KeyInfoListVectorType;
00111 #endif
00112 
00113 #if defined(XSEC_SIZE_T_IN_NAMESPACE_STD)
00114     typedef std::size_t     size_type;
00115 #else
00116     typedef size_t          size_type;
00117 #endif
00118 
00121 
00132     DSIGKeyInfoList(DSIGSignature * sig);
00133 
00138     ~DSIGKeyInfoList();
00139 
00141 
00144 
00151     size_t getSize();
00152 
00153     /*
00154      * \brief Get an item
00155      *
00156      * Returns the item at index point in the list
00157      *
00158      * @note This is an internal function and should not be called directly
00159      *
00160      * @param index Pointer into the list
00161      * @returns The indicated element or 0 if it does not exist.
00162      */
00163 
00164     DSIGKeyInfo * item(size_type index);
00165 
00167 
00170 
00180     void addKeyInfo(DSIGKeyInfo * ref);
00181 
00194     bool addXMLKeyInfo(DOMNode *ki);
00195 
00196     /*
00197      * \brief Remove a KeyInfo from the list
00198      *
00199      * Removes the KeyInfo element at the indicated index point in the list
00200      *
00201      * @param index Pointer in the list to remove element from
00202      * @returns The removed KeyInfo element
00203      */
00204 
00205     DSIGKeyInfo * removeKeyInfo(size_type index);
00206 
00215     void setParentSignature(DSIGSignature * sig) {mp_parentSignature = sig;}
00216 
00225     void empty();
00226     
00233     bool isEmpty();
00234 
00236 
00237 private:
00238 
00239     DSIGKeyInfoList();
00240 
00241     KeyInfoListVectorType                   m_keyInfoList;
00242     DSIGSignature                           * mp_parentSignature;
00243     // KeyInfoListVectorType::iterator          m_iterator;
00244 };
00245 
00246 
00247 #endif /* DSIGKEYINFOLIST_INCLUDE */

Generated on Sat Aug 9 18:36:25 2003 for XML-Security-C by doxygen 1.3.2