00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2008 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 #ifndef INCL_KEY_VALUE_STORE 00037 #define INCL_KEY_VALUE_STORE 00038 /** @cond API */ 00039 /** @addtogroup Client */ 00040 /** @{ */ 00041 00042 #include "base/fscapi.h" 00043 #include "base/util/Enumeration.h" 00044 #include "base/util/StringBuffer.h" 00045 #include "base/globalsdef.h" 00046 00047 BEGIN_NAMESPACE 00048 00049 /** 00050 * This is the interface for the handling of key/value pairs. 00051 * Some implementations might store them in some kind of background 00052 * storage, others might only save them transiently in memory. 00053 * 00054 * This class defines the common methods that have to be 00055 * specialized by implementation on filesystem, registry, db... 00056 */ 00057 class KeyValueStore { 00058 00059 public: 00060 00061 /** 00062 * Virtual destructor 00063 */ 00064 virtual ~KeyValueStore() {} 00065 00066 /** 00067 * Returns the value of the given property 00068 * 00069 * @param prop - the property name 00070 * 00071 * @return A NULL StringBuffer in the returned implies that 00072 * the property was not set. Otherwise the value it was 00073 * set to is returned (which can be "", the empty string). 00074 */ 00075 virtual StringBuffer readPropertyValue(const char *prop) const = 0; 00076 00077 /** 00078 * Sets a property value. 00079 * 00080 * The value might be cached inside the implementation of this 00081 * interface. To ensure that it is stored persistently and to do 00082 * error checking, call save(). 00083 * 00084 * @param prop - the property name 00085 * @param value - the property value (zero terminated string) 00086 * 00087 * @return int 0 on success, an error code otherwise 00088 */ 00089 virtual int setPropertyValue(const char *prop, const char *value) = 0; 00090 00091 /** 00092 * Remove a certain property 00093 * 00094 * @param prop the name of the property which is to be removed 00095 * 00096 * @return int 0 on success, an error code otherwise 00097 */ 00098 virtual int removeProperty(const char *prop) = 0; 00099 00100 /** 00101 * Get all the properties that are currently defined. 00102 */ 00103 virtual Enumeration& getProperties() const = 0; 00104 00105 /** 00106 * Ensure that all properties are stored persistently. 00107 * If setting a property led to an error earlier, this 00108 * call will indicate the failure. 00109 * 00110 * @return 0 - success, failure otherwise 00111 */ 00112 virtual int save() = 0; 00113 }; 00114 00115 00116 END_NAMESPACE 00117 00118 /** @} */ 00119 /** @endcond */ 00120 #endif