1 karl  1.15 //%2006////////////////////////////////////////////////////////////////////////

  2 kumpf 1.1  //

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

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

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

 13 kumpf 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.15 // 

 21 kumpf 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            // Author: Sushma Fernandes (sushma_fernandes@hp.com)
 33            //

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

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

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

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

 39 kumpf         1.1  //
 40                    //%/////////////////////////////////////////////////////////////////////////////
 41                    
 42                    
 43                    //////////////////////////////////////////////////////////////////////////////

 44 david.dillard 1.12 //

 45 kumpf         1.1  // This file defines the trace property owner class.
 46                    //
 47                    //////////////////////////////////////////////////////////////////////////////
 48                    
 49                    #ifndef Pegasus_FileSystemPropertyOwner_h
 50                    #define Pegasus_FileSystemPropertyOwner_h
 51                    
 52                    #include <Pegasus/Config/ConfigPropertyOwner.h>

 53 a.arora       1.8  #include <Pegasus/Common/AutoPtr.h>

 54 kumpf         1.1  
 55                    
 56                    PEGASUS_NAMESPACE_BEGIN
 57                    
 58                    ///////////////////////////////////////////////////////////////////
 59                    //  FileSystemPropertyOwner Class
 60                    ///////////////////////////////////////////////////////////////////
 61                    

 62 david.dillard 1.12 /**

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

 82 david.dillard 1.12     /**

 83 kumpf         1.1      Get information about the specified property.
 84                    
 85                        @param propertyName   The name of the property.
 86                        @param propertyInfo   List to store the property info.
 87                        @exception UnrecognizedConfigProperty  if the property is not defined.
 88                        */

 89 vijay.eli     1.13     void getPropertyInfo(const String& name, Array<String>& propertyInfo)const;

 90 kumpf         1.1  

 91 david.dillard 1.12     /**

 92 kumpf         1.1      Get default value of the specified property.
 93                    
 94                        @param  name         The name of the property.
 95                        @return string containing the default value of the property specified.
 96                        @exception UnrecognizedConfigProperty  if the property is not defined.
 97                        */

 98 vijay.eli     1.13     String getDefaultValue(const String& name)const;

 99 kumpf         1.1  

100 david.dillard 1.12     /**

101 kumpf         1.1      Get current value of the specified property.
102                    
103                        @param  name         The name of the property.
104                        @return string containing the currnet value of the property specified.
105                        @exception UnrecognizedConfigProperty  if the property is not defined.
106                        */

107 vijay.eli     1.13     String getCurrentValue(const String& name)const;

108 kumpf         1.1  

109 david.dillard 1.12     /**

110 kumpf         1.1      Get planned value of the specified property.
111                    
112                        @param  name         The name of the property.
113                        @return string containing the planned value of the property specified.
114                        @exception UnrecognizedConfigProperty  if the property is not defined.
115                        */

116 vijay.eli     1.13     String getPlannedValue(const String& name)const;

117 kumpf         1.1  

118 david.dillard 1.12     /**

119 kumpf         1.1      Init current value of the specified property to the specified value.
120                        This method is expected to be called only once at the start of the
121                        CIMOM. The property value will be initialized irrespective of whether
122                        the property is dynamic or not.
123                    
124                        @param  name         The name of the property.

125 david.dillard 1.12     @param  value        The current value of the property.

126 kumpf         1.1      @exception     UnrecognizedConfigProperty  if the property is not defined.
127                        @exception     InvalidPropertyValue  if the property value is not valid.
128                        */
129                        void initCurrentValue(const String& name, const String& value);
130                    

131 david.dillard 1.12     /**

132 kumpf         1.1      Init planned value of the specified property to the specified value.
133                        This method is expected to be called only once at the start of the
134                        CIMOM. The property value will be initialized irrespective of whether
135                        the property is dynamic or not.
136                    
137                        @param  name         The name of the property.

138 david.dillard 1.12     @param  value        The planned value of the property.

139 kumpf         1.1      @exception     UnrecognizedConfigProperty  if the property is not defined.
140                        @exception     InvalidPropertyValue  if the property value is not valid.
141                        */

142 david.dillard 1.12     void initPlannedValue(const String& name, const String& value);

143 kumpf         1.1  

144 david.dillard 1.12     /**

145 kumpf         1.1      Update current value of the specified property to the specified value.
146                        The property value will be updated only if the property is dynamically
147                        updatable.
148                    
149                        @param  name         The name of the property.

150 david.dillard 1.12     @param  value        The current value of the property.

151 kumpf         1.1      @exception     NonDynamicConfigProperty  if the property is not dynamic.
152                        @exception     InvalidPropertyValue  if the property value is not valid.
153                        @exception     UnrecognizedConfigProperty  if the property is not defined.
154                        */
155                        void updateCurrentValue(const String& name, const String& value);
156                            //throw (NonDynamicConfigProperty, InvalidPropertyValue,
157                            //    UnrecognizedConfigProperty);
158                    

159 david.dillard 1.12     /**

160 kumpf         1.1      Update planned value of the specified property to the specified value.
161                    
162                        @param  name         The name of the property.

163 david.dillard 1.12     @param  value        The planned value of the property.

164 kumpf         1.1      @exception     InvalidPropertyValue  if the property value is not valid.
165                        @exception     UnrecognizedConfigProperty  if the property is not defined.
166                        */
167                        void updatePlannedValue(const String& name, const String& value);
168                    

169 david.dillard 1.12     /**

170 kumpf         1.1      Checks to see if the given value is valid or not.
171                    
172                        @param  name         The name of the property.

173 david.dillard 1.12     @param  value        The value of the property to be validated.

174 kumpf         1.1      @return Boolean      True if the specified value for the property is valid.
175                        @exception UnrecognizedConfigProperty  if the property is not defined.
176                        */

177 vijay.eli     1.13     Boolean isValid(const String& name, const String& value)const;

178 kumpf         1.1  

179 david.dillard 1.12     /**

180 kumpf         1.1      Checks to see if the specified property is dynamic or not.
181                    
182                        @param  name         The name of the property.
183                        @return Boolean      True if the specified property is dynamic.
184                        @exception UnrecognizedConfigProperty  if the property is not defined.
185                        */

186 vijay.eli     1.13     Boolean isDynamic(const String& name)const;

187 kumpf         1.1  
188                    private:

189 aruran.ms     1.14     struct ConfigProperty* _lookupConfigProperty(const String& name) const;

190 kumpf         1.2  

191 kumpf         1.1      /**
192                        The file system properties owned by this class
193                        */

194 a.arora       1.8      AutoPtr<struct ConfigProperty>      _repositoryDir; //PEP101

195 kumpf         1.1  

196 a.arora       1.8      AutoPtr<struct ConfigProperty>      _messageDir; //PEP101

197 david         1.7  

198 kumpf         1.1  };
199                    
200                    PEGASUS_NAMESPACE_END
201                    
202                    #endif /* Pegasus_FileSystemPropertyOwner_h */