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

  1 karl  1.8 //%2006////////////////////////////////////////////////////////////////////////
  2 kumpf 1.1 //
  3 karl  1.4 // 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.;
  6 karl  1.2 // IBM Corp.; EMC Corporation, The Open Group.
  7 karl  1.4 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8           // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9 karl  1.5 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10           // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 karl  1.8 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12           // EMC Corporation; Symantec Corporation; The Open Group.
 13 kumpf 1.1 //
 14           // Permission is hereby granted, free of charge, to any person obtaining a copy
 15           // of this software and associated documentation files (the "Software"), to
 16           // deal in the Software without restriction, including without limitation the
 17           // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18           // sell copies of the Software, and to permit persons to whom the Software is
 19           // furnished to do so, subject to the following conditions:
 20           // 
 21           // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22           // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23           // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24           // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25           // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26           // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27           // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28           // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29           //
 30           //==============================================================================
 31           //
 32           //%/////////////////////////////////////////////////////////////////////////////
 33           
 34 kumpf 1.1 #ifndef Pegasus_ClientInterface_h
 35           #define Pegasus_ClientInterface_h
 36           
 37           #include <Pegasus/Common/Config.h>
 38           #include <Pegasus/Common/String.h>
 39           #include <Pegasus/Common/CIMName.h>
 40           #include <Pegasus/Common/SSLContext.h>
 41           #include <Pegasus/Common/CIMObject.h>
 42           #include <Pegasus/Common/CIMClass.h>
 43           #include <Pegasus/Common/CIMInstance.h>
 44           #include <Pegasus/Common/CIMObjectPath.h>
 45           #include <Pegasus/Common/CIMValue.h>
 46           #include <Pegasus/Common/CIMParamValue.h>
 47           #include <Pegasus/Common/CIMPropertyList.h>
 48           #include <Pegasus/Common/CIMQualifierDecl.h>
 49           #include <Pegasus/Common/Exception.h>
 50           #include <Pegasus/Common/MessageQueue.h>
 51           #include <Pegasus/Common/Constants.h>
 52 kumpf 1.7 #include <Pegasus/Common/ContentLanguageList.h>
 53 w.white 1.6 #include <Pegasus/Client/ClientOpPerformanceDataHandler.h> //PEP# 128
 54 kumpf   1.1 
 55             PEGASUS_NAMESPACE_BEGIN
 56             
 57             ///////////////////////////////////////////////////////////////////////////////
 58             //
 59             // CIMClientInterface
 60             //
 61             ///////////////////////////////////////////////////////////////////////////////
 62             
 63             class CIMClientInterface : virtual public MessageQueue
 64             {
 65             public:
 66             
 67                 enum { DEFAULT_TIMEOUT_MILLISECONDS = 20000 };
 68             
 69 kumpf   1.9     CIMClientInterface() :
 70 kumpf   1.1         MessageQueue(PEGASUS_QUEUENAME_CLIENT)
 71                 { };
 72             
 73 kumpf   1.9     ~CIMClientInterface() { };
 74 kumpf   1.1 
 75                 virtual void handleEnqueue() = 0;
 76             
 77                 virtual Uint32 getTimeout() const = 0;
 78             
 79                 virtual void setTimeout(Uint32 timeoutMilliseconds) = 0;
 80             
 81 kumpf   1.7     virtual AcceptLanguageList getRequestAcceptLanguages() const = 0;
 82                 virtual ContentLanguageList getRequestContentLanguages() const = 0;
 83                 virtual ContentLanguageList getResponseContentLanguages() const = 0;
 84                 virtual void setRequestAcceptLanguages(const AcceptLanguageList& langs) = 0;
 85 kumpf   1.9     virtual void setRequestContentLanguages(
 86                     const ContentLanguageList& langs) = 0;
 87 kumpf   1.1     virtual void setRequestDefaultLanguages() = 0;
 88             
 89 kumpf   1.9     virtual void registerClientOpPerformanceDataHandler(
 90                     ClientOpPerformanceDataHandler& handler) = 0;
 91 w.white 1.6     virtual void deregisterClientOpPerformanceDataHandler() = 0;
 92             
 93 kumpf   1.1     virtual void connect(
 94                     const String& host,
 95                     const Uint32 portNumber,
 96                     const String& userName,
 97 kumpf   1.9         const String& password) = 0;
 98 kumpf   1.1 
 99                 virtual void connect(
100                     const String& host,
101                     const Uint32 portNumber,
102                     const SSLContext& sslContext,
103                     const String& userName,
104 kumpf   1.9         const String& password) = 0;
105 kumpf   1.1 
106                 virtual void connectLocal() = 0;
107             
108                 virtual void disconnect() = 0;
109             
110                 virtual CIMClass getClass(
111                     const CIMNamespaceName& nameSpace,
112                     const CIMName& className,
113                     Boolean localOnly = true,
114                     Boolean includeQualifiers = true,
115                     Boolean includeClassOrigin = false,
116 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
117 kumpf   1.1 
118                 virtual CIMInstance getInstance(
119                     const CIMNamespaceName& nameSpace,
120                     const CIMObjectPath& instanceName,
121                     Boolean localOnly = true,
122                     Boolean includeQualifiers = false,
123                     Boolean includeClassOrigin = false,
124 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
125 kumpf   1.1 
126                 virtual void deleteClass(
127                     const CIMNamespaceName& nameSpace,
128 kumpf   1.9         const CIMName& className) = 0;
129 kumpf   1.1 
130                 virtual void deleteInstance(
131                     const CIMNamespaceName& nameSpace,
132 kumpf   1.9         const CIMObjectPath& instanceName) = 0;
133 kumpf   1.1 
134                 virtual void createClass(
135                     const CIMNamespaceName& nameSpace,
136 kumpf   1.9         const CIMClass& newClass) = 0;
137 kumpf   1.1 
138                 virtual CIMObjectPath createInstance(
139                     const CIMNamespaceName& nameSpace,
140 kumpf   1.9         const CIMInstance& newInstance) = 0;
141 kumpf   1.1 
142                 virtual void modifyClass(
143                     const CIMNamespaceName& nameSpace,
144 kumpf   1.9         const CIMClass& modifiedClass) = 0;
145 kumpf   1.1 
146                 virtual void modifyInstance(
147                     const CIMNamespaceName& nameSpace,
148                     const CIMInstance& modifiedInstance,
149                     Boolean includeQualifiers = true,
150 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
151 kumpf   1.1 
152                 virtual Array<CIMClass> enumerateClasses(
153                     const CIMNamespaceName& nameSpace,
154                     const CIMName& className = CIMName(),
155                     Boolean deepInheritance = false,
156                     Boolean localOnly = true,
157                     Boolean includeQualifiers = true,
158 kumpf   1.9         Boolean includeClassOrigin = false) = 0;
159 kumpf   1.1 
160                 virtual Array<CIMName> enumerateClassNames(
161                     const CIMNamespaceName& nameSpace,
162                     const CIMName& className = CIMName(),
163 kumpf   1.9         Boolean deepInheritance = false) = 0;
164 kumpf   1.1 
165                 virtual Array<CIMInstance> enumerateInstances(
166                     const CIMNamespaceName& nameSpace,
167                     const CIMName& className,
168                     Boolean deepInheritance = true,
169                     Boolean localOnly = true,
170                     Boolean includeQualifiers = false,
171                     Boolean includeClassOrigin = false,
172 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
173 kumpf   1.1 
174                 virtual Array<CIMObjectPath> enumerateInstanceNames(
175                     const CIMNamespaceName& nameSpace,
176 kumpf   1.9         const CIMName& className) = 0;
177 kumpf   1.1 
178                 virtual Array<CIMObject> execQuery(
179                     const CIMNamespaceName& nameSpace,
180                     const String& queryLanguage,
181 kumpf   1.9         const String& query) = 0;
182 kumpf   1.1 
183                 virtual Array<CIMObject> associators(
184                     const CIMNamespaceName& nameSpace,
185                     const CIMObjectPath& objectName,
186                     const CIMName& assocClass = CIMName(),
187                     const CIMName& resultClass = CIMName(),
188                     const String& role = String::EMPTY,
189                     const String& resultRole = String::EMPTY,
190                     Boolean includeQualifiers = false,
191                     Boolean includeClassOrigin = false,
192 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
193 kumpf   1.1 
194                 virtual Array<CIMObjectPath> associatorNames(
195                     const CIMNamespaceName& nameSpace,
196                     const CIMObjectPath& objectName,
197                     const CIMName& assocClass = CIMName(),
198                     const CIMName& resultClass = CIMName(),
199                     const String& role = String::EMPTY,
200 kumpf   1.9         const String& resultRole = String::EMPTY) = 0;
201 kumpf   1.1 
202                 virtual Array<CIMObject> references(
203                     const CIMNamespaceName& nameSpace,
204                     const CIMObjectPath& objectName,
205                     const CIMName& resultClass = CIMName(),
206                     const String& role = String::EMPTY,
207                     Boolean includeQualifiers = false,
208                     Boolean includeClassOrigin = false,
209 kumpf   1.9         const CIMPropertyList& propertyList = CIMPropertyList()) = 0;
210 kumpf   1.1 
211                 virtual Array<CIMObjectPath> referenceNames(
212                     const CIMNamespaceName& nameSpace,
213                     const CIMObjectPath& objectName,
214                     const CIMName& resultClass = CIMName(),
215 kumpf   1.9         const String& role = String::EMPTY) = 0;
216 kumpf   1.1 
217                 virtual CIMValue getProperty(
218                     const CIMNamespaceName& nameSpace,
219                     const CIMObjectPath& instanceName,
220 kumpf   1.9         const CIMName& propertyName) = 0;
221 kumpf   1.1 
222                 virtual void setProperty(
223                     const CIMNamespaceName& nameSpace,
224                     const CIMObjectPath& instanceName,
225                     const CIMName& propertyName,
226 kumpf   1.9         const CIMValue& newValue = CIMValue()) = 0;
227 kumpf   1.1 
228                 virtual CIMQualifierDecl getQualifier(
229                     const CIMNamespaceName& nameSpace,
230 kumpf   1.9         const CIMName& qualifierName) = 0;
231 kumpf   1.1 
232                 virtual void setQualifier(
233                     const CIMNamespaceName& nameSpace,
234 kumpf   1.9         const CIMQualifierDecl& qualifierDeclaration) = 0;
235 kumpf   1.1 
236                 virtual void deleteQualifier(
237                     const CIMNamespaceName& nameSpace,
238 kumpf   1.9         const CIMName& qualifierName) = 0;
239 kumpf   1.1 
240                 virtual Array<CIMQualifierDecl> enumerateQualifiers(
241 kumpf   1.9         const CIMNamespaceName& nameSpace) = 0;
242 kumpf   1.1 
243                 virtual CIMValue invokeMethod(
244                     const CIMNamespaceName& nameSpace,
245                     const CIMObjectPath& instanceName,
246                     const CIMName& methodName,
247                     const Array<CIMParamValue>& inParameters,
248 kumpf   1.9         Array<CIMParamValue>& outParameters) = 0;
249 kumpf   1.1 };
250             
251             PEGASUS_NAMESPACE_END
252             
253             #endif /* Pegasus_Client_h */

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2