1 karl 1.21 //%2006////////////////////////////////////////////////////////////////////////
|
2 chip 1.1 //
|
3 karl 1.19 // 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.16 // IBM Corp.; EMC Corporation, The Open Group.
|
7 karl 1.19 // 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.20 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
|
11 karl 1.21 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
12 // EMC Corporation; Symantec Corporation; The Open Group.
|
13 chip 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 karl 1.16 //
|
21 chip 1.1 // 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 #ifndef Pegasus_CIMMethodProvider_h
35 #define Pegasus_CIMMethodProvider_h
36
37 #include <Pegasus/Common/Config.h>
|
38 kumpf 1.14 #include <Pegasus/Provider/CIMProvider.h>
|
39 chip 1.1
40 #include <Pegasus/Common/Array.h>
|
41 kumpf 1.12 #include <Pegasus/Common/CIMName.h>
|
42 kumpf 1.5 #include <Pegasus/Common/CIMObjectPath.h>
|
43 chip 1.1 #include <Pegasus/Common/CIMValue.h>
44 #include <Pegasus/Common/CIMParamValue.h>
|
45 kumpf 1.11 #include <Pegasus/Provider/Linkage.h>
|
46 chip 1.1
47 PEGASUS_NAMESPACE_BEGIN
48
49 /**
|
50 kumpf 1.7 Functions that support the invocation of methods defined
51 for a CIM class.
52
53 <p>The <i>Method Provider</i> supports the client InvokeMethod
|
54 karl 1.17 operation that invokes any method(s)
|
55 kumpf 1.7 defined on a CIM class of object. In addition to the
|
56 karl 1.17 methods from the {@link CIMProvider CIMProvider}
57 interface that the functions inherit, the Method Provider interface
58 defines one function:</p>
|
59 kumpf 1.7
60 <ul>
61 <li>{@link invokeMethod invokeMethod}</li>
62 </ul>
63
64 <p>The arguments to <tt>invokeMethod</tt> specify the instance
|
65 karl 1.17 that the method invokes, the method name, and its
|
66 kumpf 1.7 parameters.</p>
67
68 <p>Providers that derive from this class <i>must</i> implement
69 all of these functions. A minimal implementation of <tt>invokeMethod</tt>
|
70 kumpf 1.15 may throw a {@link CIMNotSupportedException CIMNotSupportedException} exception.</p>
|
71 kumpf 1.7
72 <p>A method provider is not required to implement all of the
73 CIM methods defined for a class; there can be more than one
74 method provider for a class. Each provider
75 may implement a subset of the defined methods, leaving other
|
76 karl 1.17 methods providers to implemente methods. No method
|
77 kumpf 1.15 can be implemented by more than one provider. The
|
78 kumpf 1.7 methods that are implemented by a provider must be specified to
|
79 kumpf 1.15 the CIM Server through provider registration in the
|
80 kumpf 1.7 <tt>SupportedMethods</tt> property of an instance of the
81 <tt>PG_ProviderCapabilities</tt> class.</p>
|
82 chip 1.1 */
|
83 kumpf 1.14 class PEGASUS_PROVIDER_LINKAGE CIMMethodProvider : public virtual CIMProvider
|
84 chip 1.1 {
85 public:
|
86 karl 1.17 /** Constructs a CIMMethodProvider object with null values (default constructor).
87 */
|
88 chip 1.4 CIMMethodProvider(void);
|
89 karl 1.17 /** CIMMethodProvider destructor.
90 */
|
91 chip 1.4 virtual ~CIMMethodProvider(void);
|
92 chip 1.1
|
93 chip 1.4 /**
|
94 kumpf 1.7 Invoke the specified method on the specified instance.
95
96 <p>Instructs the provider to invoke the method specified in the
97 <tt>methodName</tt> parameter on the object
98 specified in the <tt>objectReference</tt> parameter.
|
99 chip 1.4
|
100 karl 1.17 @param context Specifies the client user's context for this operation,
101 including the user ID.
|
102 chip 1.4
|
103 karl 1.17 @param objectReference Specifies the fully qualified object path
|
104 kumpf 1.7 of the class or instance of interest.
|
105 chip 1.4
|
106 karl 1.17 @param methodName Specifies the name of the method of interest.
|
107 chip 1.4
|
108 karl 1.17 @param inParameters Specifies the input parameters of the method.
|
109 chip 1.4
|
110 karl 1.17 @param handler A {@link ResponseHandler ResponseHandler} object used
|
111 kumpf 1.15 to deliver results to the CIM Server.
|
112 chip 1.4
|
113 karl 1.17 @exception CIMNotSupportedException If the method is not supported.
114 @exception CIMInvalidParameterException If the parameter is invalid.
115 @exception CIMObjectNotFoundException If the object is not found.
116 @exception CIMAccessDeniedException If the user requesting the action
117 is not authorized to perform the action.
118 @exception CIMOperationFailedException If the operation fails.
|
119 chip 1.4 */
120 virtual void invokeMethod(
121 const OperationContext & context,
|
122 kumpf 1.5 const CIMObjectPath & objectReference,
|
123 kumpf 1.12 const CIMName & methodName,
|
124 chip 1.4 const Array<CIMParamValue> & inParameters,
|
125 kumpf 1.13 MethodResultResponseHandler & handler) = 0;
|
126 chip 1.1
127 };
128
129 PEGASUS_NAMESPACE_END
130
131 #endif
|