1 karl  1.9 //%2006////////////////////////////////////////////////////////////////////////

  2 konrad.r 1.2 //

  3 karl     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 konrad.r 1.2 // IBM Corp.; EMC Corporation, The Open Group.

  7 karl     1.3 // 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.4 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10              // EMC Corporation; VERITAS Software Corporation; The Open Group.

 11 karl     1.9 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12              // EMC Corporation; Symantec Corporation; The Open Group.

 13 konrad.r 1.2 //
 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.9 // 

 21 konrad.r 1.2 // 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              // Author: Konrad Rzeszutek <konradr@us.ibm.com>
 33              //

 34 aruran.ms 1.5 // Modified By:  Aruran, IBM (ashanmug@in.ibm.com) for Bug# 3614

 35 david.dillard 1.6 //              David Dillard, VERITAS Software Corp.
 36                   //                  (david.dillard@veritas.com)

 37 vijay.eli     1.7 //              Vijay Eli, IBM, (vijayeli@in.ibm.com) for Bug# 3613

 38 aruran.ms     1.8 //              Aruran, IBM (ashanmug@in.ibm.com) for Bug# 3613

 39 konrad.r      1.2 //
 40                   //%/////////////////////////////////////////////////////////////////////////////
 41                   
 42                   
 43                   //////////////////////////////////////////////////////////////////////////////

 44 david.dillard 1.6 //

 45 konrad.r      1.2 // This file defines the trace property owner class.
 46                   //
 47                   //////////////////////////////////////////////////////////////////////////////
 48                   
 49                   #ifndef Pegasus_ProviderDirPropertyOwner_h
 50                   #define Pegasus_ProviderDirPropertyOwner_h
 51                   
 52                   #include <Pegasus/Config/ConfigPropertyOwner.h>
 53                   
 54                   
 55                   PEGASUS_NAMESPACE_BEGIN
 56                   
 57                   ///////////////////////////////////////////////////////////////////
 58                   //  ProviderDirPropertyOwner Class
 59                   ///////////////////////////////////////////////////////////////////
 60                   

 61 david.dillard 1.6 /**

 62 konrad.r      1.2     This is ProviderDir property owner class that extends ConfigPropertyOwner
 63                       class and provide implementation.
 64                   */
 65                   class PEGASUS_CONFIG_LINKAGE ProviderDirPropertyOwner : public ConfigPropertyOwner
 66                   {
 67                   public:
 68                   
 69                       /** Constructors  */
 70                       ProviderDirPropertyOwner();
 71                   
 72                       /** Destructor  */
 73                       ~ProviderDirPropertyOwner();
 74                   
 75                       /**
 76                       Initialize the config properties.
 77                   
 78                       This method is expected to be called only once at the start of the
 79                       CIMOM. It initializes the properties with the default values.
 80                       */
 81                       void initialize();
 82                   
 83 konrad.r      1.2 

 84 david.dillard 1.6     /**

 85 konrad.r      1.2     Get information about the specified property.
 86                   
 87                       @param propertyName   The name of the property.
 88                       @param propertyInfo   List to store the property info.
 89                       @exception UnrecognizedConfigProperty  if the property is not defined.
 90                       */

 91 vijay.eli     1.7     void getPropertyInfo(const String& name, 
 92                                    Array<String>& propertyInfo)const;

 93 konrad.r      1.2 

 94 david.dillard 1.6     /**

 95 konrad.r      1.2     Get default value of the specified property.
 96                   
 97                       @param  name         The name of the property.
 98                       @return string containing the default value of the property specified.
 99                       @exception UnrecognizedConfigProperty  if the property is not defined.
100                       */

101 vijay.eli     1.7     String getDefaultValue(const String& name)const;

102 konrad.r      1.2 

103 david.dillard 1.6     /**

104 konrad.r      1.2     Get current value of the specified property.
105                   
106                       @param  name         The name of the property.
107                       @return string containing the currnet value of the property specified.
108                       @exception UnrecognizedConfigProperty  if the property is not defined.
109                       */

110 vijay.eli     1.7     String getCurrentValue(const String& name)const;

111 konrad.r      1.2 

112 david.dillard 1.6     /**

113 konrad.r      1.2     Get planned value of the specified property.
114                   
115                       @param  name         The name of the property.
116                       @return string containing the planned value of the property specified.
117                       @exception UnrecognizedConfigProperty  if the property is not defined.
118                       */

119 vijay.eli     1.7     String getPlannedValue(const String& name)const;

120 konrad.r      1.2 

121 david.dillard 1.6     /**

122 konrad.r      1.2     Init current value of the specified property to the specified value.
123                       This method is expected to be called only once at the start of the
124                       CIMOM. The property value will be initialized irrespective of whether
125                       the property is dynamic or not.
126                   
127                       @param  name         The name of the property.

128 david.dillard 1.6     @param  value        The current value of the property.

129 konrad.r      1.2     @exception     UnrecognizedConfigProperty  if the property is not defined.
130                       @exception     InvalidPropertyValue  if the property value is not valid.
131                       */
132                       void initCurrentValue(const String& name, const String& value);
133                   

134 david.dillard 1.6     /**

135 konrad.r      1.2     Init planned value of the specified property to the specified value.
136                       This method is expected to be called only once at the start of the
137                       CIMOM. The property value will be initialized irrespective of whether
138                       the property is dynamic or not.
139                   
140                       @param  name         The name of the property.

141 david.dillard 1.6     @param  value        The planned value of the property.

142 konrad.r      1.2     @exception     UnrecognizedConfigProperty  if the property is not defined.
143                       @exception     InvalidPropertyValue  if the property value is not valid.
144                       */

145 david.dillard 1.6     void initPlannedValue(const String& name, const String& value);

146 konrad.r      1.2 

147 david.dillard 1.6     /**

148 konrad.r      1.2     Update current value of the specified property to the specified value.
149                       The property value will be updated only if the property is dynamically
150                       updatable.
151                   
152                       @param  name         The name of the property.

153 david.dillard 1.6     @param  value        The current value of the property.

154 konrad.r      1.2     @exception     NonDynamicConfigProperty  if the property is not dynamic.
155                       @exception     InvalidPropertyValue  if the property value is not valid.
156                       @exception     UnrecognizedConfigProperty  if the property is not defined.
157                       */
158                       void updateCurrentValue(const String& name, const String& value);
159                           //throw (NonDynamicConfigProperty, InvalidPropertyValue,
160                           //    UnrecognizedConfigProperty);
161                   

162 david.dillard 1.6     /**

163 konrad.r      1.2     Update planned value of the specified property to the specified value.
164                   
165                       @param  name         The name of the property.

166 david.dillard 1.6     @param  value        The planned value of the property.

167 konrad.r      1.2     @exception     InvalidPropertyValue  if the property value is not valid.
168                       @exception     UnrecognizedConfigProperty  if the property is not defined.
169                       */
170                       void updatePlannedValue(const String& name, const String& value);
171                   

172 david.dillard 1.6     /**

173 konrad.r      1.2     Checks to see if the given value is valid or not.
174                   
175                       @param  name         The name of the property.

176 david.dillard 1.6     @param  value        The value of the property to be validated.

177 konrad.r      1.2     @return Boolean      True if the specified value for the property is valid.
178                       @exception UnrecognizedConfigProperty  if the property is not defined.
179                       */

180 vijay.eli     1.7     Boolean isValid(const String& name, const String& value)const;

181 konrad.r      1.2 

182 david.dillard 1.6     /**

183 konrad.r      1.2     Checks to see if the specified property is dynamic or not.
184                   
185                       @param  name         The name of the property.
186                       @return Boolean      True if the specified property is dynamic.
187                       @exception UnrecognizedConfigProperty  if the property is not defined.
188                       */

189 vijay.eli     1.7     Boolean isDynamic(const String& name)const;

190 konrad.r      1.2 
191                   private:

192 aruran.ms     1.8     struct ConfigProperty* _lookupConfigProperty(const String& name) const;

193 konrad.r      1.2 
194                       /**
195                       The file system properties owned by this class
196                       */
197                       struct ConfigProperty*      _providerDir;
198                   
199                   };
200                   
201                   PEGASUS_NAMESPACE_END
202                   
203                   #endif /* Pegasus_ProviderDirPropertyOwner_h */