(file) Return to NormalizationPropertyOwner.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Config

  1 karl  1.2 //%2005////////////////////////////////////////////////////////////////////////
  2 chip  1.1 //
  3           // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4           // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5           // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6           // IBM Corp.; EMC Corporation, The Open Group.
  7           // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9 karl  1.2 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 chip  1.1 //
 12           // Permission is hereby granted, free of charge, to any person obtaining a copy
 13           // of this software and associated documentation files (the "Software"), to
 14           // deal in the Software without restriction, including without limitation the
 15           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 16           // sell copies of the Software, and to permit persons to whom the Software is
 17           // furnished to do so, subject to the following conditions:
 18 karl  1.2 // 
 19 chip  1.1 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 20           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 21           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 22           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 23           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 24           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 25           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 26           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 27           //
 28           //==============================================================================
 29           //
 30           // Author: Chip Vincent (cvincent@us.ibm.com)
 31           //
 32           // Modified By:
 33           //
 34           //%/////////////////////////////////////////////////////////////////////////////
 35           
 36           #ifndef Pegasus_NormalizationPropertyOwner_h
 37           #define Pegasus_NormalizationPropertyOwner_h
 38           
 39           #include <Pegasus/Config/ConfigPropertyOwner.h>
 40 chip  1.1 
 41           #include <Pegasus/Common/AutoPtr.h>
 42           
 43           PEGASUS_NAMESPACE_BEGIN
 44           
 45           /**
 46               This is NormalizationPropertyOwner class that extends ConfigPropertyOwner
 47               class.
 48           */
 49           class PEGASUS_CONFIG_LINKAGE NormalizationPropertyOwner : public ConfigPropertyOwner
 50           {
 51           public:
 52               NormalizationPropertyOwner(void);
 53           
 54               /**
 55               Initialize the config properties.
 56           
 57               This method is expected to be called only once at the start of the
 58               CIMOM. It initializes the properties with the default values.
 59               */
 60               void initialize(void);
 61 chip  1.1 
 62               /**
 63               Get information about the specified property.
 64           
 65               @param propertyName   The name of the property.
 66               @param propertyInfo   List to store the property info.
 67               @exception UnrecognizedConfigProperty  if the property is not defined.
 68               */
 69               void getPropertyInfo(const String & name, Array<String> & propertyInfo);
 70           
 71               /**
 72               Get default value of the specified property.
 73           
 74               @param  name         The name of the property.
 75               @return string containing the default value of the property specified.
 76               @exception UnrecognizedConfigProperty  if the property is not defined.
 77               */
 78               const String getDefaultValue(const String & name);
 79           
 80               /**
 81               Get current value of the specified property.
 82 chip  1.1 
 83               @param  name         The name of the property.
 84               @return string containing the currnet value of the property specified.
 85               @exception UnrecognizedConfigProperty  if the property is not defined.
 86               */
 87               const String getCurrentValue(const String & name);
 88           
 89               /**
 90               Get planned value of the specified property.
 91           
 92               @param  name         The name of the property.
 93               @return string containing the planned value of the property specified.
 94               @exception UnrecognizedConfigProperty  if the property is not defined.
 95               */
 96               const String getPlannedValue(const String & name);
 97           
 98               /**
 99               Init current value of the specified property to the specified value.
100               This method is expected to be called only once at the start of the
101               CIMOM. The property value will be initialized irrespective of whether
102               the property is dynamic or not.
103 chip  1.1 
104               @param  name         The name of the property.
105               @param  value        The current value of the property.
106               @exception     UnrecognizedConfigProperty  if the property is not defined.
107               @exception     InvalidPropertyValue  if the property value is not valid.
108               */
109               void initCurrentValue(const String & name, const String & value);
110           
111               /**
112               Init planned value of the specified property to the specified value.
113               This method is expected to be called only once at the start of the
114               CIMOM. The property value will be initialized irrespective of whether
115               the property is dynamic or not.
116           
117               @param  name         The name of the property.
118               @param  value        The planned value of the property.
119               @exception     UnrecognizedConfigProperty  if the property is not defined.
120               @exception     InvalidPropertyValue  if the property value is not valid.
121               */
122               void initPlannedValue(const String & name, const String & value);
123           
124 chip  1.1     /**
125               Update current value of the specified property to the specified value.
126               The property value will be updated only if the property is dynamically
127               updatable.
128           
129               @param  name         The name of the property.
130               @param  value        The current value of the property.
131               @exception     NonDynamicConfigProperty  if the property is not dynamic.
132               @exception     InvalidPropertyValue  if the property value is not valid.
133               @exception     UnrecognizedConfigProperty  if the property is not defined.
134               */
135               void updateCurrentValue(const String & name, const String & value);
136           
137               /**
138               Update planned value of the specified property to the specified value.
139           
140               @param  name         The name of the property.
141               @param  value        The planned value of the property.
142               @exception     InvalidPropertyValue  if the property value is not valid.
143               @exception     UnrecognizedConfigProperty  if the property is not defined.
144               */
145 chip  1.1     void updatePlannedValue(const String & name, const String & value);
146           
147               /**
148               Checks to see if the given value is valid or not.
149           
150               @param  name         The name of the property.
151               @param  value        The value of the property to be validated.
152               @return Boolean      True if the specified value for the property is valid.
153               @exception UnrecognizedConfigProperty  if the property is not defined.
154               */
155               Boolean isValid(const String & name, const String & value);
156           
157               /**
158               Checks to see if the specified property is dynamic or not.
159           
160               @param  name         The name of the property.
161               @return Boolean      True if the specified property is dynamic.
162               @exception UnrecognizedConfigProperty  if the property is not defined.
163               */
164               Boolean isDynamic(const String & name);
165           
166 chip  1.1 private:
167               struct ConfigProperty * _lookupConfigProperty(const String & name);
168           
169               AutoPtr<struct ConfigProperty> _providerObjectNormalizationEnabled;
170               AutoPtr<struct ConfigProperty> _providerObjectNormalizationModuleExclusions;
171           
172           };
173           
174           PEGASUS_NAMESPACE_END
175           
176           #endif

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2