wmdrm/camese/wmdrmdladefaulthttpplugin/inc/wmdrmdladefaulthttpplugin.h
changeset 0 95b198f216e5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/wmdrm/camese/wmdrmdladefaulthttpplugin/inc/wmdrmdladefaulthttpplugin.h	Thu Dec 17 08:52:27 2009 +0200
@@ -0,0 +1,314 @@
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  WMDRM DLA Default HTTP Plugin
+*
+*/
+
+
+#ifndef C_WMDRMDLADEFAULTHTTPPLUGIN_H
+#define C_WMDRMDLADEFAULTHTTPPLUGIN_H
+
+#include <wmdrmdlahttpplugin.h>
+
+class CWmDrmDlaDefaultLicAcq;
+class CWmDrmDlaDefaultMetering;
+class CWmDrmDlaDefaultPlayReady;
+class CWmDrmDlaUiNotifier;
+class CGulIcon;
+
+/**
+ * WMDRM DLA Default HTTP Plugin
+ * Reference implementation that only supports MS test server
+ *
+ * @lib wmdrmdladefaulthttpplugin.lib
+ * @since S60 v9.1
+ */
+NONSHARABLE_CLASS( CWmDrmDlaDefaultHttpPlugin ) : public CWmDrmDlaHttpPluginIf
+    {
+
+public:
+
+    static CWmDrmDlaDefaultHttpPlugin* NewL();
+    ~CWmDrmDlaDefaultHttpPlugin();
+
+public: //From CWmDrmDlaHttpPluginIf
+
+    /**
+     * Get service icon to be used in service selection query, if
+     * more than one service is recognized to support content.
+     * Will be deleted by the caller.
+     *
+     * @return Service icon or NULL
+     */
+    CGulIcon* ServiceIcon();
+    
+    /**
+     * Check if file is supported by this plugin
+     *
+     * @param aFile WMDRM file
+     * @param aUiNotifer If file is supported, contains initialized UI Notifier
+     *                   upon completion. Will be deleted by the caller after 
+     *                   the plugin has been deleted.
+     * @return ETrue if file is supported by this plugin
+     * @leave with standard Symbian error code in case of error
+     */
+     TBool SupportedFileL( const RFile& aFile, 
+                           CWmDrmDlaUiNotifier*& aUiNotifier );
+
+    /**
+     * Check if DRM Header is supported by this plugin
+     *
+     * @param aHeader DRM Header
+     * @param aUiNotifer If header is supported, contains initialized UI 
+     *                   Notifier upon completion. Will be deleted by the
+     *                   caller after the plugin has been deleted.
+     * @return ETrue if header is supported by this plugin
+     * @leave with standard Symbian error code in case of error
+     */
+    TBool SupportedDrmHeaderL( const TDesC8& aHeader, 
+                               CWmDrmDlaUiNotifier*& aUiNotifier );
+
+    /**
+     * Check if metering certificate is supported by this plugin
+     *
+     * @param aCertificate Metering certificate
+     * @param aUiNotifer If certificate is supported, contains initialized UI
+     *                   Notifier upon completion. Will be deleted by the
+     *                   caller after the plugin has been deleted.
+     * @return ETrue if certificate is supported by this plugin
+     * @leave with standard Symbian error code in case of error
+     */
+    TBool SupportedMeteringCertificateL( const TDesC8& aCertificate, 
+                                         CWmDrmDlaUiNotifier*& aUiNotifier );
+
+    /**
+     * Check if initiator is supported by this plugin
+     * This method is called only for playready content
+     * 
+     * @param aInitiator Initiator
+     * @param aUiNotifer If initiator is supported, contains initialized UI
+     *                   Notifier upon completion. Will be deleted by the
+     *                   caller after the plugin has been deleted.
+     * @return ETrue if initiator is supported by this plugin
+     * @leave with standard Symbian error code in case of error
+     */
+    TBool SupportedInitiatorL( const TDesC8& aInitiator, 
+                               CWmDrmDlaUiNotifier*& aUiNotifier );
+
+    /**
+     * Check if license acquisition should be silent for this file
+     *
+     * @param aFile WMDRM file
+     * @return ETrue if file is supported by this plugin
+     * @leave with standard Symbian error code in case of error
+     */
+    TBool SilentL( const RFile& aFile );
+
+    /**
+     * Process DRM Header. This method is used only to pass DRM Header to the
+     * plugin. The framework does not require the plugin to do anything 
+     *
+     * @param aDrmHeader DRM Header
+     * @leave with standard Symbian error code in case of fatal error (the 
+     * framework does not proceed with license acquisition if this method
+     * leaves)
+     */
+    void ProcessDrmHeaderL( const TDesC8& aDrmHeader );
+
+    /**
+     * Process the initiator. This method is used only to pass initiator to the
+     * plugin. The framework does not require the plugin to do anything. 
+     * This method is called only for playready content
+     *
+     * @param aInitiator Initiator
+     * @leave with standard Symbian error code in case of fatal error (the 
+     * framework does not proceed with license acquisition if this method
+     * leaves)
+     */
+    void ProcessInitiatorL( const TDesC8& aInitiator );
+    
+    /**
+    * Acquire License. 
+    *
+    * @param aLicenseChallenge License challenge based on which license will
+    *                          be acquired.
+    * @param aLicenseServerUrl URL where license challenge is sent
+    * @param aStatus Request status, will contain error code upon completion 
+    * including but not limited to:
+    * - KErrCancel if user cancelled the license acquisition at any point
+    * - KErrCommsBreak if network connection was lost during communication with
+    *                  server
+    * - KErrGeneral if unspecified error happened
+    */
+    void AcquireLicense( const TDesC8& aLicenseChallenge, 
+                         HBufC* aLicenseServerUrl,
+                         TRequestStatus& aStatus );
+
+    /**
+     * Get downloaded License. 
+     *
+     * @leave standard Symbian error code in case of error.
+     * @return Buffer containing license data. Will be deleted by the caller.
+     */
+    HBufC8* GetLicenseResponseL();
+
+    /**
+     * Send license storage status. 
+     *
+     * @param aTid Transaction ID parsed from the license response, can be NULL
+     * @param aUrl URL where license storage status is sent
+     * @param aError License storage status.
+     * @param aStatus Request status, will contain error code upon completion
+     * including but not limited to:
+     * - KErrCommsBreak if network connection was lost during communication
+     *                  with server
+     * - KErrGeneral if unspecified error happened
+     */
+    void SendLicenseStorageStatus( HBufC8* aTid, const TDesC& aUrl,
+                                   TInt aError, TRequestStatus& aStatus );
+
+    /**
+     * Send error code to server if drm header parsing failed.
+     *
+     * @param   aErrorUrl   URL where error code is sent
+     * @param   aError      Error code
+     * @param aStatus Request status, will contain error code upon completion
+     * including but not limited to:
+     * - KErrCommsBreak if network connection was lost during communication
+     *                  with server
+     * - KErrGeneral if unspecified error happened
+     */
+    void SendDrmHeaderError( const TDesC& aErrorUrl, TInt aError, 
+                             TRequestStatus& aStatus );
+    
+    /**
+     * Get content url. Called only if framework fails to parse content URL 
+     * from the license response. Needs to be implemented only if the supported
+     * service uses non-standard way to pass the Content URL, otherwise this can
+     * return NULL.
+     *
+     * @return Content URL, can be NULL. Will be deleted by the caller.
+     */
+    HBufC* GetContentUrlL();
+
+    /**
+     * Get HTML data returned by license server. 
+     *
+     * @return HTML data, can be NULL. Will be deleted by the caller.
+     */
+    HBufC* GetHtmlDataL();
+
+    /*
+     * Cancel license acquisition
+     */
+    void CancelLicenseAcquisition();
+    
+    /**
+     * Process metering challenge. 
+     *
+     * @param aMeteringChallenge Metering challenge
+     * @param aUrl Url to be used in metering request
+     * @param aStatus Request status, will contain error code upon completion
+     * including but not limited to:
+     * - KErrCommsBreak if network connection was lost during communication
+     *                  with server
+     * - KErrGeneral if unspecified error happened
+     */
+    void ProcessMeteringChallenge( const TDesC8& aMeteringChallenge, 
+                                   const TDesC& aUrl, 
+                                   TRequestStatus& aStatus );
+
+    /**
+     * Get metering response. 
+     *
+     * @param aResponse Contains metering response upon completion. Will be
+     *                  deleted by the caller.
+     * @param aStatus Request status, will contain error code upon completion
+     */
+    void GetMeteringResponse( HBufC8*& aResponse, TRequestStatus& aStatus );
+
+    /**
+     * Inform plugin that metering finished. 
+     *
+     */
+    void MeteringFinished();
+
+    /*
+     * Cancel metering
+     */
+    void CancelMetering();
+    
+    /*
+     * Process join domain challenge.
+     * This method is called only for playready content
+     *
+     * @param aJoinDomainChallenge Join domain challenge
+     * @param aUrl Url to be used in join domain request
+     * @param aStatus Request status, will contain error code upon completion
+     * including but not limited to:
+     * - KErrCommsBreak if network connection was lost during communication
+     *                  with server
+     * - KErrGeneral if unspecified error happened
+     */
+    void ProcessJoinDomainChallenge( 
+        const TDesC8& aJoinDomainChallenge, 
+        const TDesC& aUrl, 
+        TRequestStatus& aStatus );
+
+    /*
+     * Process leave domain challenge.
+     * This method is called only for playready content
+     *
+     * @param aLeaveDomainChallenge Leave domain challenge
+     * @param aUrl Url to be used in leave domain request
+     * @param aStatus Request status, will contain error code upon completion
+     * including but not limited to:
+     * - KErrCommsBreak if network connection was lost during communication
+     *                  with server
+     * - KErrGeneral if unspecified error happened
+     */
+    void ProcessLeaveDomainChallenge( 
+        const TDesC8& aLeaveDomainChallenge, 
+        const TDesC& aUrl, 
+        TRequestStatus& aStatus );
+
+    /**
+     * Sets the IAP to be used in the HTTP transactions
+     *
+     * @param   aIapId  Internet Access Point id
+     */
+    void SetIapId( TInt aIapId );
+
+    void InitializeUiNotifierL();
+    CWmDrmDlaUiNotifier* UiNotifier();
+    
+    TBool Supported( const TDesC8& aString, const TDesC8& aIdentifier );
+    
+private:
+
+    CWmDrmDlaDefaultHttpPlugin();
+    void ConstructL();
+
+private: // data
+    
+    CWmDrmDlaDefaultLicAcq* iLicenseAcquisition;
+    CWmDrmDlaDefaultMetering* iMetering;
+    CWmDrmDlaDefaultPlayReady* iPlayReady;
+    
+    //Not owned
+    CWmDrmDlaUiNotifier* iUiNotifier;
+
+    };
+
+#endif // C_WMDRMDLADEFAULTHTTPPLUGIN_H