1 kumpf 1.1.2.1 //%/////////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2000, 2001 BMC Software, Hewlett-Packard Company, IBM,
4 // The Open Group, Tivoli Systems
5 //
6 // Permission is hereby granted, free of charge, to any person obtaining a copy
7 // of this software and associated documentation files (the "Software"), to
8 // deal in the Software without restriction, including without limitation the
9 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 // sell copies of the Software, and to permit persons to whom the Software is
11 // furnished to do so, subject to the following conditions:
12 //
13 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
14 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
15 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
16 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
17 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
18 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 //
22 kumpf 1.1.2.1 //==============================================================================
23 //
24 // Author: Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com)
25 //
26 // Modified By:
27 //
28 //%/////////////////////////////////////////////////////////////////////////////
29
30
31 //////////////////////////////////////////////////////////////////////////////
32 //
33 // This file defines the security property owner class.
34 //
35 //////////////////////////////////////////////////////////////////////////////
36
37 #ifndef Pegasus_SecurityPropertyOwner_h
38 #define Pegasus_SecurityPropertyOwner_h
39
40 #include <Pegasus/Config/ConfigPropertyOwner.h>
41
42
43 kumpf 1.1.2.1 PEGASUS_NAMESPACE_BEGIN
44
45 ///////////////////////////////////////////////////////////////////
46 // SecurityPropertyOwner Class
47 ///////////////////////////////////////////////////////////////////
48
49 /**
50 This is Log property owner class that extends ConfigPropertyOwner
51 class and provide implementation.
52 */
53 class PEGASUS_CONFIG_LINKAGE SecurityPropertyOwner : public ConfigPropertyOwner
54 {
55 public:
56
57 /** Constructors */
58 SecurityPropertyOwner();
59
60
61 /** Destructor */
62 ~SecurityPropertyOwner();
63
64 kumpf 1.1.2.1 /**
65 Initialize the config properties.
66
67 This method is expected to be called only once at the start of the
68 CIMOM. It initializes the properties with the default values.
69 */
70 void initialize();
71
72
73 /**
74 Get information about the specified property.
75
76 @param propertyName The name of the property.
77 @param propertyInfo List to store the property info.
78 @exception UnrecognizedConfigProperty if the property is not defined.
79 */
80 void getPropertyInfo(const String& name, Array<String>& propertyInfo);
81 //throw (UnrecognizedConfigProperty);
82
83
84 /**
85 kumpf 1.1.2.1 Get default value of the specified property.
86
87 @param name The name of the property.
88 @return string containing the default value of the property specified.
89 @exception UnrecognizedConfigProperty if the property is not defined.
90 */
91 const String getDefaultValue(const String& name);
92 //throw (UnrecognizedConfigProperty);
93
94
95 /**
96 Get current value of the specified property.
97
98 @param name The name of the property.
99 @return string containing the currnet value of the property specified.
100 @exception UnrecognizedConfigProperty if the property is not defined.
101 */
102 const String getCurrentValue(const String& name);
103 //throw (UnrecognizedConfigProperty);
104
105
106 kumpf 1.1.2.1 /**
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 //throw (UnrecognizedConfigProperty);
115
116
117 /**
118 Init current 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 current value of the property.
125 @exception UnrecognizedConfigProperty if the property is not defined.
126 @exception InvalidPropertyValue if the property value is not valid.
127 kumpf 1.1.2.1 */
128 void initCurrentValue(const String& name, const String& value);
129 //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
130
131
132 /**
133 Init planned value of the specified property to the specified value.
134 This method is expected to be called only once at the start of the
135 CIMOM. The property value will be initialized irrespective of whether
136 the property is dynamic or not.
137
138 @param name The name of the property.
139 @param value The planned value of the property.
140 @exception UnrecognizedConfigProperty if the property is not defined.
141 @exception InvalidPropertyValue if the property value is not valid.
142 */
143 void initPlannedValue(const String& name, const String& value);
144 //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
145
146
147 /**
148 kumpf 1.1.2.1 Update current value of the specified property to the specified value.
149 The property value will be updated only if the property is dynamically
150 updatable.
151
152 @param name The name of the property.
153 @param value The current value of the property.
154 @exception NonDynamicConfigProperty if the property is not dynamic.
155 @exception InvalidPropertyValue if the property value is not valid.
156 @exception UnrecognizedConfigProperty if the property is not defined.
157 */
158 void updateCurrentValue(const String& name, const String& value);
159 //throw (NonDynamicConfigProperty, InvalidPropertyValue,
160 // UnrecognizedConfigProperty);
161
162
163 /**
164 Update planned value of the specified property to the specified value.
165
166 @param name The name of the property.
167 @param value The planned value of the property.
168 @exception InvalidPropertyValue if the property value is not valid.
169 kumpf 1.1.2.1 @exception UnrecognizedConfigProperty if the property is not defined.
170 */
171 void updatePlannedValue(const String& name, const String& value);
172 //throw (InvalidPropertyValue, UnrecognizedConfigProperty);
173
174
175 /**
176 Checks to see if the given value is valid or not.
177
178 @param name The name of the property.
179 @param value The value of the property to be validated.
180 @return Boolean True if the specified value for the property is valid.
181 @exception UnrecognizedConfigProperty if the property is not defined.
182 */
183 Boolean isValid(const String& name, const String& value);
184 //throw (UnrecognizedConfigProperty);
185
186
187 /**
188 Checks to see if the specified property is dynamic or not.
189
190 kumpf 1.1.2.1 @param name The name of the property.
191 @return Boolean True if the specified property is dynamic.
192 @exception UnrecognizedConfigProperty if the property is not defined.
193 */
194 Boolean isDynamic(const String& name);
195 //throw (UnrecognizedConfigProperty);
196
197
198 private:
199
200 /**
201 The security properties owned by this class
202 */
203 struct ConfigProperty* _requireAuthentication;
204
205 struct ConfigProperty* _httpAuthType;
206
207 };
208
209 PEGASUS_NAMESPACE_END
210
211 kumpf 1.1.2.1 #endif /* Pegasus_SecurityPropertyOwner_h */
|
Return to
SecurityPropertyOwner.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Config