[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/Repository/CIMRepository.h:

class PEGASUS_REPOSITORY_LINKAGE CIMRepository

This class provides a simple implementation of a CIM repository.

Documentation

This class provides a simple implementation of a CIM repository. Concurrent access is controlled by an internal lock.

Inheritance:


Public Methods

[more] CIMRepository ( const String& repositoryRoot, Uint32 mode = CIMRepository::MODE_DEFAULT, RepositoryDeclContext* declContext = 0)
Constructor
[more] ~CIMRepository ()
Descructor
[more]CIMClass getClass ( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
getClass
[more]CIMInstance getInstance ( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
getInstance
[more]void deleteClass ( const CIMNamespaceName& nameSpace, const CIMName& className)
deleteClass
[more]void deleteInstance ( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName)
deleteInstance
[more]void createClass ( const CIMNamespaceName& nameSpace, const CIMClass& newClass)
createClass
[more]CIMObjectPath createInstance ( const CIMNamespaceName& nameSpace, const CIMInstance& newInstance)
createInstance
[more]void modifyClass ( const CIMNamespaceName& nameSpace, const CIMClass& modifiedClass)
modifyClass
[more]void modifyInstance ( const CIMNamespaceName& nameSpace, const CIMInstance& modifiedInstance, Boolean includeQualifiers = true, const CIMPropertyList& propertyList = CIMPropertyList())
modifyInstance
[more]Array<CIMClass> enumerateClasses ( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false)
enumerateClasses
[more]Array<CIMName> enumerateClassNames ( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false)
enumerateClassNames
[more]Array<CIMInstance> enumerateInstancesForSubtree ( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean deepInheritance = true, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
Enumerates the instances of the specified class and its subclasses.
[more]Array<CIMInstance> enumerateInstancesForClass ( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
Enumerates the instances of just the specified class.
[more]Array<CIMObjectPath> enumerateInstanceNamesForSubtree ( const CIMNamespaceName& nameSpace, const CIMName& className)
Enumerates the names of the instances of the specified class and its subclasses.
[more]Array<CIMObjectPath> enumerateInstanceNamesForClass ( const CIMNamespaceName& nameSpace, const CIMName& className)
Enumerates the names of the instances of just the specified class.
[more]Array<CIMObject> associators ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
associators
[more]Array<CIMObjectPath> associatorNames ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY)
associatorNames
[more]Array<CIMObject> references ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
references
[more]Array<CIMObjectPath> referenceNames ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY)
referenceNames
[more]CIMValue getProperty ( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName)
getProperty
[more]void setProperty ( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName, const CIMValue& newValue = CIMValue())
setProperty
[more]CIMQualifierDecl getQualifier ( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
getQualifier
[more]void setQualifier ( const CIMNamespaceName& nameSpace, const CIMQualifierDecl& qualifierDecl)
setQualifier
[more]void deleteQualifier ( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
deleteQualifier
[more]Array<CIMQualifierDecl> enumerateQualifiers ( const CIMNamespaceName& nameSpace)
enumerateQualifiers
[more]void deleteNameSpace (const CIMNamespaceName& nameSpace)
Deletes a namespace in the repository.
[more]Boolean isDefaultInstanceProvider ()
Indicates whether instance operations that do not have a provider registered should be served by this repository
[more]void getSubClassNames ( const CIMNamespaceName& nameSpaceName, const CIMName& className, Boolean deepInheritance, Array<CIMName>& subClassNames) const
Get subclass names of the given class in the given namespace.
[more]void getSuperClassNames ( const CIMNamespaceName& nameSpaceName, const CIMName& className, Array<CIMName>& subClassNames) const
Get the names of all superclasses (direct and indirect) of this class

Protected Methods

[more]CIMInstance _getInstance ( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, Boolean includeQualifiers, Boolean includeClassOrigin, const CIMPropertyList& propertyList, Boolean resolveInstance)
Internal getInstance implementation that does not do access control
[more]void _createClass ( const CIMNamespaceName& nameSpace, const CIMClass& newClass)
Internal createClass implementation that does not do access control
[more]CIMObjectPath _createInstance ( const CIMNamespaceName& nameSpace, const CIMInstance& newInstance)
Internal createInstance implementation that does not do access control
[more]void _modifyClass ( const CIMNamespaceName& nameSpace, const CIMClass& modifiedClass)
Internal modifyClass implementation that does not do access control
[more]Array<CIMObjectPath> _associatorNames ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass, const CIMName& resultClass, const String& role, const String& resultRole)
Internal associatorNames implementation that does not do access control
[more]Array<CIMObjectPath> _referenceNames ( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass, const String& role)
Internal referenceNames implementation that does not do access control
[more]CIMQualifierDecl _getQualifier ( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
Internal getQualifier implementation that does not do access control
[more]void _setQualifier ( const CIMNamespaceName& nameSpace, const CIMQualifierDecl& qualifierDecl)
Internal setQualifier implementation that does not do access control

o CIMRepository( const String& repositoryRoot, Uint32 mode = CIMRepository::MODE_DEFAULT, RepositoryDeclContext* declContext = 0)
Constructor

o ~CIMRepository()
Descructor

oCIMClass getClass( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
getClass

oCIMInstance getInstance( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
getInstance

ovoid deleteClass( const CIMNamespaceName& nameSpace, const CIMName& className)
deleteClass

ovoid deleteInstance( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName)
deleteInstance

ovoid createClass( const CIMNamespaceName& nameSpace, const CIMClass& newClass)
createClass

oCIMObjectPath createInstance( const CIMNamespaceName& nameSpace, const CIMInstance& newInstance)
createInstance

ovoid modifyClass( const CIMNamespaceName& nameSpace, const CIMClass& modifiedClass)
modifyClass

ovoid modifyInstance( const CIMNamespaceName& nameSpace, const CIMInstance& modifiedInstance, Boolean includeQualifiers = true, const CIMPropertyList& propertyList = CIMPropertyList())
modifyInstance

oArray<CIMClass> enumerateClasses( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false, Boolean localOnly = true, Boolean includeQualifiers = true, Boolean includeClassOrigin = false)
enumerateClasses

oArray<CIMName> enumerateClassNames( const CIMNamespaceName& nameSpace, const CIMName& className = CIMName(), Boolean deepInheritance = false)
enumerateClassNames

oArray<CIMInstance> enumerateInstancesForSubtree( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean deepInheritance = true, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
Enumerates the instances of the specified class and its subclasses. This method mimics the client behavior for the EnumerateInstances operation, but of course it can only return the instances that reside in the repository. This method does not perform deepInheritance filtering regardless of the value given for that parameter.

This method is useful mainly for testing purposes, and should not be relied upon for complete results in a CIM Server environment.

oArray<CIMInstance> enumerateInstancesForClass( const CIMNamespaceName& nameSpace, const CIMName& className, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
Enumerates the instances of just the specified class. This method mimics the provider behavior for the EnumerateInstances operation.

oArray<CIMObjectPath> enumerateInstanceNamesForSubtree( const CIMNamespaceName& nameSpace, const CIMName& className)
Enumerates the names of the instances of the specified class and its subclasses. This method mimics the client behavior for the EnumerateInstanceNames operation, but of course it can only return the names of the instances that reside in the repository.

This method is useful mainly for testing purposes, and should not be relied upon for complete results in a CIM Server environment.

Parameters:
nameSpace - The namespace in which className resides.
className - The name the class for which to retrieve the instance names.
Returns:
An Array of CIMObjectPath objects containing the names of the instances of the specified class in the specified namespace.

oArray<CIMObjectPath> enumerateInstanceNamesForClass( const CIMNamespaceName& nameSpace, const CIMName& className)
Enumerates the names of the instances of just the specified class. This method mimics the provider behavior for the EnumerateInstanceNames operation.

Parameters:
nameSpace - The namespace in which className resides.
className - The name the class for which to retrieve the instance names.
Returns:
An Array of CIMObjectPath objects containing the names of the instances of the specified class in the specified namespace.

oArray<CIMObject> associators( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
associators

oArray<CIMObjectPath> associatorNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass = CIMName(), const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, const String& resultRole = String::EMPTY)
associatorNames

oArray<CIMObject> references( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY, Boolean includeQualifiers = false, Boolean includeClassOrigin = false, const CIMPropertyList& propertyList = CIMPropertyList())
references

oArray<CIMObjectPath> referenceNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass = CIMName(), const String& role = String::EMPTY)
referenceNames

oCIMValue getProperty( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName)
getProperty

ovoid setProperty( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, const CIMName& propertyName, const CIMValue& newValue = CIMValue())
setProperty

oCIMQualifierDecl getQualifier( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
getQualifier

ovoid setQualifier( const CIMNamespaceName& nameSpace, const CIMQualifierDecl& qualifierDecl)
setQualifier

ovoid deleteQualifier( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
deleteQualifier

oArray<CIMQualifierDecl> enumerateQualifiers( const CIMNamespaceName& nameSpace)
enumerateQualifiers

ovoid deleteNameSpace(const CIMNamespaceName& nameSpace)
Deletes a namespace in the repository. The deleteNameSpace method will only delete a namespace if there are no classed defined in the namespace. Today this is a Pegasus characteristics and not defined as part of the DMTF standards.
Throws:
- Throws NoSuchDirectory if the Namespace does not exist.
Parameters:
- String with the name of the namespace

oBoolean isDefaultInstanceProvider()
Indicates whether instance operations that do not have a provider registered should be served by this repository

ovoid getSubClassNames( const CIMNamespaceName& nameSpaceName, const CIMName& className, Boolean deepInheritance, Array<CIMName>& subClassNames) const
Get subclass names of the given class in the given namespace.
Throws:
CIMException (CIM_ERR_INVALID_CLASS)
Parameters:
nameSpaceName -
className - - class whose subclass names will be gotten. If className is empty, all classnames are returned.
deepInheritance - - if true all descendent classes of class are returned. If className is empty, only root classes are returned.
subClassNames - - output argument to hold subclass names.

ovoid getSuperClassNames( const CIMNamespaceName& nameSpaceName, const CIMName& className, Array<CIMName>& subClassNames) const
Get the names of all superclasses (direct and indirect) of this class

oCIMInstance _getInstance( const CIMNamespaceName& nameSpace, const CIMObjectPath& instanceName, Boolean includeQualifiers, Boolean includeClassOrigin, const CIMPropertyList& propertyList, Boolean resolveInstance)
Internal getInstance implementation that does not do access control

ovoid _createClass( const CIMNamespaceName& nameSpace, const CIMClass& newClass)
Internal createClass implementation that does not do access control

oCIMObjectPath _createInstance( const CIMNamespaceName& nameSpace, const CIMInstance& newInstance)
Internal createInstance implementation that does not do access control

ovoid _modifyClass( const CIMNamespaceName& nameSpace, const CIMClass& modifiedClass)
Internal modifyClass implementation that does not do access control

oArray<CIMObjectPath> _associatorNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& assocClass, const CIMName& resultClass, const String& role, const String& resultRole)
Internal associatorNames implementation that does not do access control

oArray<CIMObjectPath> _referenceNames( const CIMNamespaceName& nameSpace, const CIMObjectPath& objectName, const CIMName& resultClass, const String& role)
Internal referenceNames implementation that does not do access control

oCIMQualifierDecl _getQualifier( const CIMNamespaceName& nameSpace, const CIMName& qualifierName)
Internal getQualifier implementation that does not do access control

ovoid _setQualifier( const CIMNamespaceName& nameSpace, const CIMQualifierDecl& qualifierDecl)
Internal setQualifier implementation that does not do access control


This class has no child classes.
Friends:
class compilerDeclContext
class RepositoryDeclContext

Alphabetic index HTML hierarchy of classes or Java


[an error occurred while processing this directive]