PECengine/ListLibrary2/AuthSrc/MPEngAuthorizationEngine.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     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:  Authorization engine interface
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __MPENGAUTHORIZATIONENGINE_H__
       
    19 #define __MPENGAUTHORIZATIONENGINE_H__
       
    20 
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class   CPEngAuthorizationResponse;
       
    27 class   CPEngAuthorizationRequest;
       
    28 
       
    29 
       
    30 // CLASS DECLARATION
       
    31 /**
       
    32  * Authorization engine abstract API
       
    33  */
       
    34 class MPEngAuthorizationEngine
       
    35     {
       
    36 
       
    37     public: // New functions
       
    38 
       
    39         /**
       
    40          * Update Reactive authorization state
       
    41          * Store new Authorization state in the authorization engine
       
    42          *
       
    43          * @since 3.0
       
    44          * @param aAuthResponse aAuthResponse response to take details from
       
    45          * @param aPartialAcceptance if only part of the attributes can be accepted
       
    46          *        this settigs depends on the capabililty of the server
       
    47          */
       
    48         virtual void UpdateAuthorizationStateL(
       
    49             CPEngAuthorizationResponse& aAuthResponse,
       
    50             TBool aPartialAcceptance ) = 0;
       
    51 
       
    52         /**
       
    53          * Removes authorization request.
       
    54          */
       
    55         virtual void RemoveAuthorizationRequestL(
       
    56             CPEngAuthorizationResponse& aAuthResponse ) = 0;
       
    57 
       
    58         /**
       
    59          * Add Authorization request.
       
    60          * Parameter aAuthRequest must be on clean up stack before
       
    61          * calling this method and it will be removed
       
    62          *
       
    63          * @since 3.0
       
    64          * @param aAuthRequest authorization request to add
       
    65          */
       
    66         virtual void AddAuthRequestLX( CPEngAuthorizationRequest* aAuthRequest ) = 0;
       
    67 
       
    68 
       
    69         /**
       
    70          * Add Authorization status
       
    71          * Parameter aAuthStatus must be on clean up stack before calling this method
       
    72          * and it will be removed
       
    73          *
       
    74          * @since 3.0
       
    75          * @param aAuthStatus authorization status to add
       
    76          */
       
    77         virtual void AddAuthStatusLX( CPEngAuthorizationResponse* aAuthStatus ) = 0;
       
    78 
       
    79 
       
    80         /**
       
    81          * Engine store size counter
       
    82          *
       
    83          * @since 3.0
       
    84          * @return size counter
       
    85          */
       
    86         virtual TInt& SizeCounter() = 0;
       
    87 
       
    88 
       
    89         /**
       
    90          * Lock for Network publishing
       
    91          *
       
    92          * @since 3.0
       
    93          */
       
    94         virtual void LockForNetworkPublishing() = 0;
       
    95 
       
    96 
       
    97         /**
       
    98          * Unlock from Network publishing
       
    99          *
       
   100          * @since 3.0
       
   101          */
       
   102         virtual void UnLockForNetworkPublishing() = 0;
       
   103 
       
   104 
       
   105     protected:  //Destructor
       
   106 
       
   107         /**
       
   108          * Virtual inline destructor.
       
   109          * Protected to prohibite deletion through interface.
       
   110          */
       
   111         virtual ~MPEngAuthorizationEngine() {};
       
   112 
       
   113     };
       
   114 #endif      //  __MPENGAUTHORIZATIONENGINE_H__
       
   115 
       
   116 //  End of File
       
   117