1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/HowToAgentConfiguration.dox	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,78 @@
     1.4 +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// <hr>
    1.18 +// The \c default_data section of an CA Agent or CA Agent proxy's resource file is 
    1.19 +// used to specify three pieces of information:
    1.20 +// The buffer size section is separated from the supplier MIME types by a '<code>|</code>' character 
    1.21 +// and the supplier MIME types are separated from the consumer MIME types by a '<code>:</code>' character.
    1.22 +// Below is an example for an OMA DRM agent. 
    1.23 +// default_data="100|application/vnd.oma.drm.message,application/vnd.oma.drm.rights+xml:application/vnd.oma.drm.content";
    1.24 +// <hr>
    1.25 +// The \c opaque_data section is used to specify the agent's private directory under <code>c:\\private\\</code>. This will be the 
    1.26 +// SID (SecureId) of the server who owns the directory, e.g.
    1.27 +// opaque_data="12345678";
    1.28 +// If the agent does not have a corresponding private directory or does not wish to provide access to that directory, it
    1.29 +// should just leave the \c opaque_data section as an empty string.
    1.30 +// <hr>
    1.31 +// // 101FE8F1.rss
    1.32 +// // UIDs quick-ref
    1.33 +// // ECOM DLL UID:		0x101FE8F1
    1.34 +// // CA Agent interface UID:	0x10204740
    1.35 +// // Test CAA Implementation:	0x101FE8F2
    1.36 +//
    1.37 +
    1.38 +// #include <ecom/registryinfo.rh>
    1.39 +// RESOURCE REGISTRY_INFO theInfo
    1.40 +// dll_uid = 0x101FE8F1;
    1.41 +// interfaces =
    1.42 +// INTERFACE_INFO
    1.43 +// interface_uid = 0x10204740;
    1.44 +// implementations = 
    1.45 +// IMPLEMENTATION_INFO
    1.46 +// implementation_uid = 0x101FE8F2;
    1.47 +// version_no = 1;
    1.48 +// display_name = "Test Agent";
    1.49 +// default_data = "255|application/vnd.oma.drm.message,application/vnd.oma.drm.content:application/vnd.oma.drm.content"; // Sample CAF types
    1.50 +// opaque_data = "12345678";
    1.51 +// <hr>
    1.52 +// When writing a new CA Agent, all other UIDs used in the above examples should 
    1.53 +// be replaced by new UIDs from the Symbian UID generator. 
    1.54 +//
    1.55 +
    1.56 +/**
    1.57 + @page CAA_Configuration Content Access Agent ECOM Resource File
    1.58 + - @ref default_data
    1.59 + - @ref opaque_data
    1.60 + - @ref RSSExample
    1.61 + - @ref UIDs
    1.62 + @section default_data default_data
    1.63 + @li The buffer size required by this agent to recognize a file when <code>ContentAccess::CAgentManager::RecognizeFileL()</code> is called
    1.64 + @li A list of supplier MIME types supported by this agent
    1.65 + @li A list of consumer MIME types supported by this agent.
    1.66 + @code
    1.67 + @endcode
    1.68 + @li It requires at least the first 100 bytes of a file in order to do recognition
    1.69 + @li It supports a supplier MIME types of <code>application/vnd.oma.drm.message</code> and <code>application/vnd.oma.drm.rights+xml</code>
    1.70 + @li It supports a consumer MIME type of <code>application/vnd.oma.drm.content</code>.
    1.71 + @section opaque_data opaque_data
    1.72 + @code
    1.73 + @endcode
    1.74 + @section RSSExample An Example Agent Resource File
    1.75 + @code
    1.76 + @endcode
    1.77 + @section UIDs Important UIDs for CA Agents
    1.78 + @li \c 0x10009D8D - the ECOM DLL UID. Identifies a DLL as an ECOM plugin
    1.79 + @li \c 0x101FC2CE - The Content Access Agent v1.0 interface, an implementation of <code>ContentAccess::CAgentFactory::NewL()</code>.
    1.80 + @li \c 0x10204740 - The Content Access Agent v2.0 interface, an implementation of <code>ContentAccess::CAgentFactory::NewL()</code>.
    1.81 +*/