OWBI1::BI1AssociatorProviderIFC

OWBI1::BI1AssociatorProviderIFC Class Reference

This interface is implemented by providers of dynamic association classes. More...

#include <OWBI1_AssociatorProviderIFC.hpp>

Inheritance diagram for OWBI1::BI1AssociatorProviderIFC:

Inheritance graph
[legend]
Collaboration diagram for OWBI1::BI1AssociatorProviderIFC:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~BI1AssociatorProviderIFC ()
virtual void getAssociatorProviderInfo (AssociatorProviderInfo &)
 A provider should override this method to report which classes in which namespaces it instruments.
virtual void associators (const ProviderEnvironmentIFCRef &env, CIMInstanceResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const CIMName &assocClass, const CIMName &resultClass, const CIMName &role, const CIMName &resultRole, const CIMPropertyList &propertyList)=0
 This method is invoked in order to do the Associators operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecAssociators This operation is used to enumerate CIM Instances that are associated to a particular source CIM Object.
virtual void associatorNames (const ProviderEnvironmentIFCRef &env, CIMObjectPathResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const CIMName &assocClass, const CIMName &resultClass, const CIMName &role, const CIMName &resultRole)=0
 For the definition of this operation, refer to http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecAssociatorNames This operation is used to enumerate the names of CIM Instances that are associated to a particular source CIM Instance.
virtual void references (const ProviderEnvironmentIFCRef &env, CIMInstanceResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const CIMName &resultClass, const CIMName &role, const CIMPropertyList &propertyList)=0
 For definition of this operation, refer to http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecReferencesMethod This operation is used to enumerate the association objects that refer to a particular target CIM Instance.
virtual void referenceNames (const ProviderEnvironmentIFCRef &env, CIMObjectPathResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const CIMName &resultClass, const CIMName &role)=0
 For definition of this operation, refer to ttp://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm::SecReferenceNames This operation is used to enumerate the association objects that refer to a particular target CIM Instance.
virtual BI1AssociatorProviderIFC * getAssociatorProvider ()

Detailed Description

This interface is implemented by providers of dynamic association classes.

The CIMOM invokes these methods when it performs association traversal. All calls to the derived provider will be serialized so that providers need not worry about multi-threading issues.

Definition at line 53 of file OWBI1_AssociatorProviderIFC.hpp.

Constructor & Destructor Documentation

OWBI1::BI1AssociatorProviderIFC::~BI1AssociatorProviderIFC (   )  [virtual]
 

Definition at line 44 of file OWBI1_AssociatorProviderIFC.cpp.

Member Function Documentation

virtual void OWBI1::BI1AssociatorProviderIFC::associatorNames (  const ProviderEnvironmentIFCRef &  env,
CIMObjectPathResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const CIMName &  assocClass,
const CIMName &  resultClass,
const CIMName &  role,
const CIMName &  resultRole
)  [pure virtual]
 

For the definition of this operation, refer to http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecAssociatorNames This operation is used to enumerate the names of CIM Instances that are associated to a particular source CIM Instance.

Parameters:
assocClass see associator parameter assocClass
objectName see associator parameter objectName
resultClass see associator parameter resultClass
role see associator parameter role
resultRole see associator parameter resultRole
Returns:
If successful, the method returns zero or more full CIM Instance of Objects meeting the requested criteria.
Exceptions:
CIMException - as defined in the associator method

Implemented in OWBI1::BI1SimpleAssociatorProviderIFC.

virtual void OWBI1::BI1AssociatorProviderIFC::associators (  const ProviderEnvironmentIFCRef &  env,
CIMInstanceResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const CIMName &  assocClass,
const CIMName &  resultClass,
const CIMName &  role,
const CIMName &  resultRole,
const CIMPropertyList &  propertyList
)  [pure virtual]
 

This method is invoked in order to do the Associators operation as defined by the CIM operations over HTTP spec at http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecAssociators This operation is used to enumerate CIM Instances that are associated to a particular source CIM Object.

Parameters:
assocClass Defines the association that the objectName object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName Defines the source CIM Object whose associated Objects are to be returned. This is an instance name. Instance name (modelpath).
resultClass The resultClass input parameter, if not empty (""), MUST be a valid CIM 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) or be this Class (or one of its subclasses).
role The role input parameter, if not empty (""), 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 The resultRole input parameter if not empty (""), 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).
includeQualifiers If the includeQualifiers input parameter is true this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response. If false no elements are present in each returned Object.
includeClassOrigin If the includeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.
propertyList If the propertyList input parameter is 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. Note that if localOnly is specified as true (or deepInheritance is specified as false) this acts as an additional filter on the set or Properties returned (for example, if Property A is included in the propertyList but localOnly is set to true and A is not local to a returned Instance, then it will not be included in that Instance). If the propertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the propertyList parameter is omitted this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object. If the propertyList contains duplicate elements, the Server ignores the duplicates but otherwise processes the request normally. If the propertyList contains elements which are invalid Property names for any target Object, the Server ignores such entries but should otherwise process the request normally. Clients SHOULD NOT explicitly specify properties in the propertyList parameter unless they have specified a non-empty value for the resultClass parameter.
Returns:
If successful, the method returns zero or more CIM Instances meeting the requested criteria.
Exceptions:
CIMException. - The following IDs can be expected. CIM_ERR_ACCESS_DENIED CIM_ERR_NOT_SUPPORTED CIM_ERR_INVALID_NAMESPACE CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters) CIM_ERR_FAILED (some other unspecifed error occurred)

Implemented in OWBI1::BI1SimpleAssociatorProviderIFC.

BI1AssociatorProviderIFC * OWBI1::BI1AssociatorProviderIFC::getAssociatorProvider (   )  [virtual]
 

Reimplemented from OWBI1::BI1ProviderBaseIFC.

Definition at line 55 of file OWBI1_AssociatorProviderIFC.cpp.

void OWBI1::BI1AssociatorProviderIFC::getAssociatorProviderInfo (  AssociatorProviderInfo &   )  [virtual]
 

A provider should override this method to report which classes in which namespaces it instruments.

It should insert an entry for each class it is responsible for. The entry consists of the class name and an optional list of namespaces. If the namespace list is empty, all namespaces are implied. If the method does nothing, then the provider's class must have a provider qualifier that identifies the provider. This old behavior is deprecated and will be removed sometime in the future. This method has a default implementation that does nothing, to allow old providers to be migrated forward with little or no change, but once the old provider location method is removed, this member function will be pure virtual.

Definition at line 49 of file OWBI1_AssociatorProviderIFC.cpp.

Referenced by OWBI1::BI1ProviderIFC::loadProviders().

virtual void OWBI1::BI1AssociatorProviderIFC::referenceNames (  const ProviderEnvironmentIFCRef &  env,
CIMObjectPathResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const CIMName &  resultClass,
const CIMName &  role
)  [pure virtual]
 

For definition of this operation, refer to ttp://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm::SecReferenceNames This operation is used to enumerate the association objects that refer to a particular target CIM Instance.

Parameters:
resultClass see the reference method.
objectName see the reference method.
role see the reference method
Returns:
If successful, the method returns the names of zero or more full CIM Instance paths of Objects meeting the requested criteria.
Exceptions:
CIMException - as defined for associators method.

Implemented in OWBI1::BI1SimpleAssociatorProviderIFC.

virtual void OWBI1::BI1AssociatorProviderIFC::references (  const ProviderEnvironmentIFCRef &  env,
CIMInstanceResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const CIMName &  resultClass,
const CIMName &  role,
const CIMPropertyList &  propertyList
)  [pure virtual]
 

For definition of this operation, refer to http://www.dmtf.org/download/spec/xmls/CIM_HTTP_Mapping10.htm#SecReferencesMethod This operation is used to enumerate the association objects that refer to a particular target CIM Instance.

Parameters:
resultClass Defines the association that the objectName object should be associated to. The provider uses this information to identify which association must be traversed in case it supports more than one association.
objectName The objectName input parameter defines the target CIM Object whose referring Objects are to be returned. This is an Instance name (model path).
role The role input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST refer to the target Object via a Property whose name matches the value of this parameter.
includeQualifiers see the includeQualifiers for associators.
includeClassOrigin see the includeClassOrigin for associators.
propertyList see the propertyList for associators
Returns:
If successful, the method returns zero or more CIM Instances meeting the requested criteria.
Exceptions:
CIMException - as defined for the associators method.

Implemented in OWBI1::BI1SimpleAssociatorProviderIFC.

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:18:48 2006 for openwbem by  doxygen 1.4.6