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  * Copyright (c) 2002 Berin Lautenbach.  All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  *
00010  * 1. Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *
00018  * 3. The end-user documentation included with the redistribution,
00019  *    if any, must include the following acknowledgment:
00020  *       "This product includes software developed by
00021  *                   Berin Lautenbach"
00022  *    Alternately, this acknowledgment may appear in the software itself,
00023  *    if and wherever such third-party acknowledgments normally appear.
00024  *
00025  * 4. The names "XSEC", "xml-security-c" and Berin Lautenbach must
00026  *    not be used to endorse or promote products derived from this
00027  *    software without prior written permission. For written
00028  *    permission, please contact berin@users.sourceforge.net.
00029  *
00030  * 5. Products derived from this software may not be called "xml-security-c",
00031  *    nor may "xml-security-c" appear in their name, without prior written
00032  *    permission of Berin Lautenbach.
00033  *
00034  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00035  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00036  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00037  * DISCLAIMED.  IN NO EVENT SHALL BERIN LAUTENBACH OR OTHER
00038  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00039  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00040  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00041  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00042  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00043  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00044  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00045  * SUCH DAMAGE.
00046  * ====================================================================
00047  */
00048 
00049 /*
00050  * XSEC
00051  *
00052  * DSIGKeyInfoList := Class for Loading and storing a list of KeyInfo elements
00053  *                   
00054  *
00055  */
00056 
00057 #ifndef DSIGKEYINFOLIST_INCLUDE
00058 #define DSIGKEYINFOLIST_INCLUDE
00059 
00060 
00061 // XSEC Includes
00062 #include <xsec/framework/XSECDefs.hpp>
00063 #include <xsec/dsig/DSIGKeyInfo.hpp>
00064 #include <xsec/utils/XSECSafeBufferFormatter.hpp>
00065 #include <xsec/enc/XSECCryptoKey.hpp>
00066 
00067 // Xerces
00068 #include <xercesc/dom/DOM.hpp>
00069 
00070 // General includes
00071 #include <vector>
00072 
00073 class DSIGSignature;
00074 
00086 class DSIG_EXPORT DSIGKeyInfoList {
00087 
00088 public:
00089 
00090 #if defined(XSEC_NO_NAMESPACES)
00091     typedef vector<DSIGKeyInfo *>           KeyInfoListVectorType;
00092 #else
00093     typedef std::vector<DSIGKeyInfo *>      KeyInfoListVectorType;
00094 #endif
00095 
00096 #if defined(XSEC_SIZE_T_IN_NAMESPACE_STD)
00097     typedef std::size_t     size_type;
00098 #else
00099     typedef size_t          size_type;
00100 #endif
00101 
00104 
00115     DSIGKeyInfoList(DSIGSignature * sig);
00116 
00121     ~DSIGKeyInfoList();
00122 
00124 
00127 
00134     size_t getSize();
00135 
00136     /*
00137      * \brief Get an item
00138      *
00139      * Returns the item at index point in the list
00140      *
00141      * @note This is an internal function and should not be called directly
00142      *
00143      * @param index Pointer into the list
00144      * @returns The indicated element or 0 if it does not exist.
00145      */
00146 
00147     DSIGKeyInfo * item(size_type index);
00148 
00150 
00153 
00163     void addKeyInfo(DSIGKeyInfo * ref);
00164 
00177     bool addXMLKeyInfo(DOMNode *ki);
00178 
00179     /*
00180      * \brief Remove a KeyInfo from the list
00181      *
00182      * Removes the KeyInfo element at the indicated index point in the list
00183      *
00184      * @param index Pointer in the list to remove element from
00185      * @returns The removed KeyInfo element
00186      */
00187 
00188     DSIGKeyInfo * removeKeyInfo(size_type index);
00189 
00198     void setParentSignature(DSIGSignature * sig) {mp_parentSignature = sig;}
00199 
00208     void empty();
00209     
00216     bool isEmpty();
00217 
00219 
00220 private:
00221 
00222     DSIGKeyInfoList();
00223 
00224     KeyInfoListVectorType                   m_keyInfoList;
00225     DSIGSignature                           * mp_parentSignature;
00226     // KeyInfoListVectorType::iterator          m_iterator;
00227 };
00228 
00229 
00230 #endif /* DSIGKEYINFOLIST_INCLUDE */

Generated on Sat Jan 11 20:34:06 2003 for XML-Security-C by doxygen1.2.15