![]() ![]() |
![]() |
File: [Pegasus] / pegasus / src / Pegasus / Config / ConfigFileHandler.h
(download)
Revision: 1.4, Fri May 31 23:57:01 2002 UTC (22 years, 1 month ago) by kumpf Branch: MAIN CVS Tags: VERSION_2_01_01, VERSION_2_00_RC_4, VERSION_2_00_RC_3, VERSION_2_00_RC_2, VERSION_2_00_RC_1, VERSION_2_00_BRANCH, VERSION_1_10 Changes since 1.3: +2 -2 lines HP-RK Update license header. |
//%///////////////////////////////////////////////////////////////////////////// // // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, // The Open Group, Tivoli Systems // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to // deal in the Software without restriction, including without limitation the // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or // sell copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // //============================================================================== // // Author: Nag Boranna (nagaraja_boranna@hp.com) // // Modified By: // //%///////////////////////////////////////////////////////////////////////////// #ifndef Pegasus_ConfigFileHandler_h #define Pegasus_ConfigFileHandler_h #include <cctype> #include <Pegasus/Config/Linkage.h> #include <Pegasus/Config/ConfigExceptions.h> #include <Pegasus/Config/ConfigFile.h> PEGASUS_NAMESPACE_BEGIN //////////////////////////////////////////////////////////////////////////////// // ConfigFileHandler Class //////////////////////////////////////////////////////////////////////////////// struct ConfigTable; /** Default file name for the current configuration. */ static char CURRENT_CONFIG_FILE [] = "cimserver_current.conf"; /** Default file name for the planned configuration. */ static char PLANNED_CONFIG_FILE [] = "cimserver_planned.conf"; /** This class provides methods to read/write config properties from the config file. */ class PEGASUS_CONFIG_LINKAGE ConfigFileHandler { public: /** Default constructor. @param currentFile current config file name. @param plannedFile planned config file name. @exception NoSuchFile if file cannot be opened. @exception FileNotReadable if file is not readable. */ ConfigFileHandler ( const String& currentFile = CURRENT_CONFIG_FILE, const String& plannedFile = PLANNED_CONFIG_FILE, const Boolean offLine = false); //throw (NoSuchFile, FileNotReadable); /** Destructor. */ ~ConfigFileHandler (); /** Overwrites config properties in the current config file with the the config properties from the planned config file. The content of the current config file will be copied in to a backup (.bak) file before copying planned file contents over the current file. @exception CannotRenameFile if failed to create the backup file. */ void copyPlannedFileOverCurrentFile(); //throw (CannotRenameFile); /** Load the config properties from the config files. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadAllConfigProperties (); //throw (ConfigFileSyntaxError); /** Load the config properties from the current config file. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadCurrentConfigProperties (); //throw (ConfigFileSyntaxError); /** Load the config properties from the planned config file. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadPlannedConfigProperties (); //throw (ConfigFileSyntaxError); /** Update the specified property name and value in the current config file. @param name name of the property to be updated. @param value value of the property to be updated. @param unset specifies whether the property should be updated or unset. @return true if the property updated successfully, else false. */ Boolean updateCurrentValue( const String& name, const String& value, Boolean unset); /** Update the specified property name and value in the planned config file. @param name name of the property to be updated. @param value value of the property to be updated. @param unset specifies whether the property should be updated or unset. @return true if the property updated successfully, else false. */ Boolean updatePlannedValue( const String& name, const String& value, Boolean unset); /** Get the current property value for the specified property name. @param name name of the property. @param value value of the property (output parameter). @return true if the property is found and returned, false otherwise. */ Boolean getCurrentValue (const String& name, String& value); /** Get the planned property value for the specified property name. @param name name of the property. @param value value of the property (output parameter). @return true if the property is found and returned, false otherwise. */ Boolean getPlannedValue (const String& name, String& value); /** Get all current property names. @param propertyNames string array to hold the property names. */ void getAllCurrentPropertyNames (Array<String>& propertyNames); /** Get all current property names and values. @param propertyNames string array to hold the property names. @param propertyValues string array to hold the property values. */ void getAllCurrentProperties ( Array<String>& propertyNames, Array<String>& propertyValues); /** Get all planned config property names. @param propertyNames string array to hold the property names. */ void getAllPlannedPropertyNames (Array<String>& propertyNames); /** Get all planned config property names and values. @param propertyNames string array to hold the property names. @param propertyValues string array to hold the property values. */ void getAllPlannedProperties( Array<String>& propertyNames, Array<String>& propertyValues); private: /** Tables to store the current and planned config properties. */ ConfigTable* _currentConfig; ConfigTable* _plannedConfig; /** File handlers for the current and planned config files. */ ConfigFile* _currentConfFile; ConfigFile* _plannedConfFile; /** Flag indicating whether the current config files exists or not. */ Boolean _currentFileExist; /** Flag indicating whether the planned config files exists or not. */ Boolean _plannedFileExist; /** Flag indicating whether config file is accessed off line or not. */ Boolean _offLine; }; PEGASUS_NAMESPACE_END #endif /* Pegasus_ConfigFileHandler_h */
No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |