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

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