1 martin 1.37 //%LICENSE////////////////////////////////////////////////////////////////
|
2 martin 1.38 //
|
3 martin 1.37 // 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 martin 1.38 //
|
10 martin 1.37 // 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 martin 1.38 //
|
17 martin 1.37 // The above copyright notice and this permission notice shall be included
18 // in all copies or substantial portions of the Software.
|
19 martin 1.38 //
|
20 martin 1.37 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
21 martin 1.38 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
22 martin 1.37 // 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 martin 1.38 //
|
28 martin 1.37 //////////////////////////////////////////////////////////////////////////
|
29 mike 1.2 //
30 //%/////////////////////////////////////////////////////////////////////////////
31
32
33 //////////////////////////////////////////////////////////////////////////////
|
34 david.dillard 1.27 //
|
35 mike 1.2 // This file defines the security property owner class.
36 //
37 //////////////////////////////////////////////////////////////////////////////
38
39 #ifndef Pegasus_SecurityPropertyOwner_h
40 #define Pegasus_SecurityPropertyOwner_h
41
42 #include <Pegasus/Config/ConfigPropertyOwner.h>
|
43 a.arora 1.21 #include <Pegasus/Common/AutoPtr.h>
|
44 mike 1.2
45
46 PEGASUS_NAMESPACE_BEGIN
47
48 ///////////////////////////////////////////////////////////////////
49 // SecurityPropertyOwner Class
50 ///////////////////////////////////////////////////////////////////
51
|
52 david.dillard 1.27 /**
|
53 karl 1.42 This is Security property owner class that extends ConfigPropertyOwner
|
54 mike 1.2 class and provide implementation.
55 */
56 class PEGASUS_CONFIG_LINKAGE SecurityPropertyOwner : public ConfigPropertyOwner
57 {
58 public:
59
|
60 kumpf 1.32 /** Constructor */
|
61 mike 1.2 SecurityPropertyOwner();
62
63 /**
|
64 kumpf 1.32 Initialize the config properties.
|
65 mike 1.2
|
66 kumpf 1.32 This method is expected to be called only once at the start of the
67 CIMOM. It initializes the properties with the default values.
|
68 mike 1.2 */
69 void initialize();
70
|
71 david.dillard 1.27 /**
|
72 kumpf 1.32 Get information about the specified property.
|
73 mike 1.2
|
74 kumpf 1.36 @param name The name of the property.
|
75 kumpf 1.32 @param propertyInfo List to store the property info.
76 @exception UnrecognizedConfigProperty if the property is not defined.
|
77 mike 1.2 */
|
78 kumpf 1.32 void getPropertyInfo(
79 const String& name,
80 Array<String>& propertyInfo) const;
|
81 mike 1.2
|
82 david.dillard 1.27 /**
|
83 karl 1.42 Supplemental help information above and beyond
84 getPropertyHelp. Overrides function in ConfigPropertyOwner
85 to provide possible values.
86 */
|
87 karl 1.43 //// String getPropertyHelpSupplement(const String& name) const;
|
88 karl 1.42
89 /**
|
90 kumpf 1.32 Get default value of the specified property.
|
91 mike 1.2
|
92 kumpf 1.32 @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 mike 1.2 */
|
96 kumpf 1.32 String getDefaultValue(const String& name) const;
|
97 mike 1.2
|
98 david.dillard 1.27 /**
|
99 kumpf 1.32 Get current value of the specified property.
|
100 mike 1.2
|
101 kumpf 1.32 @param name The name of the property.
102 @return string containing the current value of the property specified.
103 @exception UnrecognizedConfigProperty if the property is not defined.
|
104 mike 1.2 */
|
105 kumpf 1.32 String getCurrentValue(const String& name) const;
|
106 mike 1.2
|
107 david.dillard 1.27 /**
|
108 kumpf 1.32 Get planned value of the specified property.
|
109 mike 1.2
|
110 kumpf 1.32 @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 mike 1.2 */
|
114 kumpf 1.32 String getPlannedValue(const String& name) const;
|
115 mike 1.2
|
116 david.dillard 1.27 /**
|
117 kumpf 1.32 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 mike 1.2
|
122 kumpf 1.32 @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 mike 1.2 */
127 void initCurrentValue(const String& name, const String& value);
128
|
129 david.dillard 1.27 /**
|
130 kumpf 1.32 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 @param value The planned value of the property.
137 @exception UnrecognizedConfigProperty if the property is not defined.
138 @exception InvalidPropertyValue if the property value is not valid.
|
139 mike 1.2 */
|
140 david.dillard 1.27 void initPlannedValue(const String& name, const String& value);
|
141 mike 1.2
|
142 david.dillard 1.27 /**
|
143 kumpf 1.32 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 @param value The current value of the property.
|
149 venkat.puvvada 1.39 @param userName User requesting the update.
|
150 venkat.puvvada 1.40 @param timeoutSeconds Timeout in seconds to complete the update.
|
151 kumpf 1.32 @exception NonDynamicConfigProperty if the property is not dynamic.
152 @exception InvalidPropertyValue if the property value is not valid.
153 @exception UnrecognizedConfigProperty if the property is not defined.
|
154 mike 1.2 */
|
155 venkat.puvvada 1.39 void updateCurrentValue(
156 const String& name,
157 const String& value,
|
158 venkat.puvvada 1.40 const String& userName,
159 Uint32 timeoutSeconds);
|
160 mike 1.2 //throw (NonDynamicConfigProperty, InvalidPropertyValue,
161 // UnrecognizedConfigProperty);
162
|
163 david.dillard 1.27 /**
|
164 kumpf 1.32 Update planned value of the specified property to the specified value.
|
165 mike 1.2
|
166 kumpf 1.32 @param name The name of the property.
167 @param value The planned value of the property.
168 @exception UnrecognizedConfigProperty if the property is not defined.
169 @exception InvalidPropertyValue if the property value is not valid.
|
170 mike 1.2 */
171 void updatePlannedValue(const String& name, const String& value);
172
|
173 david.dillard 1.27 /**
|
174 kumpf 1.32 Checks to see if the given value is valid or not.
|
175 mike 1.2
|
176 kumpf 1.32 @param name The name of the property.
177 @param value The value of the property to be validated.
178 @return Boolean True if the specified value for the property is valid.
179 @exception UnrecognizedConfigProperty if the property is not defined.
|
180 mike 1.2 */
|
181 kumpf 1.32 Boolean isValid(const String& name, const String& value) const;
|
182 mike 1.2
|
183 david.dillard 1.27 /**
|
184 kumpf 1.32 Checks to see if the specified property is dynamic or not.
|
185 mike 1.2
|
186 kumpf 1.32 @param name The name of the property.
187 @return Boolean True if the specified property is dynamic.
188 @exception UnrecognizedConfigProperty if the property is not defined.
|
189 mike 1.2 */
|
190 kumpf 1.32 Boolean isDynamic(const String& name) const;
|
191 mike 1.2
192 private:
193
|
194 aruran.ms 1.29 struct ConfigProperty* _lookupConfigProperty(const String& name) const;
|
195 kumpf 1.5
|
196 mike 1.2 /**
|
197 kumpf 1.32 The security properties owned by this class
|
198 mike 1.2 */
|
199 kumpf 1.32 AutoPtr<struct ConfigProperty> _enableAuthentication;
200 AutoPtr<struct ConfigProperty> _enableNamespaceAuthorization;
201 AutoPtr<struct ConfigProperty> _httpAuthType;
202 AutoPtr<struct ConfigProperty> _passwordFilePath;
203 AutoPtr<struct ConfigProperty> _enableRemotePrivilegedUserAccess;
204 AutoPtr<struct ConfigProperty> _certificateFilePath;
205 AutoPtr<struct ConfigProperty> _keyFilePath;
206 AutoPtr<struct ConfigProperty> _trustStore;
207 AutoPtr<struct ConfigProperty> _crlStore;
208 AutoPtr<struct ConfigProperty> _sslClientVerificationMode;
209 AutoPtr<struct ConfigProperty> _sslTrustStoreUserName;
210 AutoPtr<struct ConfigProperty> _enableSubscriptionsForNonprivilegedUsers;
|
211 rohini.deshpande 1.41 AutoPtr<struct ConfigProperty> _cipherSuite;
|
212 ashok.pathak 1.44 AutoPtr<struct ConfigProperty> _sslBackwardCompatibility;
|
213 kumpf 1.15
|
214 kumpf 1.20 #ifdef PEGASUS_ENABLE_USERGROUP_AUTHORIZATION
|
215 kumpf 1.32 AutoPtr<struct ConfigProperty> _authorizedUserGroups;
|
216 kumpf 1.20 #endif
217
|
218 gerarda 1.14 #ifdef PEGASUS_KERBEROS_AUTHENTICATION
|
219 kumpf 1.32 AutoPtr<struct ConfigProperty> _kerberosServiceName;
|
220 gerarda 1.14 #endif
|
221 thilo.boehm 1.35
222 #ifdef PEGASUS_OS_ZOS
223 AutoPtr<struct ConfigProperty> _enableCFZAPPLID;
224 #endif
225
|
226 mike 1.2 };
227
228 PEGASUS_NAMESPACE_END
229
230 #endif /* Pegasus_SecurityPropertyOwner_h */
|
Return to
SecurityPropertyOwner.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Config