os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/HowToAgentConfiguration.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.
sl@0
     1
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of the License "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// <hr>
sl@0
    15
// The \c default_data section of an CA Agent or CA Agent proxy's resource file is 
sl@0
    16
// used to specify three pieces of information:
sl@0
    17
// The buffer size section is separated from the supplier MIME types by a '<code>|</code>' character 
sl@0
    18
// and the supplier MIME types are separated from the consumer MIME types by a '<code>:</code>' character.
sl@0
    19
// Below is an example for an OMA DRM agent. 
sl@0
    20
// default_data="100|application/vnd.oma.drm.message,application/vnd.oma.drm.rights+xml:application/vnd.oma.drm.content";
sl@0
    21
// <hr>
sl@0
    22
// The \c opaque_data section is used to specify the agent's private directory under <code>c:\\private\\</code>. This will be the 
sl@0
    23
// SID (SecureId) of the server who owns the directory, e.g.
sl@0
    24
// opaque_data="12345678";
sl@0
    25
// If the agent does not have a corresponding private directory or does not wish to provide access to that directory, it
sl@0
    26
// should just leave the \c opaque_data section as an empty string.
sl@0
    27
// <hr>
sl@0
    28
// // 101FE8F1.rss
sl@0
    29
// // UIDs quick-ref
sl@0
    30
// // ECOM DLL UID:		0x101FE8F1
sl@0
    31
// // CA Agent interface UID:	0x10204740
sl@0
    32
// // Test CAA Implementation:	0x101FE8F2
sl@0
    33
//
sl@0
    34
sl@0
    35
// #include <ecom/registryinfo.rh>
sl@0
    36
// RESOURCE REGISTRY_INFO theInfo
sl@0
    37
// dll_uid = 0x101FE8F1;
sl@0
    38
// interfaces =
sl@0
    39
// INTERFACE_INFO
sl@0
    40
// interface_uid = 0x10204740;
sl@0
    41
// implementations = 
sl@0
    42
// IMPLEMENTATION_INFO
sl@0
    43
// implementation_uid = 0x101FE8F2;
sl@0
    44
// version_no = 1;
sl@0
    45
// display_name = "Test Agent";
sl@0
    46
// default_data = "255|application/vnd.oma.drm.message,application/vnd.oma.drm.content:application/vnd.oma.drm.content"; // Sample CAF types
sl@0
    47
// opaque_data = "12345678";
sl@0
    48
// <hr>
sl@0
    49
// When writing a new CA Agent, all other UIDs used in the above examples should 
sl@0
    50
// be replaced by new UIDs from the Symbian UID generator. 
sl@0
    51
//
sl@0
    52
sl@0
    53
/**
sl@0
    54
 @page CAA_Configuration Content Access Agent ECOM Resource File
sl@0
    55
 - @ref default_data
sl@0
    56
 - @ref opaque_data
sl@0
    57
 - @ref RSSExample
sl@0
    58
 - @ref UIDs
sl@0
    59
 @section default_data default_data
sl@0
    60
 @li The buffer size required by this agent to recognize a file when <code>ContentAccess::CAgentManager::RecognizeFileL()</code> is called
sl@0
    61
 @li A list of supplier MIME types supported by this agent
sl@0
    62
 @li A list of consumer MIME types supported by this agent.
sl@0
    63
 @code
sl@0
    64
 @endcode
sl@0
    65
 @li It requires at least the first 100 bytes of a file in order to do recognition
sl@0
    66
 @li It supports a supplier MIME types of <code>application/vnd.oma.drm.message</code> and <code>application/vnd.oma.drm.rights+xml</code>
sl@0
    67
 @li It supports a consumer MIME type of <code>application/vnd.oma.drm.content</code>.
sl@0
    68
 @section opaque_data opaque_data
sl@0
    69
 @code
sl@0
    70
 @endcode
sl@0
    71
 @section RSSExample An Example Agent Resource File
sl@0
    72
 @code
sl@0
    73
 @endcode
sl@0
    74
 @section UIDs Important UIDs for CA Agents
sl@0
    75
 @li \c 0x10009D8D - the ECOM DLL UID. Identifies a DLL as an ECOM plugin
sl@0
    76
 @li \c 0x101FC2CE - The Content Access Agent v1.0 interface, an implementation of <code>ContentAccess::CAgentFactory::NewL()</code>.
sl@0
    77
 @li \c 0x10204740 - The Content Access Agent v2.0 interface, an implementation of <code>ContentAccess::CAgentFactory::NewL()</code>.
sl@0
    78
*/