CIMMethodProvider Class Referenceabstract

#include <CIMMethodProvider.h>

Inheritance diagram for CIMMethodProvider:
CIMProvider

Public Member Functions

 CIMMethodProvider ()
 
virtual ~CIMMethodProvider ()
 
virtual void invokeMethod (const OperationContext &context, const CIMObjectPath &objectReference, const CIMName &methodName, const Array< CIMParamValue > &inParameters, MethodResultResponseHandler &handler)=0
 
- Public Member Functions inherited from CIMProvider
 CIMProvider ()
 
virtual ~CIMProvider ()
 
virtual void initialize (CIMOMHandle &cimom)=0
 
virtual void terminate ()=0
 

Detailed Description

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

A method provider is not required to implement all the methods defined for a CIM class. Multiple method providers may be registered for methods of the same class, but not for the same method. (See the SupportedMethods property of the PG_ProviderCapabilities class.)

Constructor & Destructor Documentation

◆ CIMMethodProvider()

CIMMethodProvider::CIMMethodProvider ( )

Constructs a default CIMMethodProvider object.

◆ ~CIMMethodProvider()

virtual CIMMethodProvider::~CIMMethodProvider ( )
virtual

Destructs a CIMMethodProvider object.

Member Function Documentation

◆ invokeMethod()

virtual void CIMMethodProvider::invokeMethod ( const OperationContext context,
const CIMObjectPath objectReference,
const CIMName methodName,
const Array< CIMParamValue > &  inParameters,
MethodResultResponseHandler handler 
)
pure virtual

Invokes an extrinsic specified method on a specified CIM class or instance.

Parameters
contextAn OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectReferenceA fully qualified CIMObjectPath specifying the class or instance on which to invoke the method.
methodNameThe name of the method to invoke.
inParametersAn Array of CIMParamValue objects specifying the method input parameters.
handlerResponseHandler object for delivery of results.
Exceptions
CIMNotSupportedExceptionIf the method is not supported.
CIMInvalidParameterExceptionIf a parameter is invalid.
CIMObjectNotFoundExceptionIf the object is not found.
CIMAccessDeniedExceptionIf the user requesting the action is not authorized to perform the action.
CIMOperationFailedExceptionIf the operation fails.

The documentation for this class was generated from the following file: