/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:  
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "<WebSig>" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written 
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 2001, Institute for
 * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
 * The development of this software was partly funded by the European 
 * Commission in the <WebSig> project in the ISIS Programme. 
 * For more information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

/*
 * XSEC
 *
 * DSIGReferenceList := Class for Loading and storing a list of references
 *
 * Author(s): Berin Lautenbach
 *
 * $Id: DSIGReferenceList.hpp,v 1.3 2003/02/22 11:17:22 blautenb Exp $
 *
 */

#ifndef DSIGREFERENCELIST_INCLUDE
#define DSIGREFERENCELIST_INCLUDE


// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
//#include <dsig/DSIGReference.hpp>

// General includes
#include <vector>

class DSIGReference;

/**
 * @ingroup pubsig
 * @{
 */

/**
 * @brief Holds a list of reference elements.
 *
 * The library holds a Signature's list of references using this class.
 * Manifest lists are similarly held.  Developers can obtain the 
 * list from the Signature library using DSIGSignature::getReferenceList
 * and then iterate through each reference.
 *
 * The library also uses the List as the owner of the memory associated
 * with References.  So when a list is deleted, the references are deleted
 * at the same time.
 *
 */

class DSIG_EXPORT DSIGReferenceList {

public:

#if defined(XSEC_NO_NAMESPACES)
	typedef vector<DSIGReference *>			ReferenceListVectorType;
#else
	typedef std::vector<DSIGReference *>	ReferenceListVectorType;
#endif

#if defined(XSEC_SIZE_T_IN_NAMESPACE_STD)
	typedef std::size_t		size_type;
#else
	typedef size_t			size_type;
#endif

	/** @name Constructors and Destructors */
	//@{

	/**
	 * \brief Construct a list
	 */

	DSIGReferenceList();

	/**
	 * \brief Destroy a list.
	 *
	 * Standard destructor to close down the list.
	 *
	 * @note Destroys the references as well as the list
	 */

	~DSIGReferenceList();

	//@}

	/** @name List manipulation */
	//@{

	/**
	 * \brief Add a reference to the list
	 *
	 * Appends the reference to the end of the list and takes ownership
	 * of associated memory.
	 */
	
	void addReference(DSIGReference * ref);

	/**
	 * \brief Remove a reference from the list
	 *
	 * Removes the reference at the index point and returns a pointer
	 * to the reference removed.
	 *
	 * @note This also releases ownership.  It is the responsibility of
	 * the caller to ensure the reference is deleted.
	 *
	 * @note This does not currently delete the reference from the Signature 
	 *
	 * @param index Point in the list to remove
	 */
	
	DSIGReference * removeReference(size_type index);

	/**
	 * \brief Return a reference from the list
	 *
	 * Gets the reference at point index in the list
	 *
	 * @param index The pointer into the list
	 */

	DSIGReference * item(size_type index);

	/**
	 * \brief Find the number of elements in the list
	 *
	 * @returns The number of elements in the list
	 */

	size_type	getSize();

	/**
	 * \brief Clear out the list
	 *
	 * Simply clears the list.  Does not delete the reference elements themselves.
	 */
	
	bool empty();

	//@}

private:

	ReferenceListVectorType					m_referenceList;

};


#endif /* DSIGREFERENCELIST_INCLUDE */