1 martin 1.25 //%LICENSE////////////////////////////////////////////////////////////////

  2 martin 1.26 //

  3 martin 1.25 // Licensed to The Open Group (TOG) under one or more contributor license
  4             // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
  5             // this work for additional information regarding copyright ownership.
  6             // Each contributor licenses this file to you under the OpenPegasus Open
  7             // Source License; you may not use this file except in compliance with the
  8             // License.

  9 martin 1.26 //

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

 16 martin 1.26 //

 17 martin 1.25 // The above copyright notice and this permission notice shall be included
 18             // in all copies or substantial portions of the Software.

 19 martin 1.26 //

 20 martin 1.25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

 21 martin 1.26 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 22 martin 1.25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 23             // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 24             // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 25             // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 26             // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 27 martin 1.26 //

 28 martin 1.25 //////////////////////////////////////////////////////////////////////////

 29 chip   1.1  //
 30             //%/////////////////////////////////////////////////////////////////////////////
 31             
 32             #ifndef Pegasus_CIMMethodProvider_h
 33             #define Pegasus_CIMMethodProvider_h
 34             
 35             #include <Pegasus/Common/Config.h>

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

 37 chip   1.1  
 38             #include <Pegasus/Common/Array.h>

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

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

 41 chip   1.1  #include <Pegasus/Common/CIMValue.h>
 42             #include <Pegasus/Common/CIMParamValue.h>

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

 44 chip   1.1  
 45             PEGASUS_NAMESPACE_BEGIN
 46             
 47             /**

 48 kumpf  1.23     This class defines a set of functions that support the invocation of
 49                 extrinsic methods on a CIM class or instance.

 50 kumpf  1.7  

 51 kumpf  1.23     <p>A method provider is not required to implement all the methods defined
 52                 for a CIM class.  Multiple method providers may be registered for methods
 53                 of the same class, but not for the same method.  (See the
 54                 SupportedMethods property of the PG_ProviderCapabilities class.)</p>

 55 chip   1.1  */

 56 kumpf  1.14 class PEGASUS_PROVIDER_LINKAGE CIMMethodProvider : public virtual CIMProvider

 57 chip   1.1  {
 58             public:

 59 kumpf  1.24     /**
 60                     Constructs a default CIMMethodProvider object.

 61 kumpf  1.22     */
 62                 CIMMethodProvider();
 63             

 64 kumpf  1.24     /**
 65                     Destructs a CIMMethodProvider object.

 66 kumpf  1.22     */
 67                 virtual ~CIMMethodProvider();

 68 chip   1.1  

 69 chip   1.4      /**

 70 kumpf  1.24         Invokes an extrinsic specified method on a specified CIM class or
 71                     instance.

 72 chip   1.4  

 73 kumpf  1.24         @param context An OperationContext object containing the context for
 74                         the processing of the operation.  The context includes the name of
 75                         the requesting user, language information, and other data.
 76                     @param objectReference A fully qualified CIMObjectPath specifying
 77                         the class or instance on which to invoke the method.
 78                     @param methodName The name of the method to invoke.
 79                     @param inParameters An Array of CIMParamValue objects specifying the
 80                         method input parameters.
 81                     @param handler ResponseHandler object for delivery of results.

 82 chip   1.4  

 83 kumpf  1.22         @exception CIMNotSupportedException If the method is not supported.

 84 kumpf  1.23         @exception CIMInvalidParameterException If a parameter is invalid.

 85 kumpf  1.22         @exception CIMObjectNotFoundException If the object is not found.
 86                     @exception CIMAccessDeniedException If the user requesting the action

 87 kumpf  1.23             is not authorized to perform the action.

 88 kumpf  1.22         @exception CIMOperationFailedException If the operation fails.

 89 chip   1.4      */
 90                 virtual void invokeMethod(

 91 kumpf  1.22         const OperationContext& context,
 92                     const CIMObjectPath& objectReference,
 93                     const CIMName& methodName,
 94                     const Array<CIMParamValue>& inParameters,
 95                     MethodResultResponseHandler& handler) = 0;

 96 chip   1.1  };
 97             
 98             PEGASUS_NAMESPACE_END
 99             
100             #endif