OW_NAMESPACE::RemoteInstanceProvider Class Reference

#include <OW_RemoteInstanceProvider.hpp>

Inheritance diagram for OW_NAMESPACE::RemoteInstanceProvider:

[legend]Collaboration diagram for OW_NAMESPACE::RemoteInstanceProvider:


Public Member Functions
	RemoteInstanceProvider (const ProviderEnvironmentIFCRef &env, const String &url, const ClientCIMOMHandleConnectionPoolRef &pool, bool alwaysSendCredentials, bool useConnectionCredentials)
virtual	~RemoteInstanceProvider ()
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, WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EDeepFlag deep, WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::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, WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::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, WBEMFlags::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.
Private Attributes
ClientCIMOMHandleConnectionPoolRef	m_pool
String	m_url
bool	m_alwaysSendCredentials
bool	m_useConnectionCredentials

Detailed Description

Definition at line 47 of file OW_RemoteInstanceProvider.hpp.

Constructor & Destructor Documentation

OW_NAMESPACE::RemoteInstanceProvider::RemoteInstanceProvider ( const ProviderEnvironmentIFCRef & env,

const String & url,

const ClientCIMOMHandleConnectionPoolRef & pool,

bool alwaysSendCredentials,

bool useConnectionCredentials

)

Definition at line 55 of file OW_RemoteInstanceProvider.cpp.

OW_NAMESPACE::RemoteInstanceProvider::~RemoteInstanceProvider ( ) [virtual]

Definition at line 65 of file OW_RemoteInstanceProvider.cpp.

Member Function Documentation

CIMObjectPath OW_NAMESPACE::RemoteInstanceProvider::createInstance ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMInstance & cimInstance

) [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::InstanceProviderIFC.
Definition at line 203 of file OW_RemoteInstanceProvider.cpp.
References OW_NAMESPACE::CIMNULL, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, and OW_NAMESPACE::CIMException::setErrNo().

void OW_NAMESPACE::RemoteInstanceProvider::deleteInstance ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMObjectPath & cop

) [virtual]

This method deletes the instance specified in the object path.

Parameters:

cop The instance to be deleted

Exceptions:

CIMException

Implements OW_NAMESPACE::InstanceProviderIFC.
Definition at line 285 of file OW_RemoteInstanceProvider.cpp.
References OW_NAMESPACE::COMPONENT_NAME, cop, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, and OW_NAMESPACE::CIMException::setErrNo().

void OW_NAMESPACE::RemoteInstanceProvider::enumInstanceNames ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const String & className,

CIMObjectPathResultHandlerIFC & result,

const CIMClass & cimClass

) [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 in the CIMObjectPath is incorrect or does not exist.

Implements OW_NAMESPACE::InstanceProviderIFC.
Definition at line 71 of file OW_RemoteInstanceProvider.cpp.
References className, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, result, and OW_NAMESPACE::CIMException::setErrNo().

void OW_NAMESPACE::RemoteInstanceProvider::enumInstances ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const String & className,

CIMInstanceResultHandlerIFC & result,

WBEMFlags::ELocalOnlyFlag localOnly,

WBEMFlags::EDeepFlag deep,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,

const StringArray * propertyList,

const CIMClass & requestedClass,

const CIMClass & cimClass

) [virtual]

This method enumerates all instances of the class which is specified in className.
The entire instances and not just the names are returned.

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.

Exceptions:

CIMException - thrown if cop is incorrect or does not exist.

Implements OW_NAMESPACE::InstanceProviderIFC.
Definition at line 111 of file OW_RemoteInstanceProvider.cpp.
References className, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, propertyList, result, and OW_NAMESPACE::CIMException::setErrNo().

CIMInstance OW_NAMESPACE::RemoteInstanceProvider::getInstance ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMObjectPath & instanceName,

WBEMFlags::ELocalOnlyFlag localOnly,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,

const StringArray * propertyList,

const CIMClass & cimClass

) [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::InstanceProviderIFC.
Definition at line 157 of file OW_RemoteInstanceProvider.cpp.
References OW_NAMESPACE::CIMNULL, OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, propertyList, and OW_NAMESPACE::CIMException::setErrNo().

void OW_NAMESPACE::RemoteInstanceProvider::modifyInstance ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMInstance & modifiedInstance,

const CIMInstance & previousInstance,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers,

const StringArray * propertyList,

const CIMClass & theClass

) [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::InstanceProviderIFC.
Definition at line 243 of file OW_RemoteInstanceProvider.cpp.
References OW_NAMESPACE::COMPONENT_NAME, env, OW_NAMESPACE::CIMException::FAILED, OW_NAMESPACE::CIMException::getErrNo(), OW_NAMESPACE::RemoteProviderUtils::getRemoteClientCIMOMHandle(), hdl, m_alwaysSendCredentials, m_pool, m_url, m_useConnectionCredentials, OW_NAMESPACE::CIMException::NOT_SUPPORTED, ns, OW_LOG_DEBUG, OW_LOG_INFO, propertyList, and OW_NAMESPACE::CIMException::setErrNo().

Member Data Documentation

bool OW_NAMESPACE::RemoteInstanceProvider::m_alwaysSendCredentials [private]

Definition at line 108 of file OW_RemoteInstanceProvider.hpp.
Referenced by createInstance(), deleteInstance(), enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

ClientCIMOMHandleConnectionPoolRef OW_NAMESPACE::RemoteInstanceProvider::m_pool [private]

Definition at line 106 of file OW_RemoteInstanceProvider.hpp.
Referenced by createInstance(), deleteInstance(), enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

String OW_NAMESPACE::RemoteInstanceProvider::m_url [private]

Definition at line 107 of file OW_RemoteInstanceProvider.hpp.
Referenced by createInstance(), deleteInstance(), enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

bool OW_NAMESPACE::RemoteInstanceProvider::m_useConnectionCredentials [private]

Definition at line 109 of file OW_RemoteInstanceProvider.hpp.
Referenced by createInstance(), deleteInstance(), enumInstanceNames(), enumInstances(), getInstance(), and modifyInstance().

The documentation for this class was generated from the following files:

Generated on Thu Feb 9 09:16:15 2006 for openwbem by

1.4.6

OW_NAMESPACE::RemoteInstanceProvider Class Reference

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation