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

  1 mike  1.2 //%/////////////////////////////////////////////////////////////////////////////
  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 mike  1.2 //==============================================================================
 23           //
 24           // Author: Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com)
 25           //
 26 kumpf 1.4 // Modified By: Sushma Fernandes, Hewlett-Packard Company
 27           //                                (sushma_fernandes@hp.com)
 28 kumpf 1.7 //              Bapu Patil, Hewlett-Packard Company (bapu_patil@hp.com)
 29 mike  1.2 //
 30           //%/////////////////////////////////////////////////////////////////////////////
 31           
 32           
 33           //////////////////////////////////////////////////////////////////////////////
 34           // 
 35           // 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           
 44           
 45           PEGASUS_NAMESPACE_BEGIN
 46           
 47           ///////////////////////////////////////////////////////////////////
 48           //  SecurityPropertyOwner Class
 49           ///////////////////////////////////////////////////////////////////
 50 mike  1.2 
 51           /** 
 52               This is Log property owner class that extends ConfigPropertyOwner
 53               class and provide implementation.
 54           */
 55           class PEGASUS_CONFIG_LINKAGE SecurityPropertyOwner : public ConfigPropertyOwner
 56           {
 57           public:
 58           
 59               /** Constructors  */
 60               SecurityPropertyOwner();
 61           
 62           
 63               /** Destructor  */
 64               ~SecurityPropertyOwner();
 65           
 66               /**
 67               Initialize the config properties.
 68           
 69               This method is expected to be called only once at the start of the
 70               CIMOM. It initializes the properties with the default values.
 71 mike  1.2     */
 72               void initialize();
 73           
 74           
 75               /** 
 76               Get information about the specified property.
 77           
 78               @param propertyName   The name of the property.
 79               @param propertyInfo   List to store the property info.
 80               @exception UnrecognizedConfigProperty  if the property is not defined.
 81               */
 82               void getPropertyInfo(const String& name, Array<String>& propertyInfo);
 83                   //throw (UnrecognizedConfigProperty);
 84           
 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 mike  1.2     */
 93               const String getDefaultValue(const String& name);
 94                   //throw (UnrecognizedConfigProperty);
 95           
 96           
 97               /** 
 98               Get current value of the specified property.
 99           
100               @param  name         The name of the property.
101               @return string containing the currnet value of the property specified.
102               @exception UnrecognizedConfigProperty  if the property is not defined.
103               */
104               const String getCurrentValue(const String& name);
105                   //throw (UnrecognizedConfigProperty);
106           
107           
108               /** 
109               Get planned value of the specified property.
110           
111               @param  name         The name of the property.
112               @return string containing the planned value of the property specified.
113 mike  1.2     @exception UnrecognizedConfigProperty  if the property is not defined.
114               */
115               const String getPlannedValue(const String& name);
116                   //throw (UnrecognizedConfigProperty);
117           
118           
119               /** 
120               Init current value of the specified property to the specified value.
121               This method is expected to be called only once at the start of the
122               CIMOM. The property value will be initialized irrespective of whether
123               the property is dynamic or not.
124           
125               @param  name         The name of the property.
126               @param  value        The current value of the property. 
127               @exception     UnrecognizedConfigProperty  if the property is not defined.
128               @exception     InvalidPropertyValue  if the property value is not valid.
129               */
130               void initCurrentValue(const String& name, const String& value);
131                   //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
132           
133           
134 mike  1.2     /** 
135               Init planned value of the specified property to the specified value.
136               This method is expected to be called only once at the start of the
137               CIMOM. The property value will be initialized irrespective of whether
138               the property is dynamic or not.
139           
140               @param  name         The name of the property.
141               @param  value        The planned value of the property. 
142               @exception     UnrecognizedConfigProperty  if the property is not defined.
143               @exception     InvalidPropertyValue  if the property value is not valid.
144               */
145               void initPlannedValue(const String& name, const String& value); 
146                   //throw (UnrecognizedConfigProperty, InvalidPropertyValue);
147           
148           
149               /** 
150               Update current value of the specified property to the specified value.
151               The property value will be updated only if the property is dynamically
152               updatable.
153           
154               @param  name         The name of the property.
155 mike  1.2     @param  value        The current value of the property. 
156               @exception     NonDynamicConfigProperty  if the property is not dynamic.
157               @exception     InvalidPropertyValue  if the property value is not valid.
158               @exception     UnrecognizedConfigProperty  if the property is not defined.
159               */
160               void updateCurrentValue(const String& name, const String& value);
161                   //throw (NonDynamicConfigProperty, InvalidPropertyValue,
162                   //    UnrecognizedConfigProperty);
163           
164           
165               /** 
166               Update planned value of the specified property to the specified value.
167           
168               @param  name         The name of the property.
169               @param  value        The planned value of the property. 
170               @exception     InvalidPropertyValue  if the property value is not valid.
171               @exception     UnrecognizedConfigProperty  if the property is not defined.
172               */
173               void updatePlannedValue(const String& name, const String& value);
174                   //throw (InvalidPropertyValue, UnrecognizedConfigProperty);
175           
176 mike  1.2 
177               /** 
178               Checks to see if the given value is valid or not.
179           
180               @param  name         The name of the property.
181               @param  value        The value of the property to be validated. 
182               @return Boolean      True if the specified value for the property is valid.
183               @exception UnrecognizedConfigProperty  if the property is not defined.
184               */
185               Boolean isValid(const String& name, const String& value);
186                   //throw (UnrecognizedConfigProperty);
187           
188           
189               /** 
190               Checks to see if the specified property is dynamic or not.
191           
192               @param  name         The name of the property.
193               @return Boolean      True if the specified property is dynamic.
194               @exception UnrecognizedConfigProperty  if the property is not defined.
195               */
196               Boolean isDynamic(const String& name);
197 mike  1.2         //throw (UnrecognizedConfigProperty);
198           
199           
200           private:
201           
202 kumpf 1.5     struct ConfigProperty* _lookupConfigProperty(const String& name);
203           
204 mike  1.2     /**
205               The security properties owned by this class
206               */
207 kumpf 1.6     struct ConfigProperty*      _enableAuthentication;
208 mike  1.2 
209 kumpf 1.6     struct ConfigProperty*      _enableNamespaceAuthorization;
210 mike  1.2 
211               struct ConfigProperty*      _httpAuthType;
212           
213 kumpf 1.3     struct ConfigProperty*      _passwordFilePath;
214 kumpf 1.4 
215               struct ConfigProperty*      _enableRemotePrivilegedUserAccess;
216 kumpf 1.7 
217               struct ConfigProperty*      _certificateFilePath;
218 kumpf 1.3 
219 mike  1.2 };
220           
221           PEGASUS_NAMESPACE_END
222           
223           #endif /* Pegasus_SecurityPropertyOwner_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2