added module storage

2004-07-23 17:25:51 +00:00 · 2004-07-23 17:25:51 +00:00 · 0a106a3bee
commit 0a106a3bee
parent b53bd7753c
16 changed files with 2331 additions and 0 deletions
--- a/livesupport/modules/storage/src/TestStorageClient.h
+++ b/livesupport/modules/storage/src/TestStorageClient.h
@ -0,0 +1,164 @@
+/*------------------------------------------------------------------------------
+
+    Copyright (c) 2004 Media Development Loan Fund
+ 
+    This file is part of the LiveSupport project.
+    http://livesupport.campware.org/
+    To report bugs, send an e-mail to bugs@campware.org
+ 
+    LiveSupport is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+  
+    LiveSupport is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+ 
+    You should have received a copy of the GNU General Public License
+    along with LiveSupport; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ 
+ 
+    Author   : $Author: maroy $
+    Version  : $Revision: 1.1 $
+    Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/storage/src/TestStorageClient.h,v $
+
+------------------------------------------------------------------------------*/
+#ifndef TestStorageClient_h
+#define TestStorageClient_h
+
+#ifndef __cplusplus
+#error This is a C++ include file
+#endif
+
+
+/* ============================================================ include files */
+
+#ifdef HAVE_CONFIG_H
+#include "configure.h"
+#endif
+
+#include <stdexcept>
+
+#include "LiveSupport/Core/Ptr.h"
+#include "LiveSupport/Core/UniqueId.h"
+#include "LiveSupport/Core/Playlist.h"
+#include "LiveSupport/Core/Configurable.h"
+#include "LiveSupport/Core/StorageClientInterface.h"
+
+
+namespace LiveSupport {
+namespace Storage {
+
+using namespace LiveSupport;
+using namespace LiveSupport::Core;
+
+/* ================================================================ constants */
+
+
+/* =================================================================== macros */
+
+
+/* =============================================================== data types */
+
+/**
+ *  A dummy storage client, only used for test purposes.
+ *
+ *  @author  $Author: maroy $
+ *  @version $Revision: 1.1 $
+ */
+class TestStorageClient :
+                    virtual public Configurable,
+                    virtual public StorageClientInterface
+{
+    private:
+        /**
+         *  The map type containing the playlists by their ids.
+         */
+        typedef std::map<const UniqueId::IdType, Ptr<Playlist>::Ref>
+                                                                    PlaylistMap;
+
+        /**
+         *  The name of the configuration XML elmenent used by TestStorageClient
+         */
+        static const std::string    configElementNameStr;
+
+        /**
+         *  The map holding all contained playlists, by ids.
+         */
+        PlaylistMap                 playlistMap;
+
+
+    public:
+        /**
+         *  A virtual destructor, as this class has virtual functions.
+         */
+        virtual
+        ~TestStorageClient(void)                        throw ()
+        {
+        }
+
+        /**
+         *  Return the name of the XML element this object expects
+         *  to be sent to a call to configure().
+         *  
+         *  @return the name of the expected XML configuration element.
+         */
+        static const std::string
+        getConfigElementName(void)                      throw ()
+        {
+            return configElementNameStr;
+        }
+
+        /**
+         *  Configure the object based on the XML element supplied.
+         *
+         *  @param element the XML element to configure the object from.
+         *  @exception std::invalid_argument if the supplied XML element
+         *             contains bad configuraiton information
+         *  @exception std::logic_error if the scheduler daemon has already
+         *             been configured, and can not be reconfigured.
+         */
+        virtual void
+        configure(const xmlpp::Element    & element)
+                                                throw (std::invalid_argument,
+                                                       std::logic_error);
+
+        /**
+         *  Tell if a playlist with a given id exists.
+         *
+         *  @param id the id of the playlist to check for.
+         *  @return true if a playlist with the specified id exists,
+         *          false otherwise.
+         */
+        virtual const bool
+        existsPlaylist(Ptr<const UniqueId>::Ref id) const
+                                                                throw ();
+
+        /**
+         *  Return a playlist with the specified id.
+         *
+         *  @param id the id of the playlist to return.
+         *  @return the requested playlist.
+         *  @exception std::invalid_argument if no playlist with the specified
+         *             id exists.
+         */
+        virtual Ptr<Playlist>::Ref
+        getPlaylist(Ptr<const UniqueId>::Ref id) const
+                                            throw (std::invalid_argument);
+};
+
+
+/* ================================================= external data structures */
+
+
+/* ====================================================== function prototypes */
+
+
+} // namespace Core
+} // namespace LiveSupport
+
+#endif // TestStorageClient_h
+