WsbLicenseStore.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - License Store API
|
|   $Id: WsbLicenseStore.h 10793 2014-06-25 12:46:08Z jebaseelir $
|   Original author: John Hwa
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2009-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _WSB_LICENSE_STORE_H_
#define _WSB_LICENSE_STORE_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "ShiData.h"
#include "WsbTypes.h"

/*----------------------------------------------------------------------
|   result codes
+---------------------------------------------------------------------*/
#define WSB_ERROR_LS_PARSE_LICENSE     (WSB_ERROR_BASE_LICENSE_STORE - 0)
#define WSB_ERROR_LS_CREATE_DIR        (WSB_ERROR_BASE_LICENSE_STORE - 1)
#define WSB_ERROR_LS_OPEN_DB           (WSB_ERROR_BASE_LICENSE_STORE - 2)
#define WSB_ERROR_LS_CREATE_TABLES     (WSB_ERROR_BASE_LICENSE_STORE - 3)
#define WSB_ERROR_LS_ADD_LICENSE       (WSB_ERROR_BASE_LICENSE_STORE - 4)
#define WSB_ERROR_LS_DUPLICATE_LICENSE (WSB_ERROR_BASE_LICENSE_STORE - 5)
#define WSB_ERROR_LS_REMOVE_LICENSE    (WSB_ERROR_BASE_LICENSE_STORE - 6)
#define WSB_ERROR_LS_FAIL_LOOKUP       (WSB_ERROR_BASE_LICENSE_STORE - 7)
#define WSB_ERROR_LS_NO_LICENSE        (WSB_ERROR_BASE_LICENSE_STORE - 8)
#define WSB_ERROR_LS_OWNING_THREAD     (WSB_ERROR_BASE_LICENSE_STORE - 9)
#define WSB_ERROR_LS_NO_CID            (WSB_ERROR_BASE_LICENSE_STORE - 10)
#define WSB_ERROR_LS_CLOSE_DB          (WSB_ERROR_BASE_LICENSE_STORE - 11)
#define WSB_ERROR_LS_VACUUM            (WSB_ERROR_BASE_LICENSE_STORE - 12)

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define WSB_TYPE_ID_LICENSE            1000

#define WSB_LS_FLAG_LICENSE_DATA        0x01

#define WSB_LS_FLAG_LICENSE_EXPIRE_DATE 0x02

#define WSB_LS_FLAG_LICENSE_INSERT_DATE 0x04

#define WSB_LS_FLAG_LICENSE_TAG         0x08

/*----------------------------------------------------------------------
|   interfaces
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

typedef struct WSB_License WSB_License;

WSB_EXPORT WSB_UInt32
WSB_License_GetId(const WSB_License* license);

WSB_EXPORT WSB_ByteArray
WSB_License_GetData(const WSB_License* license);

WSB_EXPORT WSB_Int32
WSB_License_GetExpirationDate(const WSB_License* license);

WSB_EXPORT WSB_Int32
WSB_License_GetPriority(const WSB_License* license);

WSB_EXPORT WSB_Int32
WSB_License_GetInsertionDate(const WSB_License* license);

WSB_EXPORT const char*
WSB_License_GetTag(const WSB_License* license);

typedef struct WSB_LicenseStore WSB_LicenseStore;

WSB_EXPORT WSB_Result
WSB_LicenseStore_Open(WSB_LicenseStore** store);

WSB_EXPORT WSB_Result
WSB_LicenseStore_AddLicense(WSB_LicenseStore* store,
                            const void*       data,
                            WSB_Size          data_size,
                            const char*       tag,
                            WSB_UInt32*       lid);

WSB_EXPORT WSB_Result
WSB_LicenseStore_FindLicensesByContentIds(WSB_LicenseStore* store,
                                          const char**      cids,
                                          WSB_Cardinal      id_count,
                                          SHI_Data**        licenses);

WSB_EXPORT WSB_Result
WSB_LicenseStore_FindContentIdsByLicense(WSB_LicenseStore* store,
                                         WSB_UInt32        lid,
                                         SHI_Data**        cids);

WSB_EXPORT WSB_Result
WSB_LicenseStore_GetLicenseById(WSB_LicenseStore* store,
                                WSB_UInt32        lid,
                                SHI_Data**        license);

WSB_EXPORT WSB_Result
WSB_LicenseStore_EnumerateLicenses(WSB_LicenseStore* store,
                                   WSB_Flags         flags,
                                   SHI_Data**        licenses);

WSB_EXPORT WSB_Result
WSB_LicenseStore_EnumerateContentIds(WSB_LicenseStore* store,
                                     SHI_Data**        cids);

WSB_EXPORT WSB_Result
WSB_LicenseStore_ExpungeExpiredLicenses(WSB_LicenseStore* store);

WSB_EXPORT WSB_Result
WSB_LicenseStore_RemoveLicense(WSB_LicenseStore* store,
                               WSB_UInt32        lid);

WSB_EXPORT WSB_Result
WSB_LicenseStore_Close(WSB_LicenseStore* store);

#if defined(__cplusplus)
}
#endif

#endif /* _WSB_LICENSE_STORE_H_ */