src/include/posix/spdm/DeviceManagementNode.h

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_POSIX_DEVICE_MANAGEMENT_NODE
00037 #define INCL_POSIX_DEVICE_MANAGEMENT_NODE
00038 
00040 #include "base/fscapi.h"
00041 #include "base/util/ArrayElement.h"
00042 #include "spdm/ManagementNode.h"
00043 
00044 
00045 /*
00046  * File-based implementation of ManagementNode.
00047  * Each node is mapped to one file, located in
00048  *    $HOME/.sync4j/<node>
00049  * with entries of the type
00050  * <property>\s*=\s*<value>\n
00051  *
00052  * Comments look like:
00053  * \s*# <comment>
00054  */
00055 class DeviceManagementNode : public ManagementNode {
00056     ArrayList *lines;
00057     BOOL modified;
00058     char *prefix;
00059 
00060     class line : public ArrayElement {
00061         char *str;
00062 
00063         public:
00064             line(const char *newStr = NULL) { str = NULL; setLine(newStr); }
00065             ~line() { free(str); }
00066             ArrayElement *clone() { return new line(str); }
00067 
00068             const char *getLine() { return str; }
00069             void setLine(const char *newStr) { if (str) { free(str); } str = strdup(newStr ? newStr : ""); }
00070     };
00071 
00072     // the application's working directory
00073     int cwdfd;
00074 
00075     // change into directory which holds config file,
00076     // creating directories if necessary for writing
00077     //
00078     // @return TRUE for success, FALSE for error - call returnFromDir() in both cases
00079     BOOL gotoDir(BOOL read);
00080 
00081     // return to original directory after a gotoDir()
00082     void returnFromDir();
00083 
00084     // copy content of "lines" to or from file
00085     void update(BOOL read);
00086 
00087     public:
00088 
00089         // ------------------------------------------ Constructors & destructors
00090 
00099         DeviceManagementNode(const char* parent, const char *leafName);
00100         DeviceManagementNode(const char* fullName);
00101 
00102         DeviceManagementNode(const DeviceManagementNode &other);
00103         virtual ~DeviceManagementNode();
00104 
00105 
00106         // ----------------------------------------------------- Virtual methods
00107 
00108         /*
00109          * Returns the value of the given property
00110          *
00111          * @param property - the property name
00112          */
00113         virtual char* readPropertyValue(const char* property);
00114 
00115 
00116         /*
00117          * Sets a property value.
00118          *
00119          * @param property - the property name
00120          * @param value - the property value (zero terminated string)
00121          */
00122         virtual void setPropertyValue(const char* property, const char* value);
00123 
00124         /*
00125          * Returns the children's name of the parent node.
00126          */
00127         char **getChildrenNames();
00128 
00129         /*
00130          * Find how many children are defined for this node in the underlying
00131          * config system.
00132          */
00133         virtual int getChildrenMaxCount();
00134 
00135         /*
00136          * Creates a new ManagementNode with the exact content of this object.
00137          * The new instance MUST be created with the C++ new opertator.
00138          */
00139         virtual ArrayElement* clone();
00140 
00141 
00142 };
00143 
00145 #endif

Generated on Thu Mar 6 14:25:06 2008 for Funambol C++ Client Library by  doxygen 1.5.2