xdmprotocols/XcapProtocol/inc/XcapDirectory.h
branchGCC_SURGE
changeset 28 d9861ae9169c
parent 23 77cb48a03620
parent 26 04ca1926b01c
equal deleted inserted replaced
23:77cb48a03620 28:d9861ae9169c
     1 /*
       
     2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: CXcapDirectory
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __XCAPDIRECTORY__
       
    22 #define __XCAPDIRECTORY__
       
    23 
       
    24 #include <e32base.h>
       
    25 #include "XdmDirectory.h"
       
    26 #include "XdmDocument.h"
       
    27 
       
    28 //CONSTANTS
       
    29 _LIT( KDirectoryEntry,                     "entry" );
       
    30 _LIT( KAuidAttribute,                      "auid" );
       
    31 _LIT( KDocumentUri,                        "uri" );
       
    32 _LIT( KDocumentETag,                       "etag" );
       
    33 
       
    34 //AUIDs
       
    35 _LIT( KCapabilities,            "/services/org.openmobilealliance.xcap-caps/" );
       
    36 _LIT( KPocRules,                "/services/org.openmobilealliance.poc-rules" );
       
    37 _LIT( KPocGroup,                "/services/org.openmobilealliance.poc-groups" );
       
    38 _LIT( KResourceLists,           "/services/org.openmobilealliance.resource-lists/" );
       
    39 _LIT( KPresenceRules,           "/services/org.openmobilealliance.pres-rules/" );
       
    40 _LIT( KDirectoryUsage,          "/services/org.openmobilealliance.xcap-directory/" );
       
    41 _LIT( KSharedXDMS,              "/services/org.openmobilealliance.resource-lists/" );
       
    42 _LIT( KRlsServices,             "/services/org.openmobilealliance.rls-services/" );
       
    43 
       
    44 //FORWARD DECLARATIONS
       
    45 class CXdmDocument;
       
    46 class CXcapProtocol;
       
    47 class CXcapRetrieval;
       
    48 class CXcapHttpReqGet;
       
    49 class CXcapOperationFactory;
       
    50 
       
    51 //CLASS DECLARATION
       
    52 NONSHARABLE_CLASS( CXcapDirectory ) : public CXdmDirectory
       
    53     {
       
    54     public:
       
    55         
       
    56         /**
       
    57         * Symbian OS default constructor.
       
    58         * @param TInt Default Access Point ID
       
    59         * @return CXdmDocOperation*
       
    60         */     
       
    61         static CXcapDirectory* NewL( const TDesC& aAUID,
       
    62                                      CXdmEngine& aXdmEngine,
       
    63                                      CXdmDocument*& aDirectoryDoc,
       
    64                                      CXcapProtocol& aXcapProtocol );
       
    65 
       
    66         /**
       
    67         * Symbian OS default constructor.
       
    68         * @param TInt Default Access Point ID
       
    69         * @return CXdmDocOperation*
       
    70         */     
       
    71         void CancelUpdate();
       
    72 
       
    73         /**
       
    74         * Destructor.
       
    75         */      
       
    76         virtual ~CXcapDirectory();
       
    77     
       
    78     private: //From CXdmDirectory
       
    79         
       
    80         /**
       
    81         * Destructor.
       
    82         */
       
    83         TInt DocumentCount();
       
    84         
       
    85         /**
       
    86         * Return the root element of this document
       
    87         */
       
    88         TPtrC Document( TInt aIndex ) const;
       
    89 
       
    90         /**
       
    91         * Returns the path to this directory
       
    92         *
       
    93 		* @return TPtrC8 The path to the directory this object models 
       
    94         */
       
    95         TPtrC DirectoryPath() const;
       
    96         
       
    97         /**
       
    98         * Returns the path to this directory
       
    99         *
       
   100 		* @return TPtrC8 The path to the directory this object models 
       
   101         */
       
   102         TXdmDocType DocumentTypeL( TInt aIndex ) const;
       
   103 
       
   104     private:  //Methods
       
   105         
       
   106         /**
       
   107         * Symbian OS default constructor.
       
   108         * @param TInt Default Access Point ID
       
   109         * @return CXdmDocOperation*
       
   110         */     
       
   111         CXcapDirectory( CXdmDocument*& aDirectoryDoc,
       
   112                         CXdmEngine& aXdmEngine,
       
   113                         CXcapProtocol& aXcapProtocol );
       
   114         
       
   115         /**
       
   116         * Symbian OS default constructor.
       
   117         * @param TInt Default Access Point ID
       
   118         * @return CXdmDocOperation*
       
   119         */     
       
   120         void ConstructL( const TDesC& aAUID );
       
   121         
       
   122         /**
       
   123         * From CActive.
       
   124         * @return void
       
   125         */
       
   126 		void RunL();
       
   127 
       
   128         /**
       
   129         * From CActive.
       
   130         * @return void
       
   131         */
       
   132 		void DoCancel();
       
   133 		
       
   134 		/**
       
   135         * From CXdmDirectory.
       
   136         * @return void
       
   137         */
       
   138         void StartUpdateL();
       
   139         
       
   140         /**
       
   141         * Save the client's request status and update status
       
   142         * @param TDirUpdatePhase The update phase
       
   143         * @param TRequestStatus The client's request status
       
   144 		* @return void 
       
   145         */
       
   146         void SaveRequestData( TDirUpdatePhase aUpdatePhase,
       
   147                               TRequestStatus& aClientStatus );
       
   148         
       
   149         /**
       
   150         * From CXdmDirectory.
       
   151         * @return void
       
   152         */                 
       
   153         void HandleDocumentListRequestL();
       
   154         
       
   155         /**
       
   156         * From CXdmDirectory.
       
   157         * @return void
       
   158         */
       
   159         void HandleRefreshRequestL();
       
   160         
       
   161         /**
       
   162         * From CXdmDirectory.
       
   163         * @return void
       
   164         */
       
   165         void UpdateNextDocumentL();
       
   166         
       
   167         /**
       
   168         * From CXdmDirectory.
       
   169         * @return void
       
   170         */
       
   171         TBool CheckLocalCopyL( const CXdmDocumentNode* aDocumentNode );
       
   172         
       
   173         /**
       
   174         * From CXdmDirectory.
       
   175         * @return void
       
   176         */
       
   177         TPtrC ExtractDocumentUriL( const TDesC8& aRootUri,
       
   178                                    const CXdmDocumentNode* aDocumentNode );
       
   179         
       
   180         /**
       
   181         * From CXdmDirectory.
       
   182         * @return void
       
   183         */                          
       
   184         TXdmDocType FindAUID( const CXdmDocumentNode& aEntryNode ) const;
       
   185         
       
   186     private:  //Data
       
   187         
       
   188         TInt                            iUpdateIndex;
       
   189         TInt                            iDocumentCount;
       
   190         HBufC*                          iAUID;
       
   191         CXcapDocument*                  iDirectoryDoc;
       
   192         TRequestStatus*                 iClientStatus;
       
   193         TDirUpdatePhase                 iUpdatePhase;
       
   194         CXcapHttpReqGet*                iHttpRetrieval;
       
   195         CXcapProtocol&                  iXcapProtocol;
       
   196         RPointerArray<CXdmDocumentNode> iUpdateList;
       
   197         RPointerArray<CXdmDocumentNode> iDocumentList;
       
   198     };
       
   199 
       
   200 #endif      //__XCAPDIRECTORY__
       
   201             
       
   202 // End of File