os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/licensees.dox
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // \n
    15 // The Content Access Framework has several configurable aspects that can
    16 // be altered at build time.
    17 // <hr>
    18 // The F32 Agent by default has no user interface. Its interface is implemented
    19 // by a separate <code>F32AGENTUI.DLL</code>. This DLL can be replace with a DLL that actually
    20 // does display information on the screen.
    21 // <hr>
    22 // The content types that CAF is allowed to map to <code>x-caf-contentMimeType</code> are given
    23 // in the <code>RECCAF.DLL</code> configuration file. This file is located in the apparc server's
    24 // private directory as  <code>\\private\\10003a3f\\RecCaf\\RecCafMimeTypes.txt</code>.
    25 // Licensees should check to be sure all required MIME types are included in the file.
    26 // <hr>
    27 // The Content Access Framework's default resolution behaviour on target devices 
    28 // results in Content Access Agents (CAAs) only being loaded from the ROM drive. 
    29 // This behaviour increases the security and reliability of the Content Access 
    30 // Framework and is in addition to the Platform Security capabilities system.  
    31 // If a licensee wishes to produce a more open device relying only on capabilities 
    32 // to allow post production agents to be installed this default resolution 
    33 // behaviour can be overidden. When it is overidden CAF will load all CAAs visible 
    34 // to the ECOM service regardless of the drive that contains them. To do this the 
    35 // macro <code>CAF_LOAD_POST_PRODUCTION_AGENTS</code> will need to be defined at 
    36 // ROM build. In the emulator platform the default resolution behaviour is as if 
    37 // this macro is always defined.
    38 // The definition of this macro will patch a data variable in the 
    39 // <code>caf.dll</code> at ROM build-time. See 
    40 // <code>\\epoc32\\include\\caf\\patchdata.h</code> and 
    41 // <code>\\epoc32\\rom\\include\\caf.iby</code>.
    42 // <hr>
    43 // It is possible for device integrators to choose whether to support both protected and unprotected content or just unprotected content with the definition of the SYMBIAN_EXCLUDE_DRM_AGENT_PLUGINS macro at the ROM build stage.
    44 // Licensee UI platforms that wish to support this feature will need to honour this macro in the obey files of the Content Access Agents that are integrate into their platform. For example:
    45 // oma_caa.iby file:
    46 // <code>
    47 //
    48 
    49 // ##ifndef __OMA_CAA_IBY__ 
    50 // ##define __OMA_CAA_IBY__
    51 // ##ifndef SYMBIAN_EXCLUDE_DRM_AGENT_PLUGINS
    52 // ECOM_PLUGIN(omacaa_plugin.dll,10111213.rsc)
    53 // file=ABI_DIR\\BUILD_DIR\\omacaa_server.exe	omacaa_server.exe
    54 // data=DATAZ_\\private\\10111210\\settings.ini   \\private\\10111210\\settings.ini
    55 // ##endif
    56 // ##endif
    57 // </code>
    58 // This optionality was introduced in Symbian OS v9.3 to allow easy customisation of Symbian OS. See the files RemovableFeatures.iby and feature.iby in <code>\\epoc32\\rom\\include</code>.
    59 //
    60 
    61 /**
    62  @page CAFLicensees Considerations for Licensees using CAF
    63  @section licenseesF32AgentUi F32 Agent User Interface
    64  @see ContentAccess::TF32AgentUiFactory
    65  @section licenseesRECCAF CAF Recognizer Mime Types
    66  @section licenseesROMOnly Allowing CAF to load non-ROM based agents
    67  @section licenseesExcludeAgents Omitting Content Access Agents from ROMs
    68 */