clProvApi.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  : prov
 * File        : clProvApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *          This header file contains Provision Library related API defination.
 *
 *
 *****************************************************************************/

#ifndef _CL_PROV_API_H_
#define _CL_PROV_API_H_

#ifdef __cplusplus
extern "C"
{
#endif

#include <clCommon.h>
#include <clCorMetaData.h>
#include <clCorNotifyApi.h>

/******************************** Provision Library APIs *************************/
/*********************************************************************************/
/* clProvInitialize                                                              */
/* clProvFinalize                                                                */
/* clProvVersionCheck                                                            */
/* clProvObjectCreate                                                            */
/* clProvObjectDelete                                                            */
/*                                                                               */
/*********************************************************************************/

    typedef struct ClProvTxnData
    {

           ClCorOpsT provCmd;

        void* pMoId;
        ClCorAttrPathPtrT attrPath;
        ClCorAttrTypeT    attrType;
        ClCorTypeT attrDataType;
        ClCorAttrIdT      attrId;
        void             *pProvData;
        ClUint32T         size;
        ClUint32T         index;
     
        ClCorTxnJobIdT    jobId;

    } ClProvTxnDataT;

typedef void (*ClProvTxnStartCallbackT) (
                CL_IN ClHandleT txnHandle);

typedef void (*ClProvTxnEndCallbackT) (
                CL_IN ClHandleT txnHandle);

typedef struct
{
    /*
     * This is used to get the start callback from the user which will be called
     * before beginning a transaction.
     */
    ClProvTxnStartCallbackT fpProvTxnStart;

    /*
     * This is used to get the end callback from the user which will be called
     * after completing the transaction.
     */
    ClProvTxnEndCallbackT   fpProvTxnEnd; 
} ClProvTxnCallbacksT;

ClRcT   clProvInitialize();

ClRcT   clProvFinalize();

ClRcT   clProvVersionCheck(CL_INOUT ClVersionT* pVersion);

ClRcT clProvObjectCreate(CL_IN ClCorMOIdPtrT pMoId, CL_IN ClCorAttributeValueListPtrT attrList, CL_OUT ClCorObjectHandleT* pHandle);

ClRcT clProvObjectDelete(CL_IN ClCorObjectHandleT handle);

ClRcT clProvResourcesGet(ClCorMOIdListT** ppMoIdList);

#ifdef __cplusplus
}
#endif

#endif /* _CL_PROV_API_H_ */