pegasus/src/Pegasus/Config/NormalizationPropertyOwner.h - annotate

Return to NormalizationPropertyOwner.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Config

1 martin 1.8 //%LICENSE////////////////////////////////////////////////////////////////
2 martin 1.9 //
3 martin 1.8 // Licensed to The Open Group (TOG) under one or more contributor license 4 // agreements. Refer to the OpenPegasusNOTICE.txt file distributed with 5 // this work for additional information regarding copyright ownership. 6 // Each contributor licenses this file to you under the OpenPegasus Open 7 // Source License; you may not use this file except in compliance with the 8 // License.
9 martin 1.9 //
10 martin 1.8 // Permission is hereby granted, free of charge, to any person obtaining a 11 // copy of this software and associated documentation files (the "Software"), 12 // to deal in the Software without restriction, including without limitation 13 // the rights to use, copy, modify, merge, publish, distribute, sublicense, 14 // and/or sell copies of the Software, and to permit persons to whom the 15 // Software is furnished to do so, subject to the following conditions:
16 martin 1.9 //
17 martin 1.8 // The above copyright notice and this permission notice shall be included 18 // in all copies or substantial portions of the Software.
19 martin 1.9 //
20 martin 1.8 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 martin 1.9 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 martin 1.8 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 23 // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 24 // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 25 // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 26 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 martin 1.9 //
28 martin 1.8 //////////////////////////////////////////////////////////////////////////
29 chip 1.1 // 30 //%///////////////////////////////////////////////////////////////////////////// 31 32 #ifndef Pegasus_NormalizationPropertyOwner_h 33 #define Pegasus_NormalizationPropertyOwner_h 34 35 #include <Pegasus/Config/ConfigPropertyOwner.h> 36 37 #include <Pegasus/Common/AutoPtr.h> 38 39 PEGASUS_NAMESPACE_BEGIN 40 41 /** 42 This is NormalizationPropertyOwner class that extends ConfigPropertyOwner 43 class. 44 */
45 kumpf 1.7 class PEGASUS_CONFIG_LINKAGE NormalizationPropertyOwner : 46 public ConfigPropertyOwner
47 chip 1.1 { 48 public:
49 kumpf 1.7 NormalizationPropertyOwner();
50 chip 1.1 51 /**
52 kumpf 1.7 Initialize the config properties.
53 chip 1.1
54 kumpf 1.7 This method is expected to be called only once at the start of the 55 CIMOM. It initializes the properties with the default values.
56 chip 1.1 */
57 kumpf 1.7 void initialize();
58 chip 1.1 59 /**
60 kumpf 1.7 Get information about the specified property.
61 chip 1.1
62 kumpf 1.7 @param propertyName The name of the property. 63 @param propertyInfo List to store the property info. 64 @exception UnrecognizedConfigProperty if the property is not defined.
65 chip 1.1 */
66 kumpf 1.7 void getPropertyInfo( 67 const String& name, 68 Array<String>& propertyInfo) const;
69 chip 1.1 70 /**
71 kumpf 1.7 Get default value of the specified property.
72 chip 1.1
73 kumpf 1.7 @param name The name of the property. 74 @return string containing the default value of the property specified. 75 @exception UnrecognizedConfigProperty if the property is not defined.
76 chip 1.1 */
77 kumpf 1.7 String getDefaultValue(const String& name) const;
78 chip 1.1 79 /**
80 kumpf 1.7 Get current value of the specified property.
81 chip 1.1
82 kumpf 1.7 @param name The name of the property. 83 @return string containing the current value of the property specified. 84 @exception UnrecognizedConfigProperty if the property is not defined.
85 chip 1.1 */
86 kumpf 1.7 String getCurrentValue(const String& name) const;
87 chip 1.1 88 /**
89 kumpf 1.7 Get planned value of the specified property.
90 chip 1.1
91 kumpf 1.7 @param name The name of the property. 92 @return string containing the planned value of the property specified. 93 @exception UnrecognizedConfigProperty if the property is not defined.
94 chip 1.1 */
95 kumpf 1.7 String getPlannedValue(const String& name) const;
96 chip 1.1 97 /**
98 kumpf 1.7 Init current value of the specified property to the specified value. 99 This method is expected to be called only once at the start of the 100 CIMOM. The property value will be initialized irrespective of whether 101 the property is dynamic or not.
102 chip 1.1
103 kumpf 1.7 @param name The name of the property. 104 @param value The current value of the property. 105 @exception UnrecognizedConfigProperty if the property is not defined. 106 @exception InvalidPropertyValue if the property value is not valid.
107 chip 1.1 */
108 kumpf 1.7 void initCurrentValue(const String& name, const String& value);
109 chip 1.1 110 /**
111 kumpf 1.7 Init planned value of the specified property to the specified value. 112 This method is expected to be called only once at the start of the 113 CIMOM. The property value will be initialized irrespective of whether 114 the property is dynamic or not.
115 chip 1.1
116 kumpf 1.7 @param name The name of the property. 117 @param value The planned value of the property. 118 @exception UnrecognizedConfigProperty if the property is not defined. 119 @exception InvalidPropertyValue if the property value is not valid.
120 chip 1.1 */
121 kumpf 1.7 void initPlannedValue(const String& name, const String& value);
122 chip 1.1 123 /**
124 kumpf 1.7 Update current value of the specified property to the specified value. 125 The property value will be updated only if the property is dynamically 126 updatable.
127 chip 1.1
128 kumpf 1.7 @param name The name of the property. 129 @param value The current value of the property.
130 venkat.puvvada 1.10 @param userName User requesting the update.
131 venkat.puvvada 1.11 @param timeoutSeconds Timeout in seconds to complete the update.
132 kumpf 1.7 @exception NonDynamicConfigProperty if the property is not dynamic. 133 @exception InvalidPropertyValue if the property value is not valid. 134 @exception UnrecognizedConfigProperty if the property is not defined.
135 chip 1.1 */
136 venkat.puvvada 1.10 void updateCurrentValue( 137 const String& name, 138 const String& value,
139 venkat.puvvada 1.11 const String& userName, 140 Uint32 timeoutSeconds);
141 chip 1.1 142 /**
143 kumpf 1.7 Update planned value of the specified property to the specified value.
144 chip 1.1
145 kumpf 1.7 @param name The name of the property. 146 @param value The planned value of the property. 147 @exception InvalidPropertyValue if the property value is not valid. 148 @exception UnrecognizedConfigProperty if the property is not defined.
149 chip 1.1 */
150 kumpf 1.7 void updatePlannedValue(const String& name, const String& value);
151 chip 1.1 152 /**
153 kumpf 1.7 Checks to see if the given value is valid or not.
154 chip 1.1
155 kumpf 1.7 @param name The name of the property. 156 @param value The value of the property to be validated. 157 @return Boolean True if the specified value for the property is valid. 158 @exception UnrecognizedConfigProperty if the property is not defined.
159 chip 1.1 */
160 kumpf 1.7 Boolean isValid(const String& name, const String& value) const;
161 chip 1.1 162 /**
163 kumpf 1.7 Checks to see if the specified property is dynamic or not.
164 chip 1.1
165 kumpf 1.7 @param name The name of the property. 166 @return Boolean True if the specified property is dynamic. 167 @exception UnrecognizedConfigProperty if the property is not defined.
168 chip 1.1 */
169 kumpf 1.7 Boolean isDynamic(const String& name)const;
170 chip 1.1 171 private:
172 kumpf 1.7 struct ConfigProperty* _lookupConfigProperty(const String& name) const;
173 chip 1.1 174 AutoPtr<struct ConfigProperty> _providerObjectNormalizationEnabled; 175 AutoPtr<struct ConfigProperty> _providerObjectNormalizationModuleExclusions; 176 }; 177 178 PEGASUS_NAMESPACE_END 179 180 #endif

No CVS admin address has been configured