CmpiBroker Class Reference

#include <cmpi/CmpiBroker.h>

Inheritance diagram for CmpiBroker:

CmpiObject List of all members.

Public Member Functions

 CmpiBroker (CMPIBroker *b)
CMPIBroker * getEnc () const
CmpiContext prepareAttachThread (const CmpiContext &ctx)
void attachThread (const CmpiContext &ctx)
void detachThread (const CmpiContext &ctx)
void deliverIndication (const CmpiContext &ctx, const char *ns, const CmpiInstance &ind)
CmpiEnumeration enumInstanceNames (const CmpiContext &ctx, const CmpiObjectPath &op)
CmpiInstance getInstance (const CmpiContext &ctx, const CmpiObjectPath &op, const char **properties)
CmpiObjectPath createInstance (const CmpiContext &ctx, const CmpiObjectPath &op, const CmpiInstance &inst)
void setInstance (const CmpiContext &ctx, const CmpiObjectPath &op, const CmpiInstance &inst, const char **properties)
void deleteInstance (const CmpiContext &ctx, const CmpiObjectPath &op)
CmpiEnumeration execQuery (const CmpiContext &ctx, const CmpiObjectPath &op, const char *query, const char *lang)
CmpiEnumeration enumInstances (const CmpiContext &ctx, const CmpiObjectPath &op, const char **properties)
CmpiEnumeration associators (const CmpiContext &ctx, const CmpiObjectPath &op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole, const char **properties)
CmpiEnumeration associatorNames (const CmpiContext &ctx, const CmpiObjectPath &op, const char *assocClass, const char *resultClass, const char *role, const char *resultRole)
CmpiEnumeration references (const CmpiContext &ctx, const CmpiObjectPath &op, const char *resultClass, const char *role, const char **properties)
CmpiEnumeration referenceNames (const CmpiContext &ctx, const CmpiObjectPath &op, const char *resultClass, const char *role)
CmpiData invokeMethod (const CmpiContext &ctx, const CmpiObjectPath &op, const char *method, const CmpiArgs &in, CmpiArgs &out)
void setProperty (const CmpiContext &ctx, const CmpiObjectPath &op, const char *name, const CmpiData &data)
CmpiData getProperty (const CmpiContext &ctx, const CmpiObjectPath &op, const char *name)

Detailed Description

This class encapsulates services provided by the CIM Object Manager

Constructor & Destructor Documentation

CmpiBroker::CmpiBroker (  CMPIBroker *  b  ) 
 

constructor to encapsulate CMPIBroker.

Member Function Documentation

CmpiEnumeration CmpiBroker::associatorNames (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  assocClass,
const char *  resultClass,
const char *  role,
const char *  resultRole
) 
 

Enumerate ObjectPaths associated with the Instance defined by <op>.

Parameters:
ctx Context object
op Source ObjectPath containing namespace, classname and key components.
assocClass If not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClass If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
role If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRole If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
Returns:
Enumeration of ObjectPaths.

CmpiEnumeration CmpiBroker::associators (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  assocClass,
const char *  resultClass,
const char *  role,
const char *  resultRole,
const char **  properties
) 
 

Enumerate instances associated with the Instance defined by the <op>.

Parameters:
ctx Context object
op Source ObjectPath containing namespace, classname and key components.
assocClass If not NULL, MUST be a valid Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClass If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
role If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRole If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
properties If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list
Returns:
Enumeration of Instances.

void CmpiBroker::attachThread (  const CmpiContext &  ctx  ) 
 

This function informs the CMPI run time system that the current thread with Context will begin using CMPI services.

Parameters:
ctx Context object

CmpiObjectPath CmpiBroker::createInstance (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const CmpiInstance &  inst
) 
 

Create Instance from <inst> using <op> as reference.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
inst Complete instance.
Returns:
The assigned instance reference.

void CmpiBroker::deleteInstance (  const CmpiContext &  ctx,
const CmpiObjectPath &  op
) 
 

Delete an existing Instance using <op> as reference.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.

void CmpiBroker::deliverIndication (  const CmpiContext &  ctx,
const char *  ns,
const CmpiInstance &  ind
) 
 

This function requests delivery of an Indication. The CIMOM will locate pertinent subscribers and notify them about the event.

Parameters:
ctx Context object
ns Namespace
ind Indication Instance

void CmpiBroker::detachThread (  const CmpiContext &  ctx  ) 
 

This function informs the CMPI run time system that the current thread will not be using CMPI services anymore. The Context object will be freed during this operation.

Parameters:
ctx Context object

CmpiEnumeration CmpiBroker::enumInstanceNames (  const CmpiContext &  ctx,
const CmpiObjectPath &  op
) 
 

Enumerate Instance Names of the class (and subclasses) defined by <op>.

Parameters:
ctx Context object
op ObjectPath containing namespace and classname components.
Returns:
Enumeration of ObjectPathes.

CmpiEnumeration CmpiBroker::enumInstances (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char **  properties
) 
 

Enumerate Instances of the class (and subclasses) defined by <op>. Instance structure and inheritance scope can be controled using the CMPIInvocationFlags entry in <ctx>.

Parameters:
ctx Context object
op ObjectPath containing namespace and classname components.
properties If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list
Returns:
Enumeration of Instances.

CmpiEnumeration CmpiBroker::execQuery (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  query,
const char *  lang
) 
 

Query the enumeration of instances of the class (and subclasses) defined by <op> using <query> expression.

Parameters:
ctx Context object
op ObjectPath containing namespace and classname components.
query Query expression
lang Query Language
Returns:
Resulting eumeration of Instances.

CMPIBroker * CmpiBroker::getEnc (   )  const
 

getEnc - Gets the encapsulated CMPIBroker.

CmpiInstance CmpiBroker::getInstance (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char **  properties
) 
 

Get Instance using <op> as reference. Instance structure can be controled using the CMPIInvocationFlags entry in <ctx>.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
properties If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list
Returns:
The Instance.

CmpiData CmpiBroker::getProperty (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  name
) 
 

Get the named property value of an Instance defined by the <op> parameter.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
name Property name
Returns:
Property value.

CmpiData CmpiBroker::invokeMethod (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  method,
const CmpiArgs &  in,
CmpiArgs &  out
) 
 

Invoke a named, extrinsic method of an Instance defined by the <op> parameter.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
method Method name
in Input parameters.
out Output parameters.
Returns:
Method return value.

CmpiContext CmpiBroker::prepareAttachThread (  const CmpiContext &  ctx  ) 
 

This function prepares the CMPI run time system to accept a thread that will be using CMPI services. The returned CMPIContext object must be used by the subsequent attachThread() and detachThread() invocations.

Parameters:
ctx Old Context object
Returns:
New Context object to be used by thread to be attached.

CmpiEnumeration CmpiBroker::referenceNames (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  resultClass,
const char *  role
) 
 

Enumerates the association ObjectPaths that refer to the instance defined by <op>.

Parameters:
ctx Context object
op Source ObjectPath containing namespace, classname and key components.
resultClass If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
role If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
Returns:
Enumeration of ObjectPaths.

CmpiEnumeration CmpiBroker::references (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  resultClass,
const char *  role,
const char **  properties
) 
 

Enumerates the association instances that refer to the instance defined by <op>.

Parameters:
ctx Context object
op Source ObjectPath containing namespace, classname and key components.
resultClass If not NULL, MUST be a valid Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses).
role If not NULL, MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
properties If not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list
Returns:
Enumeration of ObjectPaths.

void CmpiBroker::setInstance (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const CmpiInstance &  inst,
const char **  properties
) 
 

Replace an existing Instance from <inst> using <op> as reference.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
inst Complete instance.

void CmpiBroker::setProperty (  const CmpiContext &  ctx,
const CmpiObjectPath &  op,
const char *  name,
const CmpiData &  data
) 
 

Set the named property value of an Instance defined by the <op> parameter.

Parameters:
ctx Context object
op ObjectPath containing namespace, classname and key components.
name Property name
data Property value.

The documentation for this class was generated from the following files:
Generated on Sat Feb 26 13:03:44 2022 for cmpi by  doxygen 1.4.6