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_SYNCREPORT 00037 #define INCL_SYNCREPORT 00038 /** @cond API */ 00039 /** @addtogroup Client */ 00040 /** @{ */ 00041 00042 #include "base/fscapi.h" 00043 #include "base/Log.h" 00044 #include "base/util/StringBuffer.h" 00045 #include "spds/SyncSource.h" 00046 #include "spds/constants.h" 00047 #include "spds/SyncSourceReport.h" 00048 #include "spds/AbstractSyncConfig.h" 00049 00050 00051 // To notify if status comes from Client or server 00052 #define CLIENT "Client" 00053 #define SERVER "Server" 00054 #include "base/globalsdef.h" 00055 00056 BEGIN_NAMESPACE 00057 00058 00059 /** 00060 * The SyncReport class is used to summarize all results of a single synchronization. 00061 * During the synchronization process, all results about different operations 00062 * are stored in a SyncReport object, so the client will be able to get these 00063 * informations at the end. 00064 * Accessing this object a client can easily know for example the outcome 00065 * of each source synchronized, retrieve the number of items modified 00066 * on both sides, and the status code of each one. 00067 * 00068 */ 00069 class SyncReport { 00070 00071 private: 00072 00073 // The error code of the last error occurred. 00074 int lastErrorCode; 00075 00076 // The error message of the last error occurred. 00077 char* lastErrorMsg; 00078 00079 // Array of report for each SyncSource. 00080 SyncSourceReport* ssReport; 00081 unsigned int ssReportCount; 00082 00083 00084 /* 00085 * Function to initialize members. 00086 */ 00087 void initialize(); 00088 00089 /* 00090 * Assign this object with the given SyncReport 00091 * @param sr the syncReport object 00092 */ 00093 void assign(const SyncReport& sr); 00094 00095 00096 public: 00097 00098 SyncReport(); 00099 SyncReport(SyncReport& sr); 00100 // Constructor passing a given configuration: setSyncSourceReports() is called. 00101 SyncReport(AbstractSyncConfig& config); 00102 virtual ~SyncReport(); 00103 00104 /** 00105 * Returns the last error code for the whole sync; 00106 * there are other error codes attached to each 00107 * sync source. 00108 */ 00109 const int getLastErrorCode() const; 00110 00111 /** 00112 * the error description corresponding to getLastErrorCode(), 00113 * might be NULL even if an error occurred 00114 */ 00115 const char* getLastErrorMsg() const; 00116 00117 /** returns number of sync source reports stored in this report */ 00118 const unsigned int getSyncSourceReportCount() const; 00119 00120 void setLastErrorCode(const int code); 00121 void setLastErrorMsg (const char* msg); 00122 00123 /** return pointer to internal SyncSourceReport object given the source name */ 00124 SyncSourceReport* getSyncSourceReport(const char* name) const; 00125 00126 /** return pointer to internal SyncSourceReport object given its index (>=0, < getSyncSourceReportCount()) */ 00127 SyncSourceReport* getSyncSourceReport(unsigned int index) const; 00128 00129 00130 /** 00131 * Create ssReport array from config. 00132 * The array is allocated new, will be freed in the desctructor. 00133 * SyncSourceReports are all owned here by SyncReport, each 00134 * SyncSource object has a link to its correspondent (external) 00135 * report, but does not own it. 00136 * SyncSourceReports are linked during SyncClient::sync(). 00137 * 00138 * @param config: the SyncManager config to get source number/names. 00139 */ 00140 void setSyncSourceReports(AbstractSyncConfig& config); 00141 00142 /** 00143 * Appends a textual representation of the sync report at the end 00144 * of the string buffer, without clearing it first. 00145 * 00146 * @param str buffer to which text gets appended 00147 * @param verbose if true, then detailed information about each item is 00148 * printed, otherwise only a summary 00149 */ 00150 void toString(StringBuffer &str, bool verbose = false); 00151 00152 /** 00153 * Assign operator 00154 */ 00155 SyncReport& operator = (const SyncReport& sr) { 00156 assign(sr); 00157 return *this; 00158 } 00159 }; 00160 00161 00162 END_NAMESPACE 00163 00164 /** @} */ 00165 /** @endcond */ 00166 #endif 00167