sysstatemgmt/systemstatereferenceplugins/clayer/inc/ssmsecuritynotecontroller.h
changeset 0 4e1aa6a622a0
child 3 a811597961f0
child 12 e978f818f9bd
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:
       
    15 * Name        : strtsecuritynotecontroller.h
       
    16 * Part of     : System Startup / StrtSecObs
       
    17 * Declaration of CStrtSecurityNoteController class
       
    18 * Version     : %version: 1 % << Don't touch! Updated by Synergy at check-out.
       
    19 * This material, including documentation and any related computer
       
    20 * programs, is protected by copyright controlled by Nokia.  All
       
    21 * rights are reserved.  Copying, including reproducing, storing,
       
    22 * adapting or translating, any or all of this material requires the
       
    23 * prior written consent of Nokia.  This material also contains
       
    24 * confidential information which may not be disclosed to others
       
    25 * without the prior written consent of Nokia.
       
    26 * Template version: 4.2
       
    27 * Nokia Core OS *
       
    28 * File renamed from strtsecuritynotecontroller.h to ssmsecuritynotecontroller.h as part of Core OS transfer.
       
    29 *
       
    30 */
       
    31 
       
    32 
       
    33 
       
    34 #ifndef __SSMSECURITYNOTECONTROLLER_H__
       
    35 #define __SSMSECURITYNOTECONTROLLER_H__
       
    36 
       
    37 #include <e32base.h>
       
    38 
       
    39 #include "strtsecuritynotetype.h"
       
    40 
       
    41 /*
       
    42  *  @publishedPartner
       
    43  *  @released
       
    44 */
       
    45 
       
    46 class CSsmSecurityCheckNotifier;
       
    47 class CStrtSecNoteRequestQueue;
       
    48 
       
    49 /**
       
    50  *  This class controls security notes.
       
    51  *
       
    52  *  lib : strtsecobs.lib
       
    53  *  @since S60 3.2
       
    54  *  
       
    55  */
       
    56 NONSHARABLE_CLASS( CStrtSecurityNoteController ) : public CActive
       
    57     {
       
    58 
       
    59 public:
       
    60 
       
    61     /**
       
    62      * Two-phased constructor.
       
    63      */
       
    64     static CStrtSecurityNoteController* NewL();
       
    65 
       
    66     /**
       
    67     * Destructor.
       
    68     */
       
    69     virtual ~CStrtSecurityNoteController();
       
    70 
       
    71     /**
       
    72      * Initiate a security code query or information note, if there is no note
       
    73      * currently active.
       
    74      * If there is an active note, put this note to queue.
       
    75      *
       
    76      * @param aNoteType Identifies the security note to show.
       
    77      * @return One of the system-wide Symbian error codes.
       
    78      */
       
    79     TInt SecurityNoteRequested( const TStrtSecurityNoteType aNoteType );
       
    80 
       
    81     /**
       
    82      * A security code has been verified. Remove it from the queue (if it is
       
    83      * there).
       
    84      *
       
    85      * @param aNoteType Identifies the security code that has been verified.
       
    86      */
       
    87     void SecurityCodeVerified( const TStrtSecurityNoteType aNoteType );
       
    88 
       
    89 protected:
       
    90 // from base class CActive
       
    91 
       
    92     /**
       
    93      * From CActive.
       
    94      * Implements cancellation of an outstanding request.
       
    95      */
       
    96     virtual void DoCancel();
       
    97 
       
    98     /**
       
    99      * From CActive.
       
   100      * Handles an active object's request completion event.
       
   101      * Never leaves.
       
   102      */
       
   103     virtual void RunL();
       
   104 
       
   105 private:
       
   106 
       
   107     /**
       
   108      * C++ default constructor.
       
   109      */
       
   110     CStrtSecurityNoteController();
       
   111 
       
   112     /**
       
   113      * Second phase constructor.
       
   114      */
       
   115     void ConstructL();
       
   116 
       
   117     /**
       
   118      * Jump to RunL.
       
   119      */
       
   120     void CompleteSelf();
       
   121 
       
   122 private: // data
       
   123 
       
   124     /**
       
   125      * Queue of requested security notes. May not be NULL.
       
   126      * Own.
       
   127      */    
       
   128     CStrtSecNoteRequestQueue* iQueue;
       
   129 
       
   130     /**
       
   131      * Object for showing different security notes to user. May not be NULL.
       
   132      * Own.
       
   133      */    
       
   134     CSsmSecurityCheckNotifier* iSecurityNote;
       
   135 
       
   136 #ifdef TEST_CLAYER_MACRO
       
   137 	friend class CLayerTestSsmEventObserver;
       
   138 #endif //TEST_CLAYER_MACRO
       
   139 
       
   140     };
       
   141 #endif // __SSMSECURITYNOTECONTROLLER_H__