[an error occurred while processing this directive]
[an error occurred while processing this directive] [an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation
[an error occurred while processing this directive]


[an error occurred while processing this directive]

 

Contents

o Introduction
o Objectives
o Overview
o Credits
o Pegasus Architecture
   o Design Goals
   o The Broker
   o Pegasus Providers.
   o Extension Services
   o Pegasus Clients.
   o Functional Flow
o Pegasus Components
   o Component Descriptions
   o Pegasus Directory Structure
o Pegasus Utilization
   o Pegasus Availability
   o Pegasus Installation
   o Pegasus Operation
   o Pegasus CIM Clients
   o Pegasus Providers
   o Pegasus MOF Compiler
o Programming Pegasus
   o CIM Objects in Pegasus
   o CIM Object Table
   o Class Definitions
o Pegasus Interfaces
   o CIM Operations over HTTP
   o Pegasus Client Interfaces
   o Pegasus Provider Interfaces
   o Pegasus Service Extension Interfaces
   o Repository Interfaces
o Writing Providers.
o Glossary
o Pegasus Code Examples
   o Client Examples
   o Client Coding Examples
   o Provider Coding Examples
o Document References
o Pegausus FAQ
o
In file ../../src/Pegasus/Provider/CIMAssociationProvider.h:

class PEGASUS_PROVIDER_LINKAGE CIMAssociationProvider

This class defines the set of methods implemented by an association provider.

Documentation

This class defines the set of methods implemented by an association provider. A providers that derives from this class must implement all of the methods. A minimal method implementation simply throws a CIMNotSupportedException. The methods match the association operations defined for the client:
  • referenceNames
  • references
  • associatorNames
  • associators
Provider instrumentation differs semantically from a client request in that a provider implementation is specific to one association class while a client request may span many association classes. Also, an assocation provider deals only with instance data, while a client may also issue class level association requests.

Inheritance:

Public Methods

[more] CIMAssociationProvider ()
Constructs a default CIMAssociationProvider object
[more]virtual ~CIMAssociationProvider ()
Destructs a CIMAssociationProvider object
[more]virtual void associators ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList & propertyList, ObjectResponseHandler & handler)
Enumerates CIM instances that are associated to a specified instance via a specified association class.
[more]virtual void associatorNames ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, ObjectPathResponseHandler & handler)
Enumerates CIM instance names that are associated to a specified instance via a specified association class.
[more]virtual void references ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList & propertyList, ObjectResponseHandler & handler)
Enumerates CIM association instances that refer to a specified instance.
[more]virtual void referenceNames ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, ObjectPathResponseHandler & handler)
Enumerates the names of CIM association instances that refer to a specified instance.

Inherited from CIMProvider:

Public Methods

ovirtual void initialize(CIMOMHandle & cimom)
ovirtual void terminate()

o CIMAssociationProvider()
Constructs a default CIMAssociationProvider object

ovirtual ~CIMAssociationProvider()
Destructs a CIMAssociationProvider object

ovirtual void associators( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList & propertyList, ObjectResponseHandler & handler) = 0
Enumerates CIM instances that are associated to a specified instance via a specified association class.

Throws:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
Parameters:
context - An OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectName - A fully qualified CIMObjectPath specifying the "source" instance for which to enumerate associated instances.
associationClass - The name of the association class through which the returned instances are associated with the source instance. Instances associated through another class must not be returned.
resultClass - The name of the class to which the returned instances must belong. Instances of this class and its subclasses may be returned, but not instances of another class. If null, the set of returned instances is not constrained by their class.
role - The role of the source instance in the association instance. If the role is not an empty string, the returned instances must be associated with the source instance such that the name of the assocation property referring to the source instance matches the role value.
resultRole - The role of the returned instances in the association instance. If the role is not an empty string, the returned instances must be associated with the source instance such that the name of the assocation property referring to the returned instances matches the role value.
includeQualifiers - A Boolean indicating whether the returned instances must include the qualifiers for the instance and its properties. Qualifiers may be included even if this flag is false.
includeClassOrigin - A Boolean indicating whether the returned instances must include the class origin for each of the instance elements.
propertyList - A CIMPropertyList specifying the minimum set of properties required in the returned instance. Support for this parameter is optional.This parameter can be used by the provider to optimize their code and not fill properties which are not requested.The cimserver will filter all properties using an efficient algorithm hence the returned instance may contain properties not specified in the list.A null propertyList indicates that all properties must be included. A non-null, but empty, propertyList indicates that no properites are required.
handler - ResponseHandler object for delivery of results. Note: The delivered instances are expected to contain the instance path. If the host and namespace are not included in the path, they are added by the CIM Server.

ovirtual void associatorNames( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, ObjectPathResponseHandler & handler) = 0
Enumerates CIM instance names that are associated to a specified instance via a specified association class.

Throws:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
Parameters:
context - An OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectName - A fully qualified CIMObjectPath specifying the "source" instance for which to enumerate associated instance names.
associationClass - The name of the association class through which the returned instance names are associated with the source instance. Names of instances associated through another class must not be returned.
resultClass - The name of the class to which the returned instance names must belong. Names of instances of this class and its subclasses may be returned, but not instances of another class. If null, the set of returned instance names is not constrained by their class.
role - The role of the source instance in the association instance. If the role is not an empty string, the returned instance names must be associated with the source instance such that the name of the assocation property referring to the source instance matches the role value.
resultRole - The role of the returned instance names in the association instance. If the role is not an empty string, the returned instance names must be associated with the source instance such that the name of the assocation property referring to the returned instance names matches the role value.
handler - ResponseHandler object for delivery of results. Note: The delivered instance names are expected to contain host and namespace information. If not included, they are added by the CIM Server.

ovirtual void references( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList & propertyList, ObjectResponseHandler & handler) = 0
Enumerates CIM association instances that refer to a specified instance.

Throws:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
Parameters:
context - An OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectName - A fully qualified CIMObjectPath specifying the "source" instance for which to enumerate referring instances.
resultClass - The class name of the association instances to be returned. Instances of other classes must not be returned.
role - The role of the source instance in the association instance. If the role is not an empty string, the returned association instances must refer to the source instance via a property whose name matches the role value.
includeQualifiers - A Boolean indicating whether the returned instances must include the qualifiers for the instance and its properties. Qualifiers may be included even if this flag is false.
includeClassOrigin - A Boolean indicating whether the returned instances must include the class origin for each of the instance elements.
propertyList - A CIMPropertyList specifying the minimum set of properties required in the returned instance. Support for this parameter is optional.This parameter can be used by the provider to optimize their code and not fill properties which are not requested.The cimserver will filter all properties using an efficient algorithm hence the returned instance may contain properties not specified in the list.A null propertyList indicates that all properties must be included. A non-null, but empty, propertyList indicates that no properites are required.
handler - ResponseHandler object for delivery of results. Note: The delivered instances are expected to contain the instance path. If the host and namespace are not included in the path, they are added by the CIM Server.

ovirtual void referenceNames( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, ObjectPathResponseHandler & handler) = 0
Enumerates the names of CIM association instances that refer to a specified instance.

Throws:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
Parameters:
context - An OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectName - A fully qualified CIMObjectPath specifying the "source" instance for which to enumerate referring instance names.
resultClass - The class name of the association instance names to be returned. Names of instances of other classes must not be returned.
role - The role of the source instance in the association instance. If the role is not an empty string, the returned association instance names must refer to the source instance via a property whose name matches the role value.
handler - ResponseHandler object for delivery of results. Note: The delivered instance names are expected to contain host and namespace information. If not included, they are added by the CIM Server.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java
[an error occurred while processing this directive]