OW_NAMESPACE::ProviderAgentCIMOMHandle Class Reference

#include <OW_ProviderAgentCIMOMHandle.hpp>

Inheritance diagram for OW_NAMESPACE::ProviderAgentCIMOMHandle:

[legend]Collaboration diagram for OW_NAMESPACE::ProviderAgentCIMOMHandle:


Public Member Functions
	ProviderAgentCIMOMHandle (const Map< String, CppProviderBaseIFCRef > &assocProvs, const Map< String, CppProviderBaseIFCRef > &instProvs, const Map< String, CppProviderBaseIFCRef > &secondaryInstProvs, const Map< String, CppProviderBaseIFCRef > &methodProvs, Cache< CIMClass > &cimClasses, const ProviderEnvironmentIFCRef &env, ProviderAgentEnvironment::EClassRetrievalFlag classRetrieval, const ProviderAgentLockerIFCRef &locker)
virtual CIMInstance	getInstance (const String &ns, const CIMObjectPath &instanceName, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	Gets the CIM instance for the specified CIM object path.
virtual void	enumQualifierTypes (const String &ns, CIMQualifierTypeResultHandlerIFC &result)
	Enumerates the qualifiers defined in a namespace.
virtual CIMValue	invokeMethod (const String &ns, const CIMObjectPath &path, const String &methodName, const CIMParamValueArray &inParams, CIMParamValueArray &outParams)
	Executes the specified method on the specified object.
virtual CIMQualifierType	getQualifierType (const String &ns, const String &qualifierName)
	Gets the CIM qualifier type specified in the CIM object path.
virtual void	setQualifierType (const String &ns, const CIMQualifierType &qualifierType)
	Updates the specified CIM qualifier type in the specified namespace if it exists.
virtual void	deleteQualifierType (const String &ns, const String &qualName)
	Deletes a CIM qualfier type.
virtual void	createClass (const String &ns, const CIMClass &cimClass)
	Adds the CIM class to the specified namespace.
virtual void	deleteClass (const String &ns, const String &className)
	Deletes the CIM class specified by className from namespace ns.
virtual void	modifyClass (const String &ns, const CIMClass &cimClass)
	Updates the CIM class within the specified namespace.
virtual void	deleteInstance (const String &ns, const CIMObjectPath &path)
	Deletes the CIM instance specified by path from namespace ns.
virtual void	setProperty (const String &ns, const CIMObjectPath &instanceName, const String &propertyName, const CIMValue &newValue)
	Set the specified CIM instance property.
virtual void	modifyInstance (const String &ns, const CIMInstance &modifiedInstance, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, const StringArray *propertyList=0)
	Update the specified CIM instance within the specified namespace.
virtual CIMObjectPath	createInstance (const String &ns, const CIMInstance &instance)
	Add the specified CIM instance to the specified namespace.
virtual CIMValue	getProperty (const String &ns, const CIMObjectPath &instanceName, const String &propertyName)
	Get the specified CIM instance property.
virtual void	associatorNames (const String &ns, const CIMObjectPath &objectName, CIMObjectPathResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String())
	This method is used to enumerate the names of CIM Objects (Classes or Instances) that are associated to a particular CIM Object.
virtual void	associatorsClasses (const String &ns, const CIMObjectPath &path, CIMClassResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	This operation is used to enumerate CIMClasses that are associated to a particular source CIM Object.
virtual void	associators (const String &ns, const CIMObjectPath &path, CIMInstanceResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.
virtual void	referenceNames (const String &ns, const CIMObjectPath &path, CIMObjectPathResultHandlerIFC &result, const String &resultClass=String(), const String &role=String())
	This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual void	references (const String &ns, const CIMObjectPath &path, CIMInstanceResultHandlerIFC &result, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual void	referencesClasses (const String &ns, const CIMObjectPath &path, CIMClassResultHandlerIFC &result, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	This operation is used to enumerate the association objects that refer to a particular target CIM Class.
virtual void	close ()
	Close the connetion to the CIMOM.
virtual void	enumClassNames (const String &ns, const String &className, StringResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP)
	Enumerates the child classes of className.
virtual void	enumClass (const String &ns, const String &className, CIMClassResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_SHALLOW, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN)
	Enumerates the class specified by the CIMObjectPath.
virtual void	enumInstances (const String &ns, const String &className, CIMInstanceResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	Gathers all instances (the whole instance and not just the names) belonging to the class specified in the path.
virtual void	enumInstanceNames (const String &ns, const String &className, CIMObjectPathResultHandlerIFC &result)
	Gathers all instance names belonging to the class specified in the path.
virtual CIMClass	getClass (const String &ns, const String &className, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
	Gets the CIM class for the specified CIM object path.
virtual void	execQuery (const String &ns, CIMInstanceResultHandlerIFC &result, const String &query, const String &queryLanguage)
	Executes a query to retrieve or modify objects.
Private Member Functions
CppInstanceProviderIFC *	getInstanceProvider (const String &ns, const String &className) const
CppSecondaryInstanceProviderIFC *	getSecondaryInstanceProvider (const String &ns, const String &className) const
CppAssociatorProviderIFC *	getAssociatorProvider (const String &ns, const String &className) const
CppMethodProviderIFC *	getMethodProvider (const String &ns, const String &className, const String &methodName) const
CIMClass	helperGetClass (const String &ns, const String &className)
Private Attributes
Map< String, CppProviderBaseIFCRef >	m_assocProvs
Map< String, CppProviderBaseIFCRef >	m_instProvs
Map< String, CppProviderBaseIFCRef >	m_secondaryInstProvs
Map< String, CppProviderBaseIFCRef >	m_methodProvs
Cache< CIMClass > &	m_cimClasses
ProviderEnvironmentIFCRef	m_PAEnv
ProviderAgentLockerIFCRef	m_locker
ProviderAgentEnvironment::EClassRetrievalFlag	m_classRetrieval
Classes
class	PAReadLock
class	PAWriteLock

Detailed Description

Definition at line 57 of file OW_ProviderAgentCIMOMHandle.hpp.

Constructor & Destructor Documentation

OW_NAMESPACE::ProviderAgentCIMOMHandle::ProviderAgentCIMOMHandle ( const Map< String, CppProviderBaseIFCRef > & assocProvs,

const Map< String, CppProviderBaseIFCRef > & instProvs,

const Map< String, CppProviderBaseIFCRef > & secondaryInstProvs,

const Map< String, CppProviderBaseIFCRef > & methodProvs,

Cache< CIMClass > & cimClasses,

const ProviderEnvironmentIFCRef & env,

ProviderAgentEnvironment::EClassRetrievalFlag classRetrieval,

const ProviderAgentLockerIFCRef & locker

)

Definition at line 63 of file OW_ProviderAgentCIMOMHandle.cpp.

Member Function Documentation

void OW_NAMESPACE::ProviderAgentCIMOMHandle::associatorNames ( const String & ns,

const CIMObjectPath & objectName,

CIMObjectPathResultHandlerIFC & result,

const String & assocClass = String(),

const String & resultClass = String(),

const String & role = String(),

const String & resultRole = String()

) [virtual]

This method is used to enumerate the names of CIM Objects (Classes or Instances) that are associated to a particular CIM Object.

Parameters:

ns The namespace containing the CIM Objects to be enumerated.

objectName Defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (modelpath).

result A callback object that will handle the CIMObjectPaths as they are received.

assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM 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 The ResultClass input parameter, if not empty (""), MUST be 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).

Exceptions:

CIMException - as defined in the associator method

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 310 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CppAssociatorProviderIFC::associatorNames(), getAssociatorProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::associators ( const String & ns,

const CIMObjectPath & path,

CIMInstanceResultHandlerIFC & result,

const String & assocClass = String(),

const String & resultClass = String(),

const String & role = String(),

const String & resultRole = String(),

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.

Parameters:

ns The namspace.

path Defines the path of the source CIM Object whose associated Objects are to be returned. This may be a path to either a Class name or Instance name (model path).

result A callback object that will handle the CIMInstances as they are received.

assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM 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 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 set to E_INCLUDE_QUALIFIERS then all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as QUALIFIER elements in the response. If set to E_EXCLUDE_QUALIFIERS, then no qualifier elements will be present in the returned object(s).

includeClassOrigin If set to E_INCLUDE_CLASS_ORIGIN, then the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If set to E_EXCLUDE_CLASS_ORIGIN, 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. If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL 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 MUST ignore the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server MUST ignore such entries but 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.

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 unspecified error occurred).

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 348 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CppAssociatorProviderIFC::associators(), getAssociatorProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, propertyList, and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::associatorsClasses ( const String & ns,

const CIMObjectPath & path,

CIMClassResultHandlerIFC & result,

const String & assocClass = String(),

const String & resultClass = String(),

const String & role = String(),

const String & resultRole = String(),

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

This operation is used to enumerate CIMClasses that are associated to a particular source CIM Object.

Parameters:

ns The namspace.

path Defines the path of the source CIM Object whose associated Objects are to be returned. This may be a path to either a Class name or Instance name (model path).

result A callback object that will handle the CIMClasses as they are received.

assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM 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 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 set to E_INCLUDE_QUALIFIERS then all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response.If set to E_EXCLUDE_QUALIFIERS, then no qualifiers will be present in the returned object(s).

includeClassOrigin If the IncludeClassOrigin input parameter is set to E_INCLUDE_ORIGIN, then the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If set to E_EXCLUDE_ORIGIN, 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. If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL 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 MUST ignore the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server MUST ignore such entries but 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.

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 unspecified error occurred)

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 332 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::close ( ) [virtual]

Close the connetion to the CIMOM.
This will free resources used for the client session. The destructor will call close().
Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 433 of file OW_ProviderAgentCIMOMHandle.cpp.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::createClass ( const String & ns,

const CIMClass & cimClass

) [virtual]

Adds the CIM class to the specified namespace.

Parameters:

ns The namespace

cimClass The CIMClass to be added

Exceptions:

CIMException If the CIM class already exists in the namespace.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 184 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

CIMObjectPath OW_NAMESPACE::ProviderAgentCIMOMHandle::createInstance ( const String & ns,

const CIMInstance & instance

) [virtual]

Add the specified CIM instance to the specified namespace.

Parameters:

ns The namespace

instance the CIMInstance to be added

Returns:
An CIMObjectPath of the created instance.

Exceptions:

CIMException If the CIM instance already exists in the namespace

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 274 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CppInstanceProviderIFC::createInstance(), OW_NAMESPACE::CIMInstance::getClassName(), getInstanceProvider(), getSecondaryInstanceProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::deleteClass ( const String & ns,

const String & className

) [virtual]

Deletes the CIM class specified by className from namespace ns.

Parameters:

ns The namespace containing the class to delete.

className The class to delete.

Exceptions:

CIMException If the object does not exist

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 191 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::deleteInstance ( const String & ns,

const CIMObjectPath & path

) [virtual]

Deletes the CIM instance specified by path from namespace ns.

Parameters:

ns The namespace containing the instance.

path The CIMObjectPath identifying the instance to delete.

Exceptions:

CIMException If the instance does not exist.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 206 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CppInstanceProviderIFC::deleteInstance(), OW_NAMESPACE::CIMObjectPath::getClassName(), getInstanceProvider(), getSecondaryInstanceProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::deleteQualifierType ( const String & ns,

const String & qualName

) [virtual]

Deletes a CIM qualfier type.

Parameters:

ns The namespace containing the qualifier type

qualName The qualifier type to delete.

Exceptions:

CIMException If the qualifier type does not exist.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 177 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::enumClass ( const String & ns,

const String & className,

CIMClassResultHandlerIFC & result,

WBEMFlags::EDeepFlag deep = WBEMFlags::E_SHALLOW,

WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN

) [virtual]

Enumerates the class specified by the CIMObjectPath.

Parameters:

ns The namespace.

className The class to be enumerated.

result A callback object that will handle the classes as they are received.

deep If set to E_DEEP, the enumeration returned will contain the names of all classes derived from the enumerated class. If set to E_SHALLOW the enumermation will return onlythe names of the first level children of the enumerated class.

localOnly If set to E_LOCAL_ONLY, only the non-inherited properties are returned on each instance, otherwise all properties are returned.

includeQualifiers If set to E_INCLUDE_QUALIFIERS, then all class, property and method qualifiers will be returned.

includeClassOrigin If E_INCLUDE_CLASS_ORIGIN, then the class origin attribute will be included with all appropriate elements of each class.

Exceptions:

CIMException If the specified class cannot be found

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 449 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::enumClassNames ( const String & ns,

const String & className,

StringResultHandlerIFC & result,

WBEMFlags::EDeepFlag deep = WBEMFlags::E_DEEP

) [virtual]

Enumerates the child classes of className.

Parameters:

ns The namespace.

className The class to be enumerated. Pass an empty string if you wish to enumerate all classes.

result A callback object that will handle the classe names as they are received.

deep If set to E_DEEP, the enumeration returned will contain the names of all classes derived from the enumerated class. If set to E_SHALLOW the enumermation will return only the names of the first level children of the enumerated class.

Exceptions:

CIMException If the specified CIMObjectPath object cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 439 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::enumInstanceNames ( const String & ns,

const String & className,

CIMObjectPathResultHandlerIFC & result

) [virtual]

Gathers all instance names belonging to the class specified in the path.
This could include instances of all the classes in the specified class' hierarchy.

Parameters:

ns The namespace.

className The class whose instances are to be enumerated.

result A callback object that will handle the instances names as they are received.

Exceptions:

CIMException If the object cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 487 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::CppInstanceProviderIFC::enumInstanceNames(), getInstanceProvider(), helperGetClass(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::enumInstances ( const String & ns,

const String & className,

CIMInstanceResultHandlerIFC & result,

WBEMFlags::EDeepFlag deep = WBEMFlags::E_DEEP,

WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

Gathers all instances (the whole instance and not just the names) belonging to the class specified in the path.
This could include instances of all the classes in the specified class' hierarchy.

Parameters:

ns The namespace.

className The class whose instances are to be enumerated.

result A callback object that will handle the instances as they are received.

deep Return properties defined on subclasses of the class in path

localOnly If set to E_LOCAL_ONLY, only the non-inherited properties are returned on each instance, otherwise all inherited properties are returned.

includeQualifiers If set to E_INCLUDE_QUALIFIERS, then all of the qualifiers from the class will be returned with the each instance.

includeClassOrigin If E_INCLUDE_CLASS_ORIGIN, then the class origin attribute will be returned on all appropriate elements.

propertyList If not NULL and has 0 or more elements, the returned instances will not contain properties missing from this list. If not NULL and it contains NO elements, then no properties will be included in the instances. If propertyList IS NULL, then it is ignored and all properties are returned with the instances subject to constraints specified in the other parameters.

Exceptions:

CIMException If the object cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 462 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::CppInstanceProviderIFC::enumInstances(), getInstanceProvider(), helperGetClass(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, propertyList, and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::enumQualifierTypes ( const String & ns,

CIMQualifierTypeResultHandlerIFC & result

) [virtual]

Enumerates the qualifiers defined in a namespace.

Parameters:

ns The namespace whose qualifier definitions are to be enumerated.

result A callback object that will handle the qualifier types as they are received.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 135 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::execQuery ( const String & ns,

CIMInstanceResultHandlerIFC & result,

const String & query,

const String & queryLanguage

) [virtual]

Executes a query to retrieve or modify objects.

Parameters:

ns CIMNameSpace that identifies the namespace in which to query.

query A string containing the text of the query. This parameter cannot be empty..

queryLanguage A string containing the query language the query is written in.

Returns:
CIMInstanceArray A deep enumeration of all instances of the specified class and all classes derived from the specified class, that match the query string.

Exceptions:

CIMException If any of the following errors occur: The user does not have permission to view the result. The requested query language is not supported. The query specifies a class that does not exist.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 517 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

CppAssociatorProviderIFC * OW_NAMESPACE::ProviderAgentCIMOMHandle::getAssociatorProvider ( const String & ns,

const String & className

) const [private]

Definition at line 619 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::Map< Key, T, Compare >::end(), OW_NAMESPACE::Map< Key, T, Compare >::find(), m_assocProvs, ns, OW_ASSERT, and OW_NAMESPACE::String::toLowerCase().
Referenced by associatorNames(), associators(), referenceNames(), and references().

CIMClass OW_NAMESPACE::ProviderAgentCIMOMHandle::getClass ( const String & ns,

const String & className,

WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

Gets the CIM class for the specified CIM object path.

Parameters:

ns The namespace

classNname The CIM class

localOnly If set to E_LOCAL_ONLY, only the non-inherited properties and methods are returned, otherwise all properties and methods are returned.

includeQualifiers If set to E_INCLUDE_QUALIFIERS, then all class, property and method qualifiers will be included in the CIMClass. Otherwise qualifiers will be excluded.

includeClassOrigin If true, then the classOrigin attribute will be present on all appropriate elements of the CIMClass.

propertyList If not NULL, only properties contained in this array will be included in the CIMClass. If NULL, all properties will be returned.

Returns:
CIMClass the CIM class indentified by the CIMObjectPath

Exceptions:

CIMException If the namespace or the model path identifying the object cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 505 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

CIMInstance OW_NAMESPACE::ProviderAgentCIMOMHandle::getInstance ( const String & ns,

const CIMObjectPath & instanceName,

WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

Gets the CIM instance for the specified CIM object path.

Parameters:

ns The namespace.

instanceName The CIMObjectPath that identifies this CIM instance

localOnly If set to E_LOCAL_ONLY, only the non-inherited properties are returned, otherwise all properties are returned.

includeQualifiers If set to E_INCLUDE_QUALIFIERS, then all of the qualifiers from the class will be returned with the instance. Otherwise no qualifiers will be included with the instance.

includeClassOrigin If set to E_INCLUDE_CLASS_ORIGIN, then the class origin attribute will be returned on all appropriate elements.

propertyList If not NULL and has 0 or more elements, the returned instance will not contain properties missing from this list. If not NULL and it contains NO elements, then no properties will be included in the instance. If propertyList IS NULL, then it is ignored and all properties are returned with the instance subject to constraints specified in the other parameters.

Returns:
The CIMInstance identified by the CIMObjectPath.

Exceptions:

CIMException If the specified CIMObjectPath cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 85 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMNULL, OW_NAMESPACE::WBEMFlags::E_SHALLOW, OW_NAMESPACE::CIMObjectPath::getClassName(), OW_NAMESPACE::CppInstanceProviderIFC::getInstance(), getInstanceProvider(), OW_NAMESPACE::CIMObjectPath::getKeys(), getSecondaryInstanceProvider(), helperGetClass(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_ASSERT, OW_THROWCIM, propertyList, OW_NAMESPACE::Array< T >::push_back(), and OW_NAMESPACE::Array< T >::size().

CppInstanceProviderIFC * OW_NAMESPACE::ProviderAgentCIMOMHandle::getInstanceProvider ( const String & ns,

const String & className

) const [private]

Definition at line 550 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::Map< Key, T, Compare >::end(), OW_NAMESPACE::Map< Key, T, Compare >::find(), m_instProvs, ns, OW_ASSERT, and OW_NAMESPACE::String::toLowerCase().
Referenced by createInstance(), deleteInstance(), enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

CppMethodProviderIFC * OW_NAMESPACE::ProviderAgentCIMOMHandle::getMethodProvider ( const String & ns,

const String & className,

const String & methodName

) const [private]

Definition at line 654 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::Map< Key, T, Compare >::end(), OW_NAMESPACE::Map< Key, T, Compare >::find(), m_methodProvs, ns, OW_ASSERT, and OW_NAMESPACE::String::toLowerCase().
Referenced by invokeMethod().

CIMValue OW_NAMESPACE::ProviderAgentCIMOMHandle::getProperty ( const String & ns,

const CIMObjectPath & instanceName,

const String & propertyName

) [virtual]

Get the specified CIM instance property.

Parameters:

ns The namespace

instanceName A CIMObjectPath that identifies the CIM instance to be accessed.

propertyName The name of the property to retrieve.

Returns:
The CIMvalue for property identified by propertyName.

Exceptions:

CIMException

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 299 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

CIMQualifierType OW_NAMESPACE::ProviderAgentCIMOMHandle::getQualifierType ( const String & ns,

const String & qualifierName

) [virtual]

Gets the CIM qualifier type specified in the CIM object path.

Parameters:

ns The namespace

qualifierName The name of the CIM qualifier type.

Returns:
An CIMQualifierType identified by name.

Exceptions:

CIMException If the CIM qualifier type cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 163 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

CppSecondaryInstanceProviderIFC * OW_NAMESPACE::ProviderAgentCIMOMHandle::getSecondaryInstanceProvider ( const String & ns,

const String & className

) const [private]

Definition at line 584 of file OW_ProviderAgentCIMOMHandle.cpp.
References className, OW_NAMESPACE::Map< Key, T, Compare >::end(), OW_NAMESPACE::Map< Key, T, Compare >::find(), m_secondaryInstProvs, ns, OW_ASSERT, and OW_NAMESPACE::String::toLowerCase().
Referenced by createInstance(), deleteInstance(), getInstance(), and modifyInstance().

CIMClass OW_NAMESPACE::ProviderAgentCIMOMHandle::helperGetClass ( const String & ns,

const String & className

) [private]

Definition at line 690 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::Cache< T >::addToCache(), ch, OW_NAMESPACE::CIMNULL, className, OW_NAMESPACE::ProviderAgentEnvironment::E_RETRIEVE_CLASSES, OW_NAMESPACE::Cache< T >::getFromCache(), m_cimClasses, m_classRetrieval, m_PAEnv, ns, and OW_NAMESPACE::String::toLowerCase().
Referenced by enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

CIMValue OW_NAMESPACE::ProviderAgentCIMOMHandle::invokeMethod ( const String & ns,

const CIMObjectPath & path,

const String & methodName,

const CIMParamValueArray & inParams,

CIMParamValueArray & outParams

) [virtual]

Executes the specified method on the specified object.
A method is a declaration containing the method name, return type, and parameters in the method.
Parameters:

ns The namespace.

path An CIMObjectPath that identifies the class or instance on which to invoke the method.

methodName The string name of the method to be invoked

inParams The input parameters specified as an CIMValueArray.

outParams The output parameters.

Returns:
A non-null CIMValue on success. Otherwise a null CIMValue.

Exceptions:

CIMException If the specified method cannot be found.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 143 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMObjectPath::getClassName(), getMethodProvider(), OW_NAMESPACE::CppMethodProviderIFC::invokeMethod(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, outParams, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::modifyClass ( const String & ns,

const CIMClass & cimClass

) [virtual]

Updates the CIM class within the specified namespace.

Parameters:

ns The namespace

cimClass The CIMClass to be updated

Exceptions:

CIMException If the class does not exists

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 198 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::modifyInstance ( const String & ns,

const CIMInstance & modifiedInstance,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,

const StringArray * propertyList = 0

) [virtual]

Update the specified CIM instance within the specified namespace.

Parameters:

ns The namespace

modifiedInstance The CIMInstance to be updated.

includeQualifiers If set to E_INCLUDE_QUALIFIERS, the qualifiers will also be modified.

propertyList The properties to modify. 0 means all properties.

Exceptions:

CIMException

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 241 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMNULL, OW_NAMESPACE::CIMInstance::getClassName(), getInstanceProvider(), getSecondaryInstanceProvider(), helperGetClass(), m_locker, m_PAEnv, OW_NAMESPACE::CppInstanceProviderIFC::modifyInstance(), OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, and propertyList.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::referenceNames ( const String & ns,

const CIMObjectPath & path,

CIMObjectPathResultHandlerIFC & result,

const String & resultClass = String(),

const String & role = String()

) [virtual]

This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).

Parameters:

ns The namespace.

path The ObjectName input parameter defines the target CIM Object path whose referring object names are to be returned. It may be either a Class name or an Instance name (model path).

result A callback object to handle the object paths as they are received.

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 Object Names by mandating that each returned Object Name MUST identify an Instance of this Class (or one of its subclasses), or 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 Object Names by mandating that each returned Object Name MUST identify an Object that refers to the target Instance via a Property whose name matches the value of this parameter.

Exceptions:

CIMException As defined for associators method.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 375 of file OW_ProviderAgentCIMOMHandle.cpp.
References getAssociatorProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, OW_NAMESPACE::CppAssociatorProviderIFC::referenceNames(), and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::references ( const String & ns,

const CIMObjectPath & path,

CIMInstanceResultHandlerIFC & result,

const String & resultClass = String(),

const String & role = String(),

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).

Parameters:

ns The namespace.

path The path input parameter defines the target CIM Object whose referring Objects are to be returned. This is either a Class name or Instance name (model path).

result A callback object which will handle the instances as they are received.

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 an Instance of this Class (or one of its subclasses), or 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 Objects MUST refer to the target Object via a Property whose name matches the value of this parameter.

includeQualifiers Refer to includeQualifiers for associators.

includeClassOrigin Refer to includeQualifiers for associators.

propertyList Refer to includeQualifiers for associators.

See also:
associators

Exceptions:

CIMException - as defined for associators method.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 394 of file OW_ProviderAgentCIMOMHandle.cpp.
References getAssociatorProvider(), m_locker, m_PAEnv, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_THROWCIM, propertyList, OW_NAMESPACE::CppAssociatorProviderIFC::references(), and result.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::referencesClasses ( const String & ns,

const CIMObjectPath & path,

CIMClassResultHandlerIFC & result,

const String & resultClass = String(),

const String & role = String(),

WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,

const StringArray * propertyList = 0

) [virtual]

This operation is used to enumerate the association objects that refer to a particular target CIM Class.

See also:
references

Exceptions:

CIMException - as defined for associators method.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 419 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::setProperty ( const String & ns,

const CIMObjectPath & instanceName,

const String & propertyName,

const CIMValue & newValue

) [virtual]

Set the specified CIM instance property.

Parameters:

ns The namespace containing the instance to modify.

instanceName An CIMObjectPath that identifies the CIM instance to be accessed.

propertyName The name of the property to set the value on.

newValue The new value for property propertyName.

Exceptions:

CIMException

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 229 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.

void OW_NAMESPACE::ProviderAgentCIMOMHandle::setQualifierType ( const String & ns,

const CIMQualifierType & qualifierType

) [virtual]

Updates the specified CIM qualifier type in the specified namespace if it exists.
If it doesn't exist, it will be added.
Parameters:

ns The namespace

qualifierType The CIM qualifier type to be updated or added.

Implements OW_NAMESPACE::CIMOMHandleIFC.
Definition at line 170 of file OW_ProviderAgentCIMOMHandle.cpp.
References OW_NAMESPACE::CIMException::NOT_SUPPORTED, and OW_THROWCIM.