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.;
|
9 konrad.r 1.2 //
10 // Permission is hereby granted, free of charge, to any person obtaining a copy
11 // of this software and associated documentation files (the "Software"), to
12 // deal in the Software without restriction, including without limitation the
13 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
14 // sell copies of the Software, and to permit persons to whom the Software is
15 // furnished to do so, subject to the following conditions:
16 //
17 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
18 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
19 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
20 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
21 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
23 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 //
26 //==============================================================================
27 //
28 // Author: Konrad Rzeszutek <konradr@us.ibm.com>
29 //
30 konrad.r 1.2 // Modified By:
31 //
32 //%/////////////////////////////////////////////////////////////////////////////
33
34
35 //////////////////////////////////////////////////////////////////////////////
36 //
37 // 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 konrad.r 1.2 ///////////////////////////////////////////////////////////////////
52
53 /**
54 This is ProviderDir property owner class that extends ConfigPropertyOwner
55 class and provide implementation.
56 */
57 class PEGASUS_CONFIG_LINKAGE ProviderDirPropertyOwner : public ConfigPropertyOwner
58 {
59 public:
60
61 /** Constructors */
62 ProviderDirPropertyOwner();
63
64 /** Destructor */
65 ~ProviderDirPropertyOwner();
66
67 /**
68 Initialize the config properties.
69
70 This method is expected to be called only once at the start of the
71 CIMOM. It initializes the properties with the default values.
72 konrad.r 1.2 */
73 void initialize();
74
75
76 /**
77 Get information about the specified property.
78
79 @param propertyName The name of the property.
80 @param propertyInfo List to store the property info.
81 @exception UnrecognizedConfigProperty if the property is not defined.
82 */
83 void getPropertyInfo(const String& name, Array<String>& propertyInfo);
84 //throw (UnrecognizedConfigProperty);
85
86 /**
87 Get default value of the specified property.
88
89 @param name The name of the property.
90 @return string containing the default value of the property specified.
91 @exception UnrecognizedConfigProperty if the property is not defined.
92 */
93 konrad.r 1.2 const String getDefaultValue(const String& name);
94 //throw (UnrecognizedConfigProperty);
95
96 /**
97 Get current value of the specified property.
98
99 @param name The name of the property.
100 @return string containing the currnet value of the property specified.
101 @exception UnrecognizedConfigProperty if the property is not defined.
102 */
103 const String getCurrentValue(const String& name);
104 //throw (UnrecognizedConfigProperty);
105
106 /**
107 Get planned value of the specified property.
108
109 @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 */
113 const String getPlannedValue(const String& name);
114 konrad.r 1.2 //throw (UnrecognizedConfigProperty);
115
116 /**
117 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 @param value The current value of the property.
124 @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 //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
129
130
131 /**
132 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 konrad.r 1.2 the property is dynamic or not.
136
137 @param name The name of the property.
138 @param value The planned value of the property.
139 @exception UnrecognizedConfigProperty if the property is not defined.
140 @exception InvalidPropertyValue if the property value is not valid.
141 */
142 void initPlannedValue(const String& name, const String& value);
143 //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
144
145 /**
146 Update current value of the specified property to the specified value.
147 The property value will be updated only if the property is dynamically
148 updatable.
149
150 @param name The name of the property.
151 @param value The current value of the property.
152 @exception NonDynamicConfigProperty if the property is not dynamic.
153 @exception InvalidPropertyValue if the property value is not valid.
154 @exception UnrecognizedConfigProperty if the property is not defined.
155 */
156 konrad.r 1.2 void updateCurrentValue(const String& name, const String& value);
157 //throw (NonDynamicConfigProperty, InvalidPropertyValue,
158 // UnrecognizedConfigProperty);
159
160 /**
161 Update planned value of the specified property to the specified value.
162
163 @param name The name of the property.
164 @param value The planned value of the property.
165 @exception InvalidPropertyValue if the property value is not valid.
166 @exception UnrecognizedConfigProperty if the property is not defined.
167 */
168 void updatePlannedValue(const String& name, const String& value);
169 //throw (InvalidPropertyValue, UnrecognizedConfigProperty);
170
171 /**
172 Checks to see if the given value is valid or not.
173
174 @param name The name of the property.
175 @param value The value of the property to be validated.
176 @return Boolean True if the specified value for the property is valid.
177 konrad.r 1.2 @exception UnrecognizedConfigProperty if the property is not defined.
178 */
179 Boolean isValid(const String& name, const String& value);
180 //throw (UnrecognizedConfigProperty);
181
182 /**
183 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 Boolean isDynamic(const String& name);
190 //throw (UnrecognizedConfigProperty);
191
192 private:
193 struct ConfigProperty* _lookupConfigProperty(const String& name);
194
195 /**
196 The file system properties owned by this class
197 */
198 konrad.r 1.2 struct ConfigProperty* _providerDir;
199
200 };
201
202 PEGASUS_NAMESPACE_END
203
204 #endif /* Pegasus_ProviderDirPropertyOwner_h */
|
Return to
ProviderDirPropertyOwner.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Config