Return to ConfigFileHandler.h CVS log | Up to [Pegasus] / pegasus / src / Pegasus / Config |
File: [Pegasus] / pegasus / src / Pegasus / Config / ConfigFileHandler.h
(download)
Revision: 1.16, Tue Nov 14 18:34:49 2006 UTC (17 years, 7 months ago) by kumpf Branch: MAIN CVS Tags: TASK_PEP328_SOLARIS_NEVADA_PORT, TASK-PEP328_SOLARIS_NEVADA_PORT_v2-root, TASK-PEP328_SOLARIS_NEVADA_PORT_v2-branch, TASK-PEP328_SOLARIS_NEVADA_PORT-root, TASK-PEP328_SOLARIS_NEVADA_PORT-branch, TASK-PEP328_SOLARIS_IX86_CC_PORT-root, TASK-PEP328_SOLARIS_IX86_CC_PORT-branch-v2, TASK-PEP328_SOLARIS_IX86_CC_PORT-branch, TASK-PEP311_WSMan-root, TASK-PEP311_WSMan-branch, TASK-PEP305_VXWORKS-root, TASK-PEP305_VXWORKS-branch-pre-solaris-port, TASK-PEP305_VXWORKS-branch-post-solaris-port, TASK-PEP305_VXWORKS-branch-beta2, TASK-PEP305_VXWORKS-branch, TASK-PEP305_VXWORKS-2008-10-23, TASK-PEP291_IPV6-root, TASK-PEP291_IPV6-branch, TASK-PEP286_PRIVILEGE_SEPARATION-root, TASK-PEP286_PRIVILEGE_SEPARATION-branch, TASK-PEP274_dacim-root, TASK-PEP274_dacim-merged_out_to_branch, TASK-PEP274_dacim-merged_out_from_trunk, TASK-PEP274_dacim-merged_in_to_trunk, TASK-PEP274_dacim-merged_in_from_branch, TASK-PEP274_dacim-branch, TASK-Bug2102_RCMPIWindows-root, TASK-Bug2102_RCMPIWindows-merged_out_to_branch, TASK-Bug2102_RCMPIWindows-merged_out_from_trunk, TASK-Bug2102_RCMPIWindows-merged_in_to_trunk, TASK-Bug2102_RCMPIWindows-merged_in_from_branch, TASK-Bug2102_RCMPIWindows-branch, TASK-Bug2102Final-root, TASK-Bug2102Final-merged_out_to_branch, TASK-Bug2102Final-merged_out_from_trunk, TASK-Bug2102Final-merged_in_to_trunk, TASK-Bug2102Final-merged_in_from_branch, TASK-Bug2102Final-branch, TASK-BUG7240-root, TASK-BUG7240-branch, TASK-BUG7146_SqlRepositoryPrototype-root, TASK-BUG7146_SqlRepositoryPrototype-merged_out_to_branch, TASK-BUG7146_SqlRepositoryPrototype-merged_out_from_trunk, TASK-BUG7146_SqlRepositoryPrototype-merged_in_to_trunk, TASK-BUG7146_SqlRepositoryPrototype-merged_in_from_branch, TASK-BUG7146_SqlRepositoryPrototype-branch, RELEASE_2_8_2-RC1, RELEASE_2_8_2, RELEASE_2_8_1-RC1, RELEASE_2_8_1, RELEASE_2_8_0_BETA, RELEASE_2_8_0-RC2, RELEASE_2_8_0-RC1, RELEASE_2_8_0-FC, RELEASE_2_8_0, RELEASE_2_8-root, RELEASE_2_8-branch, RELEASE_2_7_3-RC1, RELEASE_2_7_3, RELEASE_2_7_2-RC1, RELEASE_2_7_2, RELEASE_2_7_1-RC1, RELEASE_2_7_1, RELEASE_2_7_0-RC1, RELEASE_2_7_0-BETA, RELEASE_2_7_0, RELEASE_2_7-root, RELEASE_2_7-branch, RELEASE_2_6_3-RC2, RELEASE_2_6_3-RC1, RELEASE_2_6_3, RELEASE_2_6_2-RC1, RELEASE_2_6_2, RELEASE_2_6_1-RC1, RELEASE_2_6_1, RELEASE_2_6_0-RC1, RELEASE_2_6_0, RELEASE_2_6-root, RELEASE_2_6-branch-clean, RELEASE_2_6-branch, PEP286_PRIVILEGE_SEPARATION_ROOT, PEP286_PRIVILEGE_SEPARATION_CODE_FREEZE, PEP286_PRIVILEGE_SEPARATION_BRANCH, PEP286_PRIVILEGE_SEPARATION_1 Changes since 1.15: +0 -10 lines BUG#: 5850 TITLE: Source files do not meet chksrc requirements DESCRIPTION: Remove tab characters and author names and shorten lines that are wider than 80 characters. |
//%2006//////////////////////////////////////////////////////////////////////// // // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; // IBM Corp.; EMC Corporation, The Open Group. // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; Symantec Corporation; The Open Group. // // 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. // //============================================================================== // //%///////////////////////////////////////////////////////////////////////////// #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> #include <Pegasus/Common/Constants.h> #include <Pegasus/Common/AutoPtr.h> PEGASUS_NAMESPACE_BEGIN //////////////////////////////////////////////////////////////////////////////// // ConfigFileHandler Class //////////////////////////////////////////////////////////////////////////////// struct ConfigTable; /** 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 = PEGASUS_CURRENT_CONFIG_FILE_PATH, const String& plannedFile = PEGASUS_PLANNED_CONFIG_FILE_PATH, const Boolean offLine = false); /** 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. @exception CannotOpenFile if failed to set permissions on the config file. */ void copyPlannedFileOverCurrentFile(); /** Load the config properties from the config files. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadAllConfigProperties (); /** Load the config properties from the current config file. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadCurrentConfigProperties (); /** Load the config properties from the planned config file. @exception ConfigFileSyntaxError if file contains a syntax error. */ void loadPlannedConfigProperties (); /** 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 CIMName& 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 CIMName& 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 CIMName& name, String& value) const; /** 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 CIMName& name, String& value) const; /** Get all current property names. @param propertyNames string array to hold the property names. */ void getAllCurrentPropertyNames (Array<CIMName>& 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<CIMName>& propertyNames, Array<String>& propertyValues); /** Get all planned config property names. @param propertyNames string array to hold the property names. */ void getAllPlannedPropertyNames (Array<CIMName>& 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<CIMName>& 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. */ AutoPtr<ConfigFile> _currentConfFile; //PEP101 AutoPtr<ConfigFile> _plannedConfFile; //PEP101 /** 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 |