drm_plat/camese_framework_api/inc/wmdrmdlahandler.h
author hgs
Fri, 28 May 2010 23:16:27 +0300
changeset 46 78de010160a8
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Interface class for WMDRM DLA functionality
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef C_WMDRMDLAHANDLER_H
hgs
parents:
diff changeset
    20
#define C_WMDRMDLAHANDLER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
#include <f32file.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
class CWmDrmDlaHandlerImpl;
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
 *  WMDRM DLA Interface
hgs
parents:
diff changeset
    29
 *
hgs
parents:
diff changeset
    30
 *  @lib wmdrmdla.lib
hgs
parents:
diff changeset
    31
 *  @since S60 v9.1
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
NONSHARABLE_CLASS( CWmDrmDlaHandler ) : public CBase
hgs
parents:
diff changeset
    34
    {
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
public:
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
    IMPORT_C static CWmDrmDlaHandler* NewL();
hgs
parents:
diff changeset
    39
    IMPORT_C static CWmDrmDlaHandler* NewLC();
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
    /**
hgs
parents:
diff changeset
    42
    * Destructor.
hgs
parents:
diff changeset
    43
    */
hgs
parents:
diff changeset
    44
    virtual ~CWmDrmDlaHandler();
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
     * Checks if license acquisition for file is silent
hgs
parents:
diff changeset
    48
     *
hgs
parents:
diff changeset
    49
     * @param   aFile wmdrm file
hgs
parents:
diff changeset
    50
     * @return  ETrue if license acquisition is silent
hgs
parents:
diff changeset
    51
     * @leave   KErrNotFound if there is no handler for the file
hgs
parents:
diff changeset
    52
     */
hgs
parents:
diff changeset
    53
    IMPORT_C TBool SilentL( const RFile& aFile );
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
     * Acquire license based on the file handle
hgs
parents:
diff changeset
    57
     *
hgs
parents:
diff changeset
    58
     * @param   aFile wmdrm file
hgs
parents:
diff changeset
    59
     * @param   aContentUrl contains content URL on return. Can be NULL.
hgs
parents:
diff changeset
    60
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    61
     * @param   aHtmlData contains HTML data returned by license server on
hgs
parents:
diff changeset
    62
     *                    return. Can be NULL.
hgs
parents:
diff changeset
    63
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    64
     * @leave   KErrNotFound if there is no handler for the file
hgs
parents:
diff changeset
    65
     */
hgs
parents:
diff changeset
    66
    IMPORT_C void AcquireLicenseL( const RFile& aFile, HBufC*& aContentUrl, 
hgs
parents:
diff changeset
    67
                                   HBufC*& aHtmlData );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Acquire license based on the file handle, asynchronous version
hgs
parents:
diff changeset
    71
     *
hgs
parents:
diff changeset
    72
     * @param   aFile wmdrm file
hgs
parents:
diff changeset
    73
     * @param   aContentUrl contains content URL on completion. Can be NULL.
hgs
parents:
diff changeset
    74
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    75
     * @param   aHtmlData contains HTML data returned by license server on 
hgs
parents:
diff changeset
    76
     *                    completion. Can be NULL.
hgs
parents:
diff changeset
    77
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    78
     * @param   aStatus Request status. On completion contains the error code.
hgs
parents:
diff changeset
    79
     */
hgs
parents:
diff changeset
    80
    IMPORT_C void AcquireLicense( const RFile& aFile, HBufC*& aContentUrl, 
hgs
parents:
diff changeset
    81
                                  HBufC*& aHtmlData, TRequestStatus& aStatus );
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
    /**
hgs
parents:
diff changeset
    84
     * Acquire license based on the DRM Header
hgs
parents:
diff changeset
    85
     *
hgs
parents:
diff changeset
    86
     * @param   aDrmHeader DRM Header
hgs
parents:
diff changeset
    87
     * @param   aErrorUrl   URL where error code is sent. Can be NULL.
hgs
parents:
diff changeset
    88
     * @param   aContentUrl contains content URL on return. Can be NULL.
hgs
parents:
diff changeset
    89
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    90
     * @param   aHtmlData contains HTML data returned by license server on 
hgs
parents:
diff changeset
    91
     *                    return. Can be NULL.
hgs
parents:
diff changeset
    92
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
    93
     * @leave   KErrNotFound if there is no handler for the file
hgs
parents:
diff changeset
    94
     */
hgs
parents:
diff changeset
    95
    IMPORT_C void AcquireLicenseFromDrmHeaderL( const TDesC8& aDrmHeader,
hgs
parents:
diff changeset
    96
                                                HBufC* aErrorUrl,
hgs
parents:
diff changeset
    97
                                                HBufC*& aContentUrl, 
hgs
parents:
diff changeset
    98
                                                HBufC*& aHtmlData );
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * Acquire license based on the DRM Header, asynchronous version
hgs
parents:
diff changeset
   102
     *
hgs
parents:
diff changeset
   103
     * @param   aDrmHeader DRM Header
hgs
parents:
diff changeset
   104
     * @param   aErrorUrl   URL where error code is sent. Can be NULL.
hgs
parents:
diff changeset
   105
     * @param   aContentUrl contains content URL on completion. Can be NULL.
hgs
parents:
diff changeset
   106
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
   107
     * @param   aHtmlData contains HTML data returned by license server on
hgs
parents:
diff changeset
   108
     *                    completion. Can be NULL.
hgs
parents:
diff changeset
   109
     * If it's not NULL, it must be freed by caller.  
hgs
parents:
diff changeset
   110
     * @param   aStatus Request status. On completion contains the error code.
hgs
parents:
diff changeset
   111
     */
hgs
parents:
diff changeset
   112
    IMPORT_C void AcquireLicenseFromDrmHeader( const TDesC8& aDrmHeader, 
hgs
parents:
diff changeset
   113
                                               HBufC* aErrorUrl,
hgs
parents:
diff changeset
   114
                                               HBufC*& aContentUrl, 
hgs
parents:
diff changeset
   115
                                               HBufC*& aHtmlData, 
hgs
parents:
diff changeset
   116
                                               TRequestStatus& aStatus );
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    /**
hgs
parents:
diff changeset
   119
     * Cancels ongoing license acquisition
hgs
parents:
diff changeset
   120
     *
hgs
parents:
diff changeset
   121
     */
hgs
parents:
diff changeset
   122
    IMPORT_C void CancelLicenseAcquisition();
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
    /**
hgs
parents:
diff changeset
   125
     * Handles metering certificate OTA
hgs
parents:
diff changeset
   126
     *
hgs
parents:
diff changeset
   127
     * @param   aCertificate metering certificate
hgs
parents:
diff changeset
   128
     */
hgs
parents:
diff changeset
   129
    IMPORT_C void ProcessMeteringCertificateL( const TDesC8& aCertificate );
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
    /**
hgs
parents:
diff changeset
   132
     * Handles metering certificate OTA, asynchronous version
hgs
parents:
diff changeset
   133
     *
hgs
parents:
diff changeset
   134
     * @param   aCertificate metering certificate
hgs
parents:
diff changeset
   135
     * @param   aStatus Request status. On completion contains the error code.
hgs
parents:
diff changeset
   136
     */
hgs
parents:
diff changeset
   137
    IMPORT_C void ProcessMeteringCertificate( const TDesC8& aCertificate, 
hgs
parents:
diff changeset
   138
                                              TRequestStatus& aStatus );
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
    /**
hgs
parents:
diff changeset
   141
     * Cancels ongoing metering
hgs
parents:
diff changeset
   142
     *
hgs
parents:
diff changeset
   143
     */
hgs
parents:
diff changeset
   144
    IMPORT_C void CancelMetering();
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
    /**
hgs
parents:
diff changeset
   147
     * Sets the IAP to be used in the HTTP transactions
hgs
parents:
diff changeset
   148
     *
hgs
parents:
diff changeset
   149
     * @param   aIapId  Internet Access Point id
hgs
parents:
diff changeset
   150
     */
hgs
parents:
diff changeset
   151
    IMPORT_C void SetIapId( TInt aIapId );
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
protected:
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
private:
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
    CWmDrmDlaHandler();
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
    void ConstructL();
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
private: // data
hgs
parents:
diff changeset
   162
hgs
parents:
diff changeset
   163
    /**
hgs
parents:
diff changeset
   164
     * Implementation class
hgs
parents:
diff changeset
   165
     * Own.
hgs
parents:
diff changeset
   166
     */
hgs
parents:
diff changeset
   167
    CWmDrmDlaHandlerImpl* iImpl;
hgs
parents:
diff changeset
   168
hgs
parents:
diff changeset
   169
    };
hgs
parents:
diff changeset
   170
hgs
parents:
diff changeset
   171
#endif // C_WMDRMDLAHANDLER_H