OW_NAMESPACE::CIM_NamespaceInManagerInstProv

OW_NAMESPACE::CIM_NamespaceInManagerInstProv Class Reference

Inheritance diagram for OW_NAMESPACE::CIM_NamespaceInManagerInstProv:

Inheritance graph
[legend]
Collaboration diagram for OW_NAMESPACE::CIM_NamespaceInManagerInstProv:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~CIM_NamespaceInManagerInstProv ()
virtual void getInstanceProviderInfo (InstanceProviderInfo &info)
 A provider should override this method to report which classes in which namespaces it instruments.
virtual void enumInstanceNames (const ProviderEnvironmentIFCRef &env, const String &ns, const String &className, CIMObjectPathResultHandlerIFC &result, const CIMClass &cimClass)
 This method enumerates all names of instances of the class which is specified in cop.
virtual void enumInstances (const ProviderEnvironmentIFCRef &env, const String &ns, const String &className, CIMInstanceResultHandlerIFC &result, ELocalOnlyFlag localOnly, EDeepFlag deep, EIncludeQualifiersFlag includeQualifiers, EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList, const CIMClass &requestedClass, const CIMClass &cimClass)
 This method enumerates all instances of the class which is specified in className.
virtual CIMInstance getInstance (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMObjectPath &instanceName, ELocalOnlyFlag localOnly, EIncludeQualifiersFlag includeQualifiers, EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList, const CIMClass &cimClass)
 This method retrieves the instance specified in the object path.
virtual CIMObjectPath createInstance (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMInstance &cimInstance)
 This method creates the instance specified in the object path.
virtual void modifyInstance (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMInstance &modifiedInstance, const CIMInstance &previousInstance, EIncludeQualifiersFlag includeQualifiers, const StringArray *propertyList, const CIMClass &theClass)
 This method sets the instance specified in the object path.
virtual void deleteInstance (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMObjectPath &cop)
 This method deletes the instance specified in the object path.
virtual void getAssociatorProviderInfo (AssociatorProviderInfo &info)
 A provider should override this method to report which classes in which namespaces it instruments.
virtual void associatorNames (const ProviderEnvironmentIFCRef &env, CIMObjectPathResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const String &assocClass, const String &resultClass, const String &role, const String &resultRole)
 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 referenceNames (const ProviderEnvironmentIFCRef &env, CIMObjectPathResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const String &resultClass, const String &role)
 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 void associators (const ProviderEnvironmentIFCRef &env, CIMInstanceResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const String &assocClass, const String &resultClass, const String &role, const String &resultRole, EIncludeQualifiersFlag includeQualifiers, EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList)
 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 references (const ProviderEnvironmentIFCRef &env, CIMInstanceResultHandlerIFC &result, const String &ns, const CIMObjectPath &objectName, const String &resultClass, const String &role, EIncludeQualifiersFlag includeQualifiers, EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList)
 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.

Classes

class  AssociatorFilter
class  InstanceToObjectPathHandler
class  ReferencesFilter

Detailed Description

Definition at line 62 of file OW_provinstCIM_NamespaceInManager.cpp.

Constructor & Destructor Documentation

virtual OW_NAMESPACE::CIM_NamespaceInManagerInstProv::~CIM_NamespaceInManagerInstProv (   )  [inline, virtual]
 

Definition at line 71 of file OW_provinstCIM_NamespaceInManager.cpp.

Member Function Documentation

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::associatorNames (  const ProviderEnvironmentIFCRef &  env,
CIMObjectPathResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const String &  assocClass,
const String &  resultClass,
const String &  role,
const String &  resultRole
)  [inline, 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

Implements OW_NAMESPACE::CppAssociatorProviderIFC.

Definition at line 246 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::COMPONENT_NAME, OW_NAMESPACE::WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, OW_NAMESPACE::WBEMFlags::E_EXCLUDE_QUALIFIERS, env, OW_NAMESPACE::String::equalsIgnoreCase(), handler, ns, OW_ASSERT, OW_LOG_DEBUG, and result.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::associators (  const ProviderEnvironmentIFCRef &  env,
CIMInstanceResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const String &  assocClass,
const String &  resultClass,
const String &  role,
const String &  resultRole,
EIncludeQualifiersFlag  includeQualifiers,
EIncludeClassOriginFlag  includeClassOrigin,
const StringArray *  propertyList
)  [inline, 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)

Implements OW_NAMESPACE::CppAssociatorProviderIFC.

Definition at line 329 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::COMPONENT_NAME, OW_NAMESPACE::String::empty(), env, OW_NAMESPACE::String::equalsIgnoreCase(), OW_NAMESPACE::CIMObjectPath::getClassName(), OW_ASSERT, and OW_LOG_DEBUG.

virtual CIMObjectPath OW_NAMESPACE::CIM_NamespaceInManagerInstProv::createInstance (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMInstance &  cimInstance
)  [inline, virtual]
 

This method creates the instance specified in the object path.

If the instance does exist an CIMException with ID CIM_ERR_ALREADY_EXISTS must be thrown. The parameter should be the instance name.

Parameters:
cop The path to the instance to be set. The import part in this parameter is the namespace component.
cimInstance The instance to be set
Returns:
A CIM ObjectPath of the instance that was created.
Exceptions:
CIMException 

Implements OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 196 of file OW_provinstCIM_NamespaceInManager.cpp.

References ns.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::deleteInstance (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMObjectPath &  cop
)  [inline, virtual]
 

This method deletes the instance specified in the object path.

Parameters:
cop The instance to be deleted
Exceptions:
CIMException 

Implements OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 217 of file OW_provinstCIM_NamespaceInManager.cpp.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::enumInstanceNames (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const String &  className,
CIMObjectPathResultHandlerIFC &  result,
const CIMClass &  cimClass
)  [inline, virtual]
 

This method enumerates all names of instances of the class which is specified in cop.

Parameters:
cop The object path specifies the class that must be enumerated.
cimClass The class reference
Returns:
An array of CIMObjectPath containing names of the enumerated instances.
Exceptions:
CIMException - throws if the CIMObjectPath is incorrect or does not exist.

Implements OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 80 of file OW_provinstCIM_NamespaceInManager.cpp.

References className, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::Enumeration< T >::hasMoreElements(), hdl, ns, and OW_LOG_DEBUG.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::enumInstances (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const String &  className,
CIMInstanceResultHandlerIFC &  result,
ELocalOnlyFlag  localOnly,
EDeepFlag  deep,
EIncludeQualifiersFlag  includeQualifiers,
EIncludeClassOriginFlag  includeClassOrigin,
const StringArray *  propertyList,
const CIMClass &  requestedClass,
const CIMClass &  cimClass
)  [inline, virtual]
 

This method enumerates all instances of the class which is specified in className.

The entire instances and not just the names are returned. If you don't override this method, the default implementation will be used which utilizes enumInstanceNames() and getInstance()

Parameters:
cop The object path specifies the class that must be enumerated.
cimClass The class reference.
localOnly If true, only the non-inherited properties are to be returned, otherwise all properties are required.
Returns:
An array of CIMInstance containing names of the enumerated instances.
Exceptions:
CIMException - thrown if cop is incorrect or does not exist.

Reimplemented from OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 108 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::Enumeration< T >::hasMoreElements(), hdl, ns, and OW_LOG_DEBUG.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::getAssociatorProviderInfo (  AssociatorProviderInfo &  info  )  [inline, 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.

Reimplemented from OW_NAMESPACE::CppAssociatorProviderIFC.

Definition at line 227 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::ProviderInfoBase< ClassInfoT >::addInstrumentedClass().

virtual CIMInstance OW_NAMESPACE::CIM_NamespaceInManagerInstProv::getInstance (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMObjectPath &  instanceName,
ELocalOnlyFlag  localOnly,
EIncludeQualifiersFlag  includeQualifiers,
EIncludeClassOriginFlag  includeClassOrigin,
const StringArray *  propertyList,
const CIMClass &  cimClass
)  [inline, virtual]
 

This method retrieves the instance specified in the object path.

Parameters:
cop The name of the instance to be retrieved.
cimClass The class to which the instance belongs. This is useful for providers which do not want to create instances from scratch. They can call the class newInstance() routine to create a template for the new instance.
localOnly If true, only the non-inherited properties are to be returned, otherwise all properties are required.
Returns:
The retrieved instance
Exceptions:
CIMException - thrown if cop is incorrect or does not exist

Implements OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 143 of file OW_provinstCIM_NamespaceInManager.cpp.

References cimClass, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMObjectPath::getKeyT(), OW_NAMESPACE::CIMInstance::getNameSpace(), OW_NAMESPACE::CIMProperty::getValueT(), inst, OW_NAMESPACE::CIMClass::newInstance(), ns, OW_LOG_DEBUG, and OW_NAMESPACE::CIMValue::toCIMObjectPath().

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::getInstanceProviderInfo (  InstanceProviderInfo &  info  )  [inline, 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.

Reimplemented from OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 75 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::ProviderInfoBase< ClassInfoT >::addInstrumentedClass().

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::modifyInstance (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMInstance &  modifiedInstance,
const CIMInstance &  previousInstance,
EIncludeQualifiersFlag  includeQualifiers,
const StringArray *  propertyList,
const CIMClass &  theClass
)  [inline, virtual]
 

This method sets the instance specified in the object path.

If the instance does not exist an CIMException with ID CIM_ERR_NOT_FOUND must be thrown. The parameter should be the instance name.

Parameters:
cop The path of the instance to be set. The important part in this parameter is the namespace component.
cimInstance The instance to be set.
Exceptions:
CIMException 

Implements OW_NAMESPACE::CppInstanceProviderIFC.

Definition at line 205 of file OW_provinstCIM_NamespaceInManager.cpp.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::referenceNames (  const ProviderEnvironmentIFCRef &  env,
CIMObjectPathResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const String &  resultClass,
const String &  role
)  [inline, 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.

Implements OW_NAMESPACE::CppAssociatorProviderIFC.

Definition at line 263 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::COMPONENT_NAME, OW_NAMESPACE::WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, OW_NAMESPACE::WBEMFlags::E_EXCLUDE_QUALIFIERS, env, OW_NAMESPACE::String::equalsIgnoreCase(), handler, ns, OW_ASSERT, OW_LOG_DEBUG, and result.

virtual void OW_NAMESPACE::CIM_NamespaceInManagerInstProv::references (  const ProviderEnvironmentIFCRef &  env,
CIMInstanceResultHandlerIFC &  result,
const String &  ns,
const CIMObjectPath &  objectName,
const String &  resultClass,
const String &  role,
EIncludeQualifiersFlag  includeQualifiers,
EIncludeClassOriginFlag  includeClassOrigin,
const StringArray *  propertyList
)  [inline, 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.

Implements OW_NAMESPACE::CppAssociatorProviderIFC.

Definition at line 398 of file OW_provinstCIM_NamespaceInManager.cpp.

References OW_NAMESPACE::COMPONENT_NAME, OW_NAMESPACE::String::empty(), env, OW_NAMESPACE::String::equalsIgnoreCase(), OW_NAMESPACE::CIMObjectPath::getClassName(), OW_ASSERT, and OW_LOG_DEBUG.

The documentation for this class was generated from the following file:
Generated on Thu Feb 9 09:16:23 2006 for openwbem by  doxygen 1.4.6