OpenClovis Logo

API Classification
Clovis Object Repository (COR)

Classification of COR APIs. More...

Classification of COR APIs.

COR APIs

Clovis Object Repository consists of the following groups of APIs:

Library Life Cycle APIs:

The COR bundle functionality is used to read the attribute values from the OIs. The bundle is created using Bundle Initialize API and it exists till all the values are read from the OIs.

Object Management Data Structures and APIs:

A transaction consists of one or more object Create/Set/Delete operations or a combination of these operations. A transaction-id is created by COR for all the transaction requests. The transaction can be a SIMPLE transaction or COMPLEX transaction. In a SIMPLE transaction only one job can be added and in the COMPLEX transaction more than one job can be added using the same Transaction-Id. These jobs are linked together in the COR-job-list.

Typedefs

Functions

Object Addressing Data Structures and APIs:

COR Provides uniform mechanism to perform operations on MO objects across all Node Instances via MOID. It therefore, enables multiple components to participate in life-cycle events of an MO (Creation/Deletion/State). COR also provides notification mechanism that publishes an event when a MO is created/deleted or state-change occurs.

Typedefs

Enumerations

Functions

Defines

Object Search Data Structures and APIs:

COR provides the capability to retrieve objects matching a particular criterion. This criterion is called the filter. Two types of search can be done using the following APIs - Object Based Search and Attribute Based Search.

Typedefs

Enumerations

Functions

MoId Manipulation APIs:

The MOID which is used to address a MO uniquely in COR can be manipulated by using the following APIs. The Service Id of the MoId is used to distinguish between MO and MSO objects.

Functions

COR Event APIs:

COR generates an event for every object creation/deletion/set operation. The applications can subscribe for these events and manipulate the event data by using the following APIs.

Functions

OI Related APIs:

Components require to participate in the life cycle of an MO and know when an Object is created or deleted or when its attribute changes. Applications can achieve this by adding themselves into the route-list corresponding to an MO/MSO. Whenever a life cycle management function is invoked on an MO, all the participating components are notified via the invocation of specific component functions. COR provides functions to add/remove components from route list.

Functions

Class Type Data Structures:

Typedefs

Enumerations

Defines


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen