clCorUtilityApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : cor
 * File        : clCorUtilityApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 *  The file contains utility APIs to modify paths/ids required by core COR
 *  APIs. for e.g APIs to generate ClCorMOId (a unique idenfier for MO)
 *
 *
 *****************************************************************************/

/*********************************************************************************/
/********************************* COR IPIs **************************************/
/*********************************************************************************/
/*                                                                              */
/* clCorProcessClassTable                                                       */
/* clCorOmClassFromInfoModelGet                                                 */
/* clCorDataRestore                                                             */
/* clCorDataSave                                                                */
/* clCorDataFrequentSave                                                        */
/* clCorDataFrequentSaveStop                                                    */
/* clCorClassAttributeWalk                                                      */
/* clCorClassAttributeTypeGet                                                   */
/* clCorClassAttributeValuesGet                                                 */
/* clCorMoClassPathInitialize                                                   */
/* clCorMoClassPathAlloc                                                        */
/* clCorMoClassPathFree                                                         */
/* clCorMoClassPathTruncate                                                     */
/* clCorMoClassPathSet                                                          */
/* clCorMoClassPathAppend                                                       */
/* clCorMoClassPathDepthGet                                                     */
/* clCorMoClassPathToMoClassGet                                                 */
/* clCorMoClassPathFirstChildGet                                                */
/* clCorMoClassPathNextSiblingGet                                               */
/* clCorMoClassPathCompare                                                      */
/* clCorMoClassPathConcatenate                                                  */
/*********************************************************************************/
/********************************* COR APIs **************************************/
/*********************************************************************************/
/* clCorMoIdInitialize                                                           */
/* clCorMoIdAlloc                                                                */
/* clCorMoIdFree                                                                 */
/* clCorMoIdTruncate                                                             */
/* clCorMoIdSet                                                                  */
/* clCorMoIdAppend                                                                */
/* clCorMoIdDepthGet                                                             */
/* clCorMoIdShow                                                                 */
/* clCorMoIdToMoClassGet                                                         */
/* clCorMoIdNameToMoIdGet                                                        */
/* clCorMoIdToMoIdNameGet                                                        */
/* clCorMoIdFirstInstanceGet                                                     */
/* clCorMoIdNextSiblingGet                                                       */
/* clCorMoIdValidate                                                             */
/* clCorMoIdToInstanceGet                                                        */
/* clCorMoIdToMoClassPathGet                                                     */
/* clCorMoIdClone                                                                */
/* clCorMoIdCompare                                                              */
/* clCorMoIdServiceGet                                                           */
/* clCorMoIdServiceSet                                                           */
/* clCorServiceIdValidate                                                        */
/* clCorMoIdInstanceSet                                                          */
/* clCorMoIdConcatenate                                                          */
/* clCorAttrPathAlloc                                                            */
/* clCorAttrPathInitialize                                                       */
/* clCorAttrPathFree                                                             */
/* clCorAttrPathTruncate                                                         */
/* clCorAttrPathSet                                                              */
/* clCorAttrPathAppend                                                           */
/* clCorAttrPathShow                                                             */
/* clCorAttrPathDepthGet                                                         */
/* clCorAttrPathToAttrIdGet                                                      */
/* clCorAttrPathIndexGet                                                         */
/* clCorAttrPathIndexSet                                                         */
/* clCorAttrPathCompare                                                          */
/* clCorAttrPathClone                                                            */
/* clCorUtilMoAndMSOCreate                                                       */
/* clCorUtilMoAndMSODelete                                                       */
/*                                                                               */
/*********************************************************************************/

#ifndef _CL_COR_UTILITY_API_H_
#define _CL_COR_UTILITY_API_H_

#ifdef __cplusplus
    extern "C" {
#endif

#include <clCommon.h>
#include <clOmCommonClassTypes.h>
#include "clCorMetaData.h"
#include "clCorServiceId.h"


/******************************************************************************
 *  Constant and Macro Definitions
 *****************************************************************************/


#define CL_COR_UTILS_UNKNOWN_ATTRIBUTE 0

#define CL_COR_UTILS_UNKNOWN_CLASS  0
    
typedef enum 
{

   CL_COR_PERS_CLASS_DATA = 1,      

   CL_COR_PERS_HIER_DATA,           

   CL_COR_PERS_OBJ_DATA,            

   CL_COR_PERS_RM_DATA,

   CL_COR_PERS_NI_DATA,

   CL_COR_PERS_DATA_MAX   

} ClCorPersDataTypeT;
    
typedef enum ClCorClsCfgType {

    CL_COR_BASE_CLASS,
    CL_COR_MO_CLASS

} ClCorClsCfgTypeT;


struct ClCorPersDataTlv
{

  ClCorPersDataTypeT     type;     

  ClInt32T             len;      

};

typedef struct ClCorPersDataTlv  ClCorPersDataTlvT;



/*****************************************************************************
 *  COR APIs
 *****************************************************************************/




extern ClRcT clCorOmClassFromInfoModelGet(ClCorClassTypeT moClass, ClCorServiceIdT svcId, ClOmClassTypeT *pOmClass);
extern ClRcT clCorOmClassNameFromInfoModelGet(ClCorClassTypeT moClass, ClCorServiceIdT svcId, ClOmClassTypeT *pOmClass,
                                              ClCharT *pOmClassName, ClUint32T maxClassSize);
extern ClRcT clCorConfigLoad(const ClCharT *pConfigFile, const ClCharT *pRouteFile);

extern ClRcT clCorDataRestore();

extern ClRcT clCorDataSave();



extern ClRcT clCorDataFrequentSave(char  *fileName, ClTimerTimeOutT  frequency );



extern ClRcT clCorDataFrequentSaveStop();


/* ------------- Attribute related utility IPIs ------------------ */


extern ClRcT  clCorClassAttributeWalk(ClCorClassTypeT classId,  ClCorClassAttrWalkFunc usrClBck, ClPtrT cookie);




extern ClRcT  clCorClassAttributeTypeGet(ClCorClassTypeT clsHdl, ClCorAttrIdT attrId,  ClCorAttrTypeT* atye);




extern ClRcT  clCorClassAttributeValuesGet(ClCorClassTypeT clsHdl, ClCorAttrIdT attrId,
                             ClInt32T *pInit, ClInt32T *pMin, ClInt32T *pMax);




/* ------------- ClCorMOClassPath and ClCorMOId Utilities -------------------- */


extern ClRcT clCorMoClassPathInitialize(ClCorMOClassPathPtrT pPath);




extern ClRcT clCorMoClassPathAlloc(ClCorMOClassPathPtrT *pPath);




extern ClRcT clCorMoClassPathFree(ClCorMOClassPathPtrT pPath);




extern ClRcT clCorMoClassPathTruncate(ClCorMOClassPathPtrT pPath, ClInt16T level);




extern ClRcT clCorMoClassPathSet(ClCorMOClassPathPtrT pPath, ClUint16T level, ClCorClassTypeT type);




extern ClRcT clCorMoClassPathAppend(ClCorMOClassPathPtrT pPath, ClCorClassTypeT type);



extern ClInt32T clCorMoClassPathDepthGet(ClCorMOClassPathPtrT pPath);



extern ClCorClassTypeT clCorMoClassPathToMoClassGet(ClCorMOClassPathPtrT pPath);




extern ClRcT clCorMoClassPathFirstChildGet(ClCorMOClassPathPtrT pPath);




extern ClRcT clCorMoClassPathNextSiblingGet(ClCorMOClassPathPtrT pPath);  




extern ClRcT clCorMoClassPathCompare(ClCorMOClassPathPtrT hMoPath1, ClCorMOClassPathPtrT hMoPath2);



extern ClRcT clCorMoClassPathConcatenate(ClCorMOClassPathPtrT part1, ClCorMOClassPathPtrT part2, int copyWhere);

extern ClRcT clCorMoIdInitialize(CL_INOUT ClCorMOIdPtrT pMoId);

extern ClRcT clCorMoIdAlloc(CL_INOUT ClCorMOIdPtrT *pMoId);

extern ClRcT clCorMoIdFree(CL_INOUT ClCorMOIdPtrT pMoId);

extern ClRcT clCorMoIdTruncate(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClInt16T level);


extern ClRcT clCorMoIdSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T level, 
                                    CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance);


extern ClRcT clCorMoIdAppend(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorClassTypeT type, CL_IN ClCorInstanceIdT instance);


extern ClInt16T clCorMoIdDepthGet(CL_IN ClCorMOIdPtrT pMoId);

extern void clCorMoIdShow(CL_IN ClCorMOIdPtrT pMoId);


extern ClRcT clCorMoIdToClassGet(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMoIdClassGetFlagsT flag,
                                                           CL_OUT ClCorClassTypeT *pClassId);
extern ClRcT clCorMoIdNameToMoIdGet(CL_IN ClNameT *moIdName, CL_OUT ClCorMOIdT *moId);

extern ClRcT clCorMoIdToMoIdNameGet(CL_IN ClCorMOIdT *moId, CL_OUT ClNameT *moIdName);

extern ClRcT clCorMoIdFirstInstanceGet(CL_INOUT ClCorMOIdPtrT pMoId);  


extern ClRcT clCorMoIdNextSiblingGet(CL_INOUT ClCorMOIdPtrT pMoId);  
 

extern ClRcT clCorMoIdValidate(CL_IN ClCorMOIdPtrT pMoId);


extern ClCorInstanceIdT clCorMoIdToInstanceGet(CL_IN ClCorMOIdPtrT pMoId);


extern ClRcT clCorMoIdToMoClassPathGet(CL_IN ClCorMOIdPtrT moIdh, CL_OUT ClCorMOClassPathPtrT corIdh);


extern ClRcT clCorMoIdClone(ClCorMOIdPtrT pMoId, ClCorMOIdPtrT* newH);


ClBoolT
clCorMoIdIsWildCard(ClCorMOIdPtrT pMoId);

extern int clCorMoIdCompare(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMOIdPtrT cmp);
extern int clCorMoIdSortCompare(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorMOIdPtrT cmp);

extern ClCorMOServiceIdT clCorMoIdServiceGet(CL_IN ClCorMOIdPtrT pMoId);


extern ClRcT clCorMoIdServiceSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClCorMOServiceIdT svc);


extern ClRcT clCorServiceIdValidate(CL_IN ClCorServiceIdT srvcId);


extern ClRcT clCorMoIdInstanceSet(CL_INOUT ClCorMOIdPtrT pMoId, CL_IN ClUint16T ndepth,
                           CL_IN ClCorInstanceIdT newInstance);


extern ClRcT clCorMoIdConcatenate(CL_INOUT ClCorMOIdPtrT part1, CL_INOUT ClCorMOIdPtrT part2, CL_IN ClInt32T copyWhere);
extern ClRcT clCorMoIdPack(ClCorMOIdT *pMoId, ClCharT **ppDataBuffer, ClUint32T *pDataSize);
extern ClRcT clCorMoIdUnpack(ClCharT *pData, ClUint32T dataSize, ClCorMOIdT *pMoId);

/*  -- APIs to manipulate the Containment Attribute Path --*/

extern ClRcT clCorAttrPathAlloc(CL_INOUT ClCorAttrPathPtrT *pAttrPath);


extern ClRcT clCorAttrPathInitialize(CL_INOUT ClCorAttrPathPtrT pAttrPath);


extern ClRcT clCorAttrPathFree(CL_INOUT ClCorAttrPathPtrT  pAttrPath);


extern ClRcT clCorAttrPathTruncate(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClInt16T level);


extern ClRcT clCorAttrPathSet(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T level, 
                                CL_IN ClCorAttrIdT attrId, CL_IN ClUint32T  index);


extern ClRcT clCorAttrPathAppend(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClCorClassTypeT attrId, 
                                    CL_IN ClCorInstanceIdT index);



extern ClInt16T clCorAttrPathDepthGet(CL_IN ClCorAttrPathPtrT pAttrPath);


extern void clCorAttrPathShow(CL_IN ClCorAttrPathPtrT  pAttrPath);


extern ClCorAttrIdT clCorAttrPathToAttrIdGet(CL_IN ClCorAttrPathPtrT pAttrPath);


extern ClUint32T clCorAttrPathIndexGet(CL_IN ClCorAttrPathPtrT pAttrPath);


extern ClRcT clCorAttrPathIndexSet(CL_INOUT ClCorAttrPathPtrT pAttrPath, CL_IN ClUint16T ndepth, CL_IN ClUint32T newIndex);


extern ClInt32T clCorAttrPathCompare(CL_IN ClCorAttrPathPtrT pAttrPath, CL_IN ClCorAttrPathPtrT cmp);


extern ClRcT clCorAttrPathClone(ClCorAttrPathPtrT pAttrPath, ClCorAttrPathPtrT *newH);

extern ClRcT clCorUtilMoAndMSOCreate(CL_IN ClCorMOIdPtrT pMoId, CL_OUT ClCorObjectHandleT *pHandle);

extern ClRcT clCorUtilMoAndMSODelete(CL_IN ClCorMOIdPtrT pMoId);


extern ClRcT clCorClientDebugCliRegister(ClHandleT *pDbgHandle);

extern ClRcT clCorClientDebugCliDeregister(ClHandleT dbgHandle);

extern ClRcT clCorClassAttrListGet(ClCharT* className,
                                ClCorAttrFlagT attrFlags,
                                ClUint32T* pAttrCount,
                                ClCorAttrDefT** pAttrDefList);


/*
 * MIB Table related APIs.
 */
extern ClRcT clCorMibTableAttrListGet(ClCharT* mibTable,
                                ClCorAttrFlagT attrFlags,
                                ClUint32T* pAttrCount,
                                ClCorAttrDefT** pAttrDefList);

#ifdef __cplusplus
}
#endif

#endif  /* _CL_COR_UTILITY_API_H_ */