(file) Return to RepositoryPropertyOwner.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Config

  1 karl  1.15 //%2006////////////////////////////////////////////////////////////////////////
  2 mike  1.2  //
  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.6  // 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 mike  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.15 // 
 21 mike  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: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
 33            //
 34 dave.sudlik 1.7  // Modified By: Dave Sudlik, IBM (dsudlik@us.ibm.com), for PEP 164
 35 aruran.ms   1.11 //              Aruran, IBM (ashanmug@in.ibm.com) for Bug# 3614
 36 david.dillard 1.12 //              David Dillard, VERITAS Software Corp.
 37                    //                  (david.dillard@veritas.com)
 38 vijay.eli     1.13 //              Vijay Eli, IBM, (vijayeli@in.ibm.com) for Bug# 3613
 39 aruran.ms     1.14 //              Aruran, IBM (ashanmug@in.ibm.com) for Bug# 3613
 40 mike          1.2  //
 41                    //%/////////////////////////////////////////////////////////////////////////////
 42                    
 43                    
 44                    //////////////////////////////////////////////////////////////////////////////
 45 david.dillard 1.12 //
 46 mike          1.2  // This file defines the repository property owner class.
 47                    //
 48                    //////////////////////////////////////////////////////////////////////////////
 49                    
 50                    #ifndef Pegasus_RepositoryPropertyOwner_h
 51                    #define Pegasus_RepositoryPropertyOwner_h
 52                    
 53                    #include <Pegasus/Config/ConfigPropertyOwner.h>
 54                    
 55                    
 56                    PEGASUS_NAMESPACE_BEGIN
 57                    
 58                    ///////////////////////////////////////////////////////////////////
 59                    //  RepositoryPropertyOwner Class
 60                    ///////////////////////////////////////////////////////////////////
 61                    
 62 david.dillard 1.12 /**
 63 mike          1.2      This is Repository property owner class that extends ConfigPropertyOwner
 64                        class and provides an implementation for repository-related configuration
 65                        properties.
 66                    */
 67                    class PEGASUS_CONFIG_LINKAGE RepositoryPropertyOwner : public ConfigPropertyOwner
 68                    {
 69                    public:
 70                    
 71                        /** Constructors  */
 72                        RepositoryPropertyOwner();
 73                    
 74                    
 75                        /** Destructor  */
 76                        ~RepositoryPropertyOwner();
 77                    
 78                        /**
 79                        Initialize the config properties.
 80                    
 81                        This method is expected to be called only once at the start of the
 82                        CIMOM. It initializes the properties with the default values.
 83                        */
 84 mike          1.2      void initialize();
 85                    
 86                    
 87 david.dillard 1.12     /**
 88 mike          1.2      Get information about the specified property.
 89                    
 90                        @param propertyName   The name of the property.
 91                        @param propertyInfo   List to store the property info.
 92                        @exception UnrecognizedConfigProperty  if the property is not defined.
 93                        */
 94 vijay.eli     1.13     void getPropertyInfo(const String& name, Array<String>& propertyInfo)const;
 95 mike          1.2  
 96                    
 97 david.dillard 1.12     /**
 98 mike          1.2      Get default value of the specified property.
 99                    
100                        @param  name         The name of the property.
101                        @return string containing the default value of the property specified.
102                        @exception UnrecognizedConfigProperty  if the property is not defined.
103                        */
104 vijay.eli     1.13     String getDefaultValue(const String& name)const;
105 mike          1.2  
106                    
107 david.dillard 1.12     /**
108 mike          1.2      Get current value of the specified property.
109                    
110                        @param  name         The name of the property.
111                        @return string containing the currnet value of the property specified.
112                        @exception UnrecognizedConfigProperty  if the property is not defined.
113                        */
114 vijay.eli     1.13     String getCurrentValue(const String& name)const;
115 mike          1.2  
116                    
117 david.dillard 1.12     /**
118 mike          1.2      Get planned value of the specified property.
119                    
120                        @param  name         The name of the property.
121                        @return string containing the planned value of the property specified.
122                        @exception UnrecognizedConfigProperty  if the property is not defined.
123                        */
124 vijay.eli     1.13     String getPlannedValue(const String& name)const;
125 mike          1.2  
126                    
127 david.dillard 1.12     /**
128 mike          1.2      Init current value of the specified property to the specified value.
129                        This method is expected to be called only once at the start of the
130                        CIMOM. The property value will be initialized irrespective of whether
131                        the property is dynamic or not.
132                    
133                        @param  name         The name of the property.
134 david.dillard 1.12     @param  value        The current value of the property.
135 mike          1.2      @exception     UnrecognizedConfigProperty  if the property is not defined.
136                        @exception     InvalidPropertyValue  if the property value is not valid.
137                        */
138                        void initCurrentValue(const String& name, const String& value);
139                    
140                    
141 david.dillard 1.12     /**
142 mike          1.2      Init planned value of the specified property to the specified value.
143                        This method is expected to be called only once at the start of the
144                        CIMOM. The property value will be initialized irrespective of whether
145                        the property is dynamic or not.
146                    
147                        @param  name         The name of the property.
148 david.dillard 1.12     @param  value        The planned value of the property.
149 mike          1.2      @exception     UnrecognizedConfigProperty  if the property is not defined.
150                        @exception     InvalidPropertyValue  if the property value is not valid.
151                        */
152 david.dillard 1.12     void initPlannedValue(const String& name, const String& value);
153 mike          1.2  
154                    
155 david.dillard 1.12     /**
156 mike          1.2      Update current value of the specified property to the specified value.
157                        The property value will be updated only if the property is dynamically
158                        updatable.
159                    
160                        @param  name         The name of the property.
161 david.dillard 1.12     @param  value        The current value of the property.
162 mike          1.2      @exception     NonDynamicConfigProperty  if the property is not dynamic.
163                        @exception     InvalidPropertyValue  if the property value is not valid.
164                        @exception     UnrecognizedConfigProperty  if the property is not defined.
165                        */
166                        void updateCurrentValue(const String& name, const String& value);
167                            //throw (NonDynamicConfigProperty, InvalidPropertyValue,
168                            //    UnrecognizedConfigProperty);
169                    
170                    
171 david.dillard 1.12     /**
172 mike          1.2      Update planned value of the specified property to the specified value.
173                    
174                        @param  name         The name of the property.
175 david.dillard 1.12     @param  value        The planned value of the property.
176 mike          1.2      @exception     InvalidPropertyValue  if the property value is not valid.
177                        @exception     UnrecognizedConfigProperty  if the property is not defined.
178                        */
179                        void updatePlannedValue(const String& name, const String& value);
180                    
181                    
182 david.dillard 1.12     /**
183 mike          1.2      Checks to see if the given value is valid or not.
184                    
185                        @param  name         The name of the property.
186 david.dillard 1.12     @param  value        The value of the property to be validated.
187 mike          1.2      @return Boolean      True if the specified value for the property is valid.
188                        @exception UnrecognizedConfigProperty  if the property is not defined.
189                        */
190 vijay.eli     1.13     Boolean isValid(const String& name, const String& value)const;
191 mike          1.2  
192                    
193 david.dillard 1.12     /**
194 mike          1.2      Checks to see if the specified property is dynamic or not.
195                    
196                        @param  name         The name of the property.
197                        @return Boolean      True if the specified property is dynamic.
198                        @exception UnrecognizedConfigProperty  if the property is not defined.
199                        */
200 vijay.eli     1.13     Boolean isDynamic(const String& name)const;
201 mike          1.2  
202                    
203                    private:
204                    
205 aruran.ms     1.14     struct ConfigProperty* _lookupConfigProperty(const String& name) const;
206 kumpf         1.4  
207 mike          1.2      /**
208                        The repository properties owned by this class
209                        */
210                        struct ConfigProperty*      _repositoryIsDefaultInstanceProvider;
211 dave.sudlik   1.7      struct ConfigProperty*      _enableBinaryRepository;  // PEP 164
212 mike          1.2  
213                    };
214                    
215                    PEGASUS_NAMESPACE_END
216                    
217                    #endif /* Pegasus_RepositoryPropertyOwner_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2