1 venkat.puvvada 1.1 //%LICENSE////////////////////////////////////////////////////////////////
2 //
3 // Licensed to The Open Group (TOG) under one or more contributor license
4 // agreements. Refer to the OpenPegasusNOTICE.txt file distributed with
5 // this work for additional information regarding copyright ownership.
6 // Each contributor licenses this file to you under the OpenPegasus Open
7 // Source License; you may not use this file except in compliance with the
8 // License.
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining a
11 // copy of this software and associated documentation files (the "Software"),
12 // to deal in the Software without restriction, including without limitation
13 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
14 // and/or sell copies of the Software, and to permit persons to whom the
15 // Software is furnished to do so, subject to the following conditions:
16 //
17 // The above copyright notice and this permission notice shall be included
18 // in all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 venkat.puvvada 1.1 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23 // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24 // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25 // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 //
28 //////////////////////////////////////////////////////////////////////////
29 //
30 //%/////////////////////////////////////////////////////////////////////////////
31
32
33 //////////////////////////////////////////////////////////////////////////////
34 //
35 // This file defines the IndicationService property owner class.
36 //
37 //////////////////////////////////////////////////////////////////////////////
38
39 #ifndef Pegasus_IndicationServicePropertyOwner_h
40 #define Pegasus_IndicationServicePropertyOwner_h
41
42 #include <Pegasus/Config/ConfigPropertyOwner.h>
43 venkat.puvvada 1.1 #include <Pegasus/Common/AutoPtr.h>
44
45
46 PEGASUS_NAMESPACE_BEGIN
47
48 /**
49 This is IndicationService property owner class that extends
50 ConfigPropertyOwner class and provide implementation.
51 */
52 class PEGASUS_CONFIG_LINKAGE IndicationServicePropertyOwner:
53 public ConfigPropertyOwner
54 {
55 public:
56
57 IndicationServicePropertyOwner();
58
59 /**
60 Initialize the config properties.
61
62 This method is expected to be called only once at the start of the
63 CIMOM. It initializes the properties with the default values.
64 venkat.puvvada 1.1 */
65 void initialize();
66
67
68 /**
69 Get information about the specified property.
70
71 @param name The name of the property.
72 @param propertyInfo List to store the property info.
73 @exception UnrecognizedConfigProperty if the property is not defined.
74 */
75 void getPropertyInfo(const String& name, Array<String>& propertyInfo)const;
76
77 /**
78 Get default value of the specified property.
79
80 @param name The name of the property.
81 @return string containing the default value of the property specified.
82 @exception UnrecognizedConfigProperty if the property is not defined.
83 */
84 String getDefaultValue(const String& name)const;
85 venkat.puvvada 1.1
86 /**
87 Get current value of the specified property.
88
89 @param name The name of the property.
90 @return string containing the currnet value of the property specified.
91 @exception UnrecognizedConfigProperty if the property is not defined.
92 */
93 String getCurrentValue(const String& name)const;
94
95 /**
96 Get planned value of the specified property.
97
98 @param name The name of the property.
99 @return string containing the planned value of the property specified.
100 @exception UnrecognizedConfigProperty if the property is not defined.
101 */
102 String getPlannedValue(const String& name)const;
103
104 /**
105 Init current value of the specified property to the specified value.
106 venkat.puvvada 1.1 This method is expected to be called only once at the start of the
107 CIMOM. The property value will be initialized irrespective of whether
108 the property is dynamic or not.
109
110 @param name The name of the property.
111 @param value The current value of the property.
112 @exception UnrecognizedConfigProperty if the property is not defined.
113 @exception InvalidPropertyValue if the property value is not valid.
114 */
115 void initCurrentValue(const String& name, const String& value);
116
117 /**
118 Init planned value of the specified property to the specified value.
119 This method is expected to be called only once at the start of the
120 CIMOM. The property value will be initialized irrespective of whether
121 the property is dynamic or not.
122
123 @param name The name of the property.
124 @param value The planned value of the property.
125 @exception UnrecognizedConfigProperty if the property is not defined.
126 @exception InvalidPropertyValue if the property value is not valid.
127 venkat.puvvada 1.1 */
128 void initPlannedValue(const String& name, const String& value);
129
130 /**
131 Update current value of the specified property to the specified value.
132 The property value will be updated only if the property is dynamically
133 updatable.
134
135 @param name The name of the property.
136 @param value The current value of the property.
137 @param userName User requesting the update.
138 @param timeoutSeconds Timeout in seconds to complete the update.
139 @exception NonDynamicConfigProperty if the property is not dynamic.
140 @exception InvalidPropertyValue if the property value is not valid.
141 @exception UnrecognizedConfigProperty if the property is not defined.
142 */
143 void updateCurrentValue(
144 const String& name,
145 const String& value,
146 const String& userName,
147 Uint32 timeoutSeconds);
148 venkat.puvvada 1.1
149 /**
150 Update planned value of the specified property to the specified value.
151
152 @param name The name of the property.
153 @param value The planned value of the property.
154 @exception UnrecognizedConfigProperty if the property is not defined.
155 @exception InvalidPropertyValue if the property value is not valid.
156 */
157 void updatePlannedValue(const String& name, const String& value);
158
159 /**
160 Checks to see if the given value is valid or not.
161
162 @param name The name of the property.
163 @param value The value of the property to be validated.
164 @return Boolean True if the specified value for the property is valid.
165 @exception UnrecognizedConfigProperty if the property is not defined.
166 */
167 Boolean isValid(const String& name, const String& value)const;
168
169 venkat.puvvada 1.1 /**
170 Checks to see if the specified property is dynamic or not.
171
172 @param name The name of the property.
173 @return Boolean True if the specified property is dynamic.
174 @exception UnrecognizedConfigProperty if the property is not defined.
175 */
176 Boolean isDynamic(const String& name)const;
177
178 private:
179 struct ConfigProperty* _lookupConfigProperty(const String& name) const;
180
181 AutoPtr<struct ConfigProperty> _maxIndicationDeliveryRetryAttempts;
182
183 AutoPtr<struct ConfigProperty> _minIndicationDeliveryRetryInterval;
184
185 /**
186 Remember if configproperties are already initialized.
187 */
188 Boolean _initialized;
189
190 venkat.puvvada 1.1 };
191
192 PEGASUS_NAMESPACE_END
193
194 #endif /* Pegasus_IndicationServicePropertyOwner_h */
|
Return to
IndicationServicePropertyOwner.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Config