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.22     Functions that support the invocation of methods defined
 51                for a CIM class.

 52 kumpf 1.7  

 53 kumpf 1.22     <p>The <i>Method Provider</i> supports the client InvokeMethod
 54                operation that invokes any method(s)
 55                defined on a CIM class of object. In addition to the
 56                methods from the {@link CIMProvider CIMProvider}
 57                interface that the functions inherit, the Method Provider interface
 58                defines one function:</p>
 59            
 60                <ul>
 61                <li>{@link invokeMethod invokeMethod}</li>
 62                </ul>
 63            
 64                <p>The arguments to <tt>invokeMethod</tt> specify the instance
 65                that the method invokes, the method name, and its
 66                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                may throw a {@link CIMNotSupportedException CIMNotSupportedException}
 71                exception.</p>
 72            
 73                <p>A method provider is not required to implement all of the
 74 kumpf 1.22     CIM methods defined for a class; there can be more than one
 75                method provider for a class. Each provider
 76                may implement a subset of the defined methods, leaving other
 77                methods providers to implemente methods. No method
 78                can be implemented by more than one provider. The
 79                methods that are implemented by a provider must be specified to
 80                the CIM Server through provider registration in the
 81                <tt>SupportedMethods</tt> property of an instance of the
 82                <tt>PG_ProviderCapabilities</tt> class.</p>

 83 chip  1.1  */

 84 kumpf 1.14 class PEGASUS_PROVIDER_LINKAGE CIMMethodProvider : public virtual CIMProvider

 85 chip  1.1  {
 86            public:

 87 kumpf 1.22     /** Constructs a CIMMethodProvider object with null values (default
 88                    constructor).
 89                */
 90                CIMMethodProvider();
 91            

 92 karl  1.17     /** CIMMethodProvider destructor.

 93 kumpf 1.22     */
 94                virtual ~CIMMethodProvider();

 95 chip  1.1  

 96 chip  1.4      /**

 97 kumpf 1.22         Invoke the specified method on the specified instance.

 98 kumpf 1.7  

 99 kumpf 1.22         <p>Instructs the provider to invoke the method specified in the
100                    <tt>methodName</tt> parameter on the object
101                    specified in the <tt>objectReference</tt> parameter.

102 chip  1.4  

103 kumpf 1.22         @param context Specifies the client user's context for this operation,
104                    including the user ID.

105 chip  1.4  

106 kumpf 1.22         @param objectReference Specifies the fully qualified object path
107                    of the class or instance of interest.

108 chip  1.4  

109 kumpf 1.22         @param methodName Specifies the name of the method of interest.

110 chip  1.4  

111 kumpf 1.22         @param inParameters Specifies the input parameters of the method.

112 chip  1.4  

113 kumpf 1.22         @param handler A {@link ResponseHandler ResponseHandler} object used
114                    to deliver results to the CIM Server.

115 chip  1.4  

116 kumpf 1.22         @exception CIMNotSupportedException If the method is not supported.
117                    @exception CIMInvalidParameterException If the parameter is invalid.
118                    @exception CIMObjectNotFoundException If the object is not found.
119                    @exception CIMAccessDeniedException If the user requesting the action
120                    is not authorized to perform the action.
121                    @exception CIMOperationFailedException If the operation fails.

122 chip  1.4      */
123                virtual void invokeMethod(

124 kumpf 1.22         const OperationContext& context,
125                    const CIMObjectPath& objectReference,
126                    const CIMName& methodName,
127                    const Array<CIMParamValue>& inParameters,
128                    MethodResultResponseHandler& handler) = 0;

129 chip  1.1  };
130            
131            PEGASUS_NAMESPACE_END
132            
133            #endif