DxDrmManager.h

/*
 Copyright
 This code is strictly confidential and the receiver is obliged to use it
 exclusively for his or her own purposes. No part of Viaccess Orca code may
 be reproduced or transmitted in any form or by any means, electronic or
 mechanical, including photocopying, recording, or by any information storage
 and retrieval system, without permission in writing from Viaccess Orca.
 The information in this code is subject to change without notice. Viaccess
 Orca does not warrant that this code is error free. If you find any problems
 with this code or wish to make comments, please report them to Viaccess
 Orca.
 
 Trademarks
 Viaccess Orca is a registered trademark of Viaccess S.A in France and/or
 other countries. All other product and company names mentioned herein are the
 trademarks of their respective owners.
 Viaccess S.A may hold patents, patent applications, trademarks, copyrights
 or other intellectual property rights over the code hereafter. Unless
 expressly specified otherwise in a Viaccess Orca written license agreement,
 the delivery of this code does not imply the concession of any license over
 these patents, trademarks, copyrights or other intellectual property.
 */

#import <Foundation/Foundation.h>
#import "DxDrmManagerDefines.h"

#import "IDxChallenge.h"

#define SOAP_ERROR_CUSTOM_DATA   @"soapErrorCustomData"
#define SOAP_ERROR_REDIRECT_URL  @"soapErrorRedirectUrl"
#define SOAP_ERROR_BODY      @"soapErrorBody"

//TODO: only for current doxygen format
@interface DxDrmManager : NSObject {
}

@property bool bDeletePersonalizationUponStartup;
@property bool bDeletePlayReadyStoreUponStartup;


+ (DxDrmManager *)sharedManager;

+ (DxDrmManager *)sharedManager:(NSError**)drmError;

+ (BOOL)DEBUG_setLoggingLevel:(NSString *)loggingLevel 
                withLogFile:(NSString *)logFile 
                useStdOutLogs:(BOOL)stdoutLogs 
                withDisabledModules:(NSString *)disabledModules;

- (DxDrmManagerStatus)executeInitiatorWithFile:(NSString *)filename;

- (DxDrmManagerStatus)executeInitiatorWithFile:(NSString *)filename error:(NSError**)drmError;

- (DxDrmManagerStatus)executeInitiatorWithData:(NSData *)data;

- (DxDrmManagerStatus)executeInitiatorWithData:(NSData *)data error:(NSError**)drmError;

- (DxDrmManagerStatus)executeInitiatorWithURL:(NSURL *)url;

- (DxDrmManagerStatus)executeInitiatorWithURL:(NSURL *)url error:(NSError**)drmError;

- (DxDrmManagerStatus)verifyRightsForFile:(NSString *)filename;

- (DxDrmManagerStatus)personalizationVerify;

- (DxDrmManagerStatus)performPersonalizationWithSessionID:(NSString *)sessionID withServerURL:(NSString *)serverURL withAppVersion:(NSString *)appVersionOrNil;
- (DxDrmManagerStatus)performPersonalizationWithServerURL:(NSString *)serverURL withAppVersion:(NSString*) appVersion withPublicData:(NSString *)publicData  withPrivateData:(NSString *)privateData;
- (DxDrmManagerStatus)deleteRightsForFile:(NSString *)filename;

- (DxDrmManagerStatus)acquireRightsForFile:(NSString *)filename withCustomData:(NSString *)dataOrNil withRightsUrl:(NSString *)urlOrNil;

- (DxDrmManagerStatus)acquireRightsForFile:(NSString *)filename withCustomData:(NSString *)dataOrNil withRightsUrl:(NSString *)urlOrNil error:(NSError**)drmError;

- (NSArray *)getRightObjectsForFile:(NSString *)filename result:(DxDrmManagerStatus*)checkResultOrNil;

- (BOOL)isDrmContent:(NSString *)contentFilename result:(DxDrmManagerStatus*)checkResultOrNil;

- (BOOL) verifySecClockSet;

- (DxDrmManagerStatus) performSecClockSet;

- (DxDrmManagerStatus) setCookies: (NSArray *) cookies;

- (void) setConfigurationParams:(DxConfigurationParams)configParam withValue:(int)value;
- (DxDrmManagerStatus) setConfigurationString:(DxConfigurationParams)configParam withValue:(NSString*)value;

- (NSString *)getDrmVersion;

- (NSString *)getDeviceId;

-(IDxChallenge *) generatePersonalizationChallengeWithSessionID:(NSString *)sessionID withAppVersion:(NSString *)appVersionOrNil result:(DxDrmManagerStatus*)checkResultOrNil;


-(IDxChallenge *) generatePersonalizationChallengeWithAppVersion:(NSString*)appVersion withPublicData:(NSString *)publicData withPrivateData:(NSString *)privateData result:(DxDrmManagerStatus*)checkResult;
-(IDxChallenge *) generateChallengeFromInitiator:(NSString*) initiatorPath result:(DxDrmManagerStatus*)checkResultOrNil;

-(IDxChallenge *) generateLicenseChallengeFromContent:(NSString*) contentPath withCustomData:(NSString*)customData result:(DxDrmManagerStatus*)checkResultOrNil;

-(IDxChallenge *) generateLicenseChallengeFromDrmHeader:(NSString*) drmHeader result:(DxDrmManagerStatus*)checkResultOrNil;

-(IDxChallenge *) generateSecClockChallengeResult:(DxDrmManagerStatus*)checkResultOrNil;



- (DxDrmManagerStatus)DEBUG_deletePersonalization;

- (DxDrmManagerStatus)DEBUG_deletePlayReadyStore;


- (void)DEBUG_setLocalPersonalization:(BOOL)enable;


@end