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