os/security/contentmgmt/contentaccessfwfordrm/inc/cafhelperinterface.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of the License "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description: 
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
/** 
sl@0
    20
@file 
sl@0
    21
sl@0
    22
@publishedPartner
sl@0
    23
@released
sl@0
    24
*/
sl@0
    25
sl@0
    26
#ifndef __CAFHELPERINTERFACE_H__
sl@0
    27
#define __CAFHELPERINTERFACE_H__
sl@0
    28
sl@0
    29
#include <e32base.h>
sl@0
    30
#include <f32file.h>
sl@0
    31
sl@0
    32
namespace ContentAccess
sl@0
    33
	{
sl@0
    34
	
sl@0
    35
	// UID for CAF Helper Dll.
sl@0
    36
	const TUid KCAFHelperInterfaceUID = {0x20024480};
sl@0
    37
	
sl@0
    38
	_LIT(KCAFHelperLibraryName, "cafhelper.dll");
sl@0
    39
	
sl@0
    40
	/**
sl@0
    41
	 This interface defined by UID KCAFHelperInterfaceUID provides APIs to handle 
sl@0
    42
	 CAF error messages when CAF client application is not interested /unable to handle 
sl@0
    43
	 CAF errors.UI/device manufacturer will provide error handling functionality by 
sl@0
    44
	 implementing this interface class as a dll which is enforced to be named as cafhelper.dll.
sl@0
    45
sl@0
    46
	 @publishedPartner
sl@0
    47
	 @released
sl@0
    48
	 */
sl@0
    49
	 	
sl@0
    50
	class MCAFHelperInterface
sl@0
    51
		{
sl@0
    52
	public:
sl@0
    53
		
sl@0
    54
		/**  
sl@0
    55
		 This method handles the CAF error received for a given file.
sl@0
    56
		 @param aError		One of the CAF errors. 
sl@0
    57
		 @param aFileName 	File name or file URI for which the error is received
sl@0
    58
		 @return 			KErrNone if the error is handled successfully.Otherwise one of the other system-wide
sl@0
    59
							errors.
sl@0
    60
		 @capability DRM 	Access to DRM protected content is not permitted for processes without DRM capability. Access to unprotected content is unrestricted 
sl@0
    61
		*/
sl@0
    62
		virtual TInt HandleCAFErrorL(TInt aError, const TDesC& aFileName) = 0;
sl@0
    63
		
sl@0
    64
		/**  
sl@0
    65
		 This method handles the CAF error received for a given file .
sl@0
    66
		 @param aError		One of the CAF errors. 
sl@0
    67
		 @param aFileHandle File handle for which the error is received
sl@0
    68
		 @return 			KErrNone if the error is handled successfully.Otherwise one of the other system-wide
sl@0
    69
							errors.
sl@0
    70
		 @capability DRM 	Access to DRM protected content is not permitted for processes without DRM capability. Access to unprotected content is unrestricted 
sl@0
    71
		*/	
sl@0
    72
		virtual TInt HandleCAFErrorL(TInt aError, RFile& aFileHandle) = 0;
sl@0
    73
		
sl@0
    74
		/**  
sl@0
    75
		 This method handles the CAF error received for WMDRM content .
sl@0
    76
		 @param aError		One of the CAF errors. 
sl@0
    77
		 @param aHeaderData The header data of the content for which the error is received
sl@0
    78
		 @return 			KErrNone if the error is handled successfully.Otherwise one of the other system-wide
sl@0
    79
							errors.
sl@0
    80
		 @capability DRM 	Access to DRM protected content is not permitted for processes without DRM capability. Access to unprotected content is unrestricted 
sl@0
    81
		*/
sl@0
    82
		virtual TInt HandleCAFErrorL(TInt aError, const TDesC8& aHeaderData) = 0;
sl@0
    83
		
sl@0
    84
		virtual void Release() = 0;
sl@0
    85
		
sl@0
    86
		};
sl@0
    87
		
sl@0
    88
	} // namespace ContentAccess
sl@0
    89
	
sl@0
    90
#endif // __CAFHELPERINTERFACE_H__
sl@0
    91