javax.wbem.provider
Interface CIMMethodProvider

All Superinterfaces:

CIMProvider

public interface CIMMethodProvider

extends CIMProvider

This provides the means to invoke the Extrinsic Method Invocation operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/.

Since:

WBEM 1.0

Method Summary

CIMValue

invokeMethod(CIMObjectPath op, java.lang.String methodName, CIMArgument[] inParams, CIMArgument[] outParams) This method is invoked in order to perform the Extrinsic Method Invocation operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/.

Methods inherited from interface javax.wbem.provider.CIMProvider

cleanup, initialize

Method Detail

invokeMethod

public CIMValue invokeMethod(CIMObjectPath op,
                             java.lang.String methodName,
                             CIMArgument[] inParams,
                             CIMArgument[] outParams)
                      throws CIMException

This method is invoked in order to perform the Extrinsic Method Invocation operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/. The CIMOM calls this method when the extrinsic method specified in the parameters is to be invoked.

Parameters:

op - Contains the path to the instance whose extrinsic method must be invoked. It must include all of the keys.

methodName - The name of the extrinsic method even if only one extrinsic method is supported.

inParams - An array of CIMArgument which are the input parameters for methodName. If methodName has no input parameters then inParams must be NULL.

outParams - An array of CIMArgument which are the output values for methodName returned by the Provider. If methodName has no output parameters then the Provider must set outParams to NULL.

Returns:

CIMValue The return value of the extrinsic method. If the extrinsic method has no return value, it must return NULL. NOTE: The actual data the extrinsic method may return is found in outParams.

Throws:

CIMException - If unsuccessful, one of the following status codes may be returned. The ORDERED list is:

 
   CIM_ERR_ACCESS_DENIED,
   CIM_ERR_NOT_SUPPORTED (provider does not support this method),
   CIM_ERR_INVALID_NAMESPACE,
   CIM_ERR_INVALID_PARAMETER (for this method),
   CIM_ERR_NOT_FOUND (if instance does not exist),
   CIM_ERR_METHOD_NOT_FOUND,
   CIM_ERR_METHOD_NOT_AVAILABLE,
   CIM_ERR_FAILED (some other unspecified error occurred)