1 karl  1.19 //%2004////////////////////////////////////////////////////////////////////////

  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 chip  1.1  //
 10            // Permission is hereby granted, free of charge, to any person obtaining a copy
 11            // of this software and associated documentation files (the "Software"), to
 12            // deal in the Software without restriction, including without limitation the
 13            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 14            // sell copies of the Software, and to permit persons to whom the Software is
 15            // furnished to do so, subject to the following conditions:

 16 karl  1.16 // 

 17 chip  1.1  // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 18            // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 19            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 20            // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 21            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 22            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 23            // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 24            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 25            //
 26            //==============================================================================
 27            //
 28            //%/////////////////////////////////////////////////////////////////////////////
 29            
 30            #ifndef Pegasus_CIMMethodProvider_h
 31            #define Pegasus_CIMMethodProvider_h
 32            
 33            #include <Pegasus/Common/Config.h>

 34 kumpf 1.14 #include <Pegasus/Provider/CIMProvider.h>

 35 chip  1.1  
 36            #include <Pegasus/Common/Array.h>

 37 kumpf 1.12 #include <Pegasus/Common/CIMName.h>

 38 kumpf 1.5  #include <Pegasus/Common/CIMObjectPath.h>

 39 chip  1.1  #include <Pegasus/Common/CIMValue.h>
 40            #include <Pegasus/Common/CIMParamValue.h>

 41 kumpf 1.11 #include <Pegasus/Provider/Linkage.h>

 42 chip  1.1  
 43            PEGASUS_NAMESPACE_BEGIN
 44            
 45            /**

 46 kumpf 1.7  Functions that support the invocation of methods defined
 47            for a CIM class.
 48            
 49            <p>The <i>Method Provider</i> supports the client InvokeMethod

 50 karl  1.17 operation that invokes any method(s)

 51 kumpf 1.7  defined on a CIM class of object. In addition to the

 52 karl  1.17 methods from the {@link CIMProvider CIMProvider}
 53            interface that the functions inherit, the Method Provider interface
 54            defines one function:</p>

 55 kumpf 1.7  
 56            <ul>
 57            <li>{@link invokeMethod invokeMethod}</li>
 58            </ul>
 59            
 60            <p>The arguments to <tt>invokeMethod</tt> specify the instance

 61 karl  1.17 that the method invokes, the method name, and its

 62 kumpf 1.7  parameters.</p>
 63            
 64            <p>Providers that derive from this class <i>must</i> implement
 65            all of these functions. A minimal implementation of <tt>invokeMethod</tt>

 66 kumpf 1.15 may throw a {@link CIMNotSupportedException CIMNotSupportedException} exception.</p>

 67 kumpf 1.7  
 68            <p>A method provider is not required to implement all of the
 69            CIM methods defined for a class; there can be more than one
 70            method provider for a class. Each provider
 71            may implement a subset of the defined methods, leaving other

 72 karl  1.17 methods providers to implemente methods. No method

 73 kumpf 1.15 can be implemented by more than one provider. The

 74 kumpf 1.7  methods that are implemented by a provider must be specified to

 75 kumpf 1.15 the CIM Server through provider registration in the

 76 kumpf 1.7  <tt>SupportedMethods</tt> property of an instance of the
 77            <tt>PG_ProviderCapabilities</tt> class.</p>

 78 chip  1.1  */

 79 kumpf 1.14 class PEGASUS_PROVIDER_LINKAGE CIMMethodProvider : public virtual CIMProvider

 80 chip  1.1  {
 81            public:

 82 karl  1.17     /** Constructs a CIMMethodProvider object with null values (default constructor).
 83            	*/

 84 chip  1.4      CIMMethodProvider(void);

 85 karl  1.17     /** CIMMethodProvider destructor.
 86            	*/

 87 chip  1.4      virtual ~CIMMethodProvider(void);

 88 chip  1.1  

 89 chip  1.4      /**

 90 kumpf 1.7      Invoke the specified method on the specified instance.
 91            
 92                <p>Instructs the provider to invoke the method specified in the
 93                <tt>methodName</tt> parameter on the object
 94                specified in the <tt>objectReference</tt> parameter.

 95 chip  1.4  

 96 karl  1.17     @param context Specifies the client user's context for this operation,
 97                including the user ID.

 98 chip  1.4  

 99 karl  1.17     @param objectReference Specifies the fully qualified object path

100 kumpf 1.7      of the class or instance of interest.

101 chip  1.4  

102 karl  1.17     @param methodName Specifies the name of the method of interest.

103 chip  1.4  

104 karl  1.17     @param inParameters Specifies the input parameters of the method.

105 chip  1.4  

106 karl  1.17     @param handler A {@link ResponseHandler ResponseHandler} object used

107 kumpf 1.15     to deliver results to the CIM Server.

108 chip  1.4  

109 karl  1.17     @exception CIMNotSupportedException If the method is not supported.
110                @exception CIMInvalidParameterException If the parameter is invalid.
111                @exception CIMObjectNotFoundException If the object is not found.
112                @exception CIMAccessDeniedException If the user requesting the action 
113                is not authorized to perform the action.
114                @exception CIMOperationFailedException If the operation fails.

115 chip  1.4      */
116                virtual void invokeMethod(
117            	const OperationContext & context,

118 kumpf 1.5  	const CIMObjectPath & objectReference,

119 kumpf 1.12 	const CIMName & methodName,

120 chip  1.4  	const Array<CIMParamValue> & inParameters,

121 kumpf 1.13 	MethodResultResponseHandler & handler) = 0;

122 chip  1.1  
123            };
124            
125            PEGASUS_NAMESPACE_END
126            
127            #endif