00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 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_ODBC_KEY_VALUE_STORE 00037 #define INCL_ODBC_KEY_VALUE_STORE 00038 00043 #include "base/util/KeyValueStore.h" 00044 #include "client/SQLKeyValueStore.h" 00045 00046 BEGIN_NAMESPACE 00047 00048 class ODBCKeyValueStore : public SQLKeyValueStore { 00049 private: 00050 00051 // Connection * conn 00052 00053 protected: 00054 00055 /* 00056 * Execute a query to get a value, given the key. If a connection to 00057 * the database is not open, open it. 00058 * 00059 * @param sql - The sql command to execute. 00060 * 00061 * @return - The result of the query - an Enumeration of KeyValuePair s 00062 */ 00063 virtual ArrayListEnumeration * query(const StringBuffer & sql) const; 00064 00065 /* 00066 * Execute a non-select query. If a connection to the database is not open, 00067 * open it. 00068 * 00069 * @param sql - The sql command to execute. 00070 * 00071 * @return - Success or Failure 00072 */ 00073 virtual bool execute(const StringBuffer & sql); 00074 00075 public: 00076 00077 /* 00078 * Constructor 00079 * 00080 * @param uri - The location of the server 00081 * @param database - The database name 00082 * @param table - The table to be used 00083 * @param username - The username for authentication 00084 * @param password - The password for authentication 00085 * 00086 */ 00087 ODBCKeyValueStore(const char * uri, const char * database, const char * table, const char * username, const char * password); 00088 00089 /* 00090 * Destructor 00091 * 00092 * Subclasses MUST disconnect in their own destructors 00093 */ 00094 virtual ~ODBCKeyValueStore(); 00095 00096 /* 00097 * Connect to the database server. The connection should be stored 00098 * within the subclass and destroyed in disconnect(); If connect is called 00099 * while a connection exists, nothing should happen. 00100 * 00101 * @return - Success or Failure 00102 */ 00103 bool connect(); 00104 00105 /* 00106 * Disconnect from the database server. If the connection is not open, 00107 * do nothing. 00108 * 00109 * @return - Success or Failure 00110 */ 00111 bool disconnect(); 00112 }; 00113 00114 00115 END_NAMESPACE 00116 00119 #endif