1 karl  1.10 //%2005////////////////////////////////////////////////////////////////////////

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

 18 david.dillard 1.12 //

 19 kumpf         1.1  // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 20                    // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 21                    // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 22                    // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 23                    // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 24                    // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 25                    // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 26                    // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 27                    //
 28                    //==============================================================================
 29                    //
 30                    // Author: Sushma Fernandes (sushma_fernandes@hp.com)
 31                    //

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

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

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

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

 37 kumpf         1.1  //
 38                    //%/////////////////////////////////////////////////////////////////////////////
 39                    
 40                    
 41                    //////////////////////////////////////////////////////////////////////////////

 42 david.dillard 1.12 //

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

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

 52 kumpf         1.1  
 53                    
 54                    PEGASUS_NAMESPACE_BEGIN
 55                    
 56                    ///////////////////////////////////////////////////////////////////
 57                    //  FileSystemPropertyOwner Class
 58                    ///////////////////////////////////////////////////////////////////
 59                    

 60 david.dillard 1.12 /**

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

 80 david.dillard 1.12     /**

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

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

 88 kumpf         1.1  

 89 david.dillard 1.12     /**

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

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

 97 kumpf         1.1  

 98 david.dillard 1.12     /**

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

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

106 kumpf         1.1  

107 david.dillard 1.12     /**

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

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

115 kumpf         1.1  

116 david.dillard 1.12     /**

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

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

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

129 david.dillard 1.12     /**

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

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

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

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

141 kumpf         1.1  

142 david.dillard 1.12     /**

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

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

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

157 david.dillard 1.12     /**

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

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

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

167 david.dillard 1.12     /**

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

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

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

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

176 kumpf         1.1  

177 david.dillard 1.12     /**

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

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

185 kumpf         1.1  
186                    private:

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

188 kumpf         1.2  

189 kumpf         1.1      /**
190                        The file system properties owned by this class
191                        */

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

193 kumpf         1.1  

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

195 david         1.7  

196 kumpf         1.1  };
197                    
198                    PEGASUS_NAMESPACE_END
199                    
200                    #endif /* Pegasus_FileSystemPropertyOwner_h */