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_MANAGEMENT_NODE 00037 #define INCL_MANAGEMENT_NODE 00038 00040 #include "base/fscapi.h" 00041 #include "base/util/ArrayElement.h" 00042 #include "base/util/ArrayList.h" 00043 #include "spdm/constants.h" 00044 #include "base/util/StringBuffer.h" 00045 #include "base/util/StringMap.h" 00046 #include "base/globalsdef.h" 00047 00048 BEGIN_NAMESPACE 00049 00050 /* 00051 * This class represents a management node, so that a configuration 00052 * object under the device manager control. 00053 * This is an abstract class that defines the interface of platform 00054 * specific concrete implementations. 00055 * 00056 * See the design documents for more information. 00057 */ 00058 class ManagementNode : public ArrayElement { 00059 00060 protected: 00061 char *name; 00062 char *context; 00063 00064 // 00065 // Children are dinamically allocated inside this class and given to 00066 // the list. The list will delete all created objects at descruction 00067 // time. 00068 // 00069 ArrayList children; 00070 00071 /* 00072 * Set node attributes (name, context, fullcontext) from a Full Name string 00073 * 00074 */ 00075 int setFullName(const char *name); 00076 00077 public: 00078 00079 // -------------------------------------------- Constructors & Destructors 00080 00081 /* 00082 * Constructor. 00083 * 00084 * @param parent - a ManagementNode is usually under the context of a 00085 * parent node. 00086 * @param name - the node name 00087 * 00088 */ 00089 ManagementNode(const char* parent, const char* name); 00090 00091 /* 00092 * Constructor. 00093 * 00094 * @param fullcontext - the complete path to the node. The last 00095 * component is used as name, the rest as context 00096 * NOTE: the fullcontext MUST contain at least one "/" char 00097 * to correctly split context and name. 00098 * 00099 */ 00100 ManagementNode(const char* fullcontext); 00101 00102 /* Base class destructor */ 00103 virtual ~ManagementNode(); 00104 00105 // ----------------------------------------------------- Virtual methods 00106 00107 /* 00108 * Returns this node's child, at index specified 00109 * 00110 * @param index - the index of the child to get 00111 * 00112 * @return the node or NULL on failure. 00113 * Caller MUST NOT delete the object 00114 */ 00115 virtual ManagementNode * getChild(int index); 00116 00120 virtual ManagementNode * getChild(const char* name); 00121 00127 virtual void addChild(ManagementNode &child); 00128 00129 /* 00130 * Returns how many children belong to this node (how many have been added) 00131 */ 00132 virtual int getChildrenCount(); 00133 00134 /* 00135 * Returns the full node name in a newly allocated buffer, 00136 * caller must free it with delete []. 00137 * 00138 */ 00139 virtual char* createFullName(); 00140 00144 virtual const char *getName(); 00145 00146 // ---------------------------------------------------- Abstract methods 00147 00148 /* 00149 * Find how many children are defined for this node in the underlying 00150 * config system. 00151 */ 00152 virtual int getChildrenMaxCount() = 0; 00153 00154 /* Returns the names of the children nodes, in a new-allocated 00155 * string array 00156 * 00157 * @return NULL on failure 00158 */ 00159 virtual char **getChildrenNames() = 0; 00160 00161 /* 00162 * Returns the value of the given property 00163 * 00164 * @param property - the property name 00165 * 00166 * @return - the property value. MUST be deleted by the caller with delete []; 00167 * never NULL, for non-existant properties an empty string is returned 00168 */ 00169 virtual char* readPropertyValue(const char* property) = 0; 00170 00171 /* 00172 * Sets a property value. 00173 * 00174 * @param property - the property name 00175 * @param value - the property value (zero terminated string) 00176 */ 00177 virtual void setPropertyValue(const char* property, const char* value) = 0; 00178 00186 virtual int deletePropertyNode(const char* nodeName) = 0; 00187 00196 virtual StringMap* readAllProperties(); 00197 /* 00198 * Creates a new ManagementNode with the exact content of this object. 00199 * The new instance MUST be created with the C++ new opertator. 00200 */ 00201 virtual ArrayElement* clone() = 0; 00202 00203 }; 00204 00205 00206 END_NAMESPACE 00207 00209 #endif 00210