(file) Return to NormalizationPropertyOwner.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Config 
  1 karl  1.6 //%2006////////////////////////////////////////////////////////////////////////

  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 karl  1.6 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.

 13 chip  1.1 //
 14           // Permission is hereby granted, free of charge, to any person obtaining a copy
 15           // of this software and associated documentation files (the "Software"), to
 16           // deal in the Software without restriction, including without limitation the
 17           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18           // sell copies of the Software, and to permit persons to whom the Software is
 19           // furnished to do so, subject to the following conditions:

 20 karl  1.2 // 

 21 chip  1.1 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29           //
 30           //==============================================================================
 31           //
 32           //%/////////////////////////////////////////////////////////////////////////////
 33           
 34           #ifndef Pegasus_NormalizationPropertyOwner_h
 35           #define Pegasus_NormalizationPropertyOwner_h
 36           
 37           #include <Pegasus/Config/ConfigPropertyOwner.h>
 38           
 39           #include <Pegasus/Common/AutoPtr.h>
 40           
 41           PEGASUS_NAMESPACE_BEGIN
 42 chip  1.1 
 43           /**
 44               This is NormalizationPropertyOwner class that extends ConfigPropertyOwner
 45               class.
 46           */

 47 kumpf 1.7 class PEGASUS_CONFIG_LINKAGE NormalizationPropertyOwner :
 48               public ConfigPropertyOwner

 49 chip  1.1 {
 50           public:

 51 kumpf 1.7     NormalizationPropertyOwner();

 52 chip  1.1 
 53               /**

 54 kumpf 1.7         Initialize the config properties.

 55 chip  1.1 

 56 kumpf 1.7         This method is expected to be called only once at the start of the
 57                   CIMOM. It initializes the properties with the default values.

 58 chip  1.1     */

 59 kumpf 1.7     void initialize();

 60 chip  1.1 
 61               /**

 62 kumpf 1.7         Get information about the specified property.

 63 chip  1.1 

 64 kumpf 1.7         @param propertyName The name of the property.
 65                   @param propertyInfo List to store the property info.
 66                   @exception UnrecognizedConfigProperty if the property is not defined.

 67 chip  1.1     */

 68 kumpf 1.7     void getPropertyInfo(
 69                   const String& name,
 70                   Array<String>& propertyInfo) const;

 71 chip  1.1 
 72               /**

 73 kumpf 1.7         Get default value of the specified property.

 74 chip  1.1 

 75 kumpf 1.7         @param name The name of the property.
 76                   @return string containing the default value of the property specified.
 77                   @exception UnrecognizedConfigProperty if the property is not defined.

 78 chip  1.1     */

 79 kumpf 1.7     String getDefaultValue(const String& name) const;

 80 chip  1.1 
 81               /**

 82 kumpf 1.7         Get current value of the specified property.

 83 chip  1.1 

 84 kumpf 1.7         @param name The name of the property.
 85                   @return string containing the current value of the property specified.
 86                   @exception UnrecognizedConfigProperty if the property is not defined.

 87 chip  1.1     */

 88 kumpf 1.7     String getCurrentValue(const String& name) const;

 89 chip  1.1 
 90               /**

 91 kumpf 1.7         Get planned value of the specified property.

 92 chip  1.1 

 93 kumpf 1.7         @param name The name of the property.
 94                   @return string containing the planned value of the property specified.
 95                   @exception UnrecognizedConfigProperty if the property is not defined.

 96 chip  1.1     */

 97 kumpf 1.7     String getPlannedValue(const String& name) const;

 98 chip  1.1 
 99               /**

100 kumpf 1.7         Init current value of the specified property to the specified value.
101                   This method is expected to be called only once at the start of the
102                   CIMOM. The property value will be initialized irrespective of whether
103                   the property is dynamic or not.

104 chip  1.1 

105 kumpf 1.7         @param name The name of the property.
106                   @param value The current value of the property.
107                   @exception UnrecognizedConfigProperty if the property is not defined.
108                   @exception InvalidPropertyValue if the property value is not valid.

109 chip  1.1     */

110 kumpf 1.7     void initCurrentValue(const String& name, const String& value);

111 chip  1.1 
112               /**

113 kumpf 1.7         Init planned value of the specified property to the specified value.
114                   This method is expected to be called only once at the start of the
115                   CIMOM. The property value will be initialized irrespective of whether
116                   the property is dynamic or not.

117 chip  1.1 

118 kumpf 1.7         @param name The name of the property.
119                   @param value The planned value of the property.
120                   @exception UnrecognizedConfigProperty if the property is not defined.
121                   @exception InvalidPropertyValue if the property value is not valid.

122 chip  1.1     */

123 kumpf 1.7     void initPlannedValue(const String& name, const String& value);

124 chip  1.1 
125               /**

126 kumpf 1.7         Update current value of the specified property to the specified value.
127                   The property value will be updated only if the property is dynamically
128                   updatable.

129 chip  1.1 

130 kumpf 1.7         @param name The name of the property.
131                   @param value The current value of the property.
132                   @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 kumpf 1.7     void updateCurrentValue(const String& name, const String& value);

137 chip  1.1 
138               /**

139 kumpf 1.7         Update planned value of the specified property to the specified value.

140 chip  1.1 

141 kumpf 1.7         @param name The name of the property.
142                   @param value The planned value of the property.
143                   @exception InvalidPropertyValue if the property value is not valid.
144                   @exception UnrecognizedConfigProperty if the property is not defined.

145 chip  1.1     */

146 kumpf 1.7     void updatePlannedValue(const String& name, const String& value);

147 chip  1.1 
148               /**

149 kumpf 1.7         Checks to see if the given value is valid or not.

150 chip  1.1 

151 kumpf 1.7         @param name The name of the property.
152                   @param value The value of the property to be validated.
153                   @return Boolean True if the specified value for the property is valid.
154                   @exception UnrecognizedConfigProperty if the property is not defined.

155 chip  1.1     */

156 kumpf 1.7     Boolean isValid(const String& name, const String& value) const;

157 chip  1.1 
158               /**

159 kumpf 1.7         Checks to see if the specified property is dynamic or not.

160 chip  1.1 

161 kumpf 1.7         @param name The name of the property.
162                   @return Boolean True if the specified property is dynamic.
163                   @exception UnrecognizedConfigProperty if the property is not defined.

164 chip  1.1     */

165 kumpf 1.7     Boolean isDynamic(const String& name)const;

166 chip  1.1 
167           private:

168 kumpf 1.7     struct ConfigProperty* _lookupConfigProperty(const String& name) const;

169 chip  1.1 
170               AutoPtr<struct ConfigProperty> _providerObjectNormalizationEnabled;
171               AutoPtr<struct ConfigProperty> _providerObjectNormalizationModuleExclusions;
172           };
173           
174           PEGASUS_NAMESPACE_END
175           
176           #endif
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2