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              //%/////////////////////////////////////////////////////////////////////////////
 33              
 34              
 35              //////////////////////////////////////////////////////////////////////////////

 36 david.dillard 1.6 //

 37 konrad.r      1.2 // This file defines the trace property owner class.
 38                   //
 39                   //////////////////////////////////////////////////////////////////////////////
 40                   
 41                   #ifndef Pegasus_ProviderDirPropertyOwner_h
 42                   #define Pegasus_ProviderDirPropertyOwner_h
 43                   
 44                   #include <Pegasus/Config/ConfigPropertyOwner.h>
 45                   
 46                   
 47                   PEGASUS_NAMESPACE_BEGIN
 48                   
 49                   ///////////////////////////////////////////////////////////////////
 50                   //  ProviderDirPropertyOwner Class
 51                   ///////////////////////////////////////////////////////////////////
 52                   

 53 david.dillard 1.6 /**

 54 konrad.r      1.2     This is ProviderDir property owner class that extends ConfigPropertyOwner
 55                       class and provide implementation.
 56                   */

 57 kumpf         1.10 class PEGASUS_CONFIG_LINKAGE ProviderDirPropertyOwner :
 58                        public ConfigPropertyOwner

 59 konrad.r      1.2  {
 60                    public:
 61                    
 62                        /** Constructors  */
 63                        ProviderDirPropertyOwner();
 64                    
 65                        /** Destructor  */
 66                        ~ProviderDirPropertyOwner();
 67                    
 68                        /**

 69 kumpf         1.10         Initialize the config properties.

 70 konrad.r      1.2  

 71 kumpf         1.10         This method is expected to be called only once at the start of the
 72                            CIMOM. It initializes the properties with the default values.

 73 konrad.r      1.2      */
 74                        void initialize();
 75                    
 76                    

 77 david.dillard 1.6      /**

 78 kumpf         1.10         Get information about the specified property.

 79 konrad.r      1.2  

 80 kumpf         1.10         @param propertyName The name of the property.
 81                            @param propertyInfo List to store the property info.
 82                            @exception UnrecognizedConfigProperty if the property is not defined.

 83 konrad.r      1.2      */

 84 kumpf         1.10     void getPropertyInfo(
 85                            const String& name,
 86                            Array<String>& propertyInfo) const;

 87 konrad.r      1.2  

 88 david.dillard 1.6      /**

 89 kumpf         1.10         Get default value of the specified property.

 90 konrad.r      1.2  

 91 kumpf         1.10         @param name The name of the property.
 92                            @return string containing the default value of the property specified.
 93                            @exception UnrecognizedConfigProperty if the property is not defined.

 94 konrad.r      1.2      */

 95 kumpf         1.10     String getDefaultValue(const String& name) const;

 96 konrad.r      1.2  

 97 david.dillard 1.6      /**

 98 kumpf         1.10         Get current value of the specified property.

 99 konrad.r      1.2  

100 kumpf         1.10         @param name The name of the property.
101                            @return string containing the current value of the property specified.
102                            @exception UnrecognizedConfigProperty if the property is not defined.

103 konrad.r      1.2      */

104 kumpf         1.10     String getCurrentValue(const String& name) const;

105 konrad.r      1.2  

106 david.dillard 1.6      /**

107 kumpf         1.10         Get planned value of the specified property.

108 konrad.r      1.2  

109 kumpf         1.10         @param name The name of the property.
110                            @return string containing the planned value of the property specified.
111                            @exception UnrecognizedConfigProperty if the property is not defined.

112 konrad.r      1.2      */

113 kumpf         1.10     String getPlannedValue(const String& name) const;

114 konrad.r      1.2  

115 david.dillard 1.6      /**

116 kumpf         1.10         Init current value of the specified property to the specified value.
117                            This method is expected to be called only once at the start of the
118                            CIMOM. The property value will be initialized irrespective of whether
119                            the property is dynamic or not.

120 konrad.r      1.2  

121 kumpf         1.10         @param name The name of the property.
122                            @param value The current value of the property.
123                            @exception UnrecognizedConfigProperty if the property is not defined.
124                            @exception InvalidPropertyValue if the property value is not valid.

125 konrad.r      1.2      */
126                        void initCurrentValue(const String& name, const String& value);
127                    

128 david.dillard 1.6      /**

129 kumpf         1.10         Init planned value of the specified property to the specified value.
130                            This method is expected to be called only once at the start of the
131                            CIMOM. The property value will be initialized irrespective of whether
132                            the property is dynamic or not.
133                    
134                            @param name The name of the property.
135                            @param value The planned value of the property.
136                            @exception UnrecognizedConfigProperty if the property is not defined.
137                            @exception InvalidPropertyValue if the property value is not valid.

138 konrad.r      1.2      */

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

140 konrad.r      1.2  

141 david.dillard 1.6      /**

142 kumpf         1.10         Update current value of the specified property to the specified value.
143                            The property value will be updated only if the property is dynamically
144                            updatable.
145                    
146                            @param name The name of the property.
147                            @param value The current value of the property.
148                            @exception NonDynamicConfigProperty if the property is not dynamic.
149                            @exception InvalidPropertyValue if the property value is not valid.
150                            @exception UnrecognizedConfigProperty if the property is not defined.

151 konrad.r      1.2      */
152                        void updateCurrentValue(const String& name, const String& value);
153                            //throw (NonDynamicConfigProperty, InvalidPropertyValue,
154                            //    UnrecognizedConfigProperty);
155                    

156 david.dillard 1.6      /**

157 kumpf         1.10         Update planned value of the specified property to the specified value.

158 konrad.r      1.2  

159 kumpf         1.10         @param name The name of the property.
160                            @param value The planned value of the property.
161                            @exception InvalidPropertyValue if the property value is not valid.
162                            @exception UnrecognizedConfigProperty if the property is not defined.

163 konrad.r      1.2      */
164                        void updatePlannedValue(const String& name, const String& value);
165                    

166 david.dillard 1.6      /**

167 kumpf         1.10         Checks to see if the given value is valid or not.

168 konrad.r      1.2  

169 kumpf         1.10         @param name The name of the property.
170                            @param value The value of the property to be validated.
171                            @return Boolean True if the specified value for the property is valid.
172                            @exception UnrecognizedConfigProperty if the property is not defined.

173 konrad.r      1.2      */

174 kumpf         1.10     Boolean isValid(const String& name, const String& value) const;

175 konrad.r      1.2  

176 david.dillard 1.6      /**

177 kumpf         1.10         Checks to see if the specified property is dynamic or not.

178 konrad.r      1.2  

179 kumpf         1.10         @param name The name of the property.
180                            @return Boolean True if the specified property is dynamic.
181                            @exception UnrecognizedConfigProperty  if the property is not defined.

182 konrad.r      1.2      */

183 kumpf         1.10     Boolean isDynamic(const String& name) const;

184 konrad.r      1.2  
185                    private:

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

187 konrad.r      1.2  
188                        /**

189 kumpf         1.10         The file system properties owned by this class

190 konrad.r      1.2      */

191 kumpf         1.10     struct ConfigProperty* _providerDir;

192 konrad.r      1.2  };
193                    
194                    PEGASUS_NAMESPACE_END
195                    
196                    #endif /* Pegasus_ProviderDirPropertyOwner_h */