1 /*

     2 * Copyright (c) 2001-2010 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 the License "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:  Class is interface from user of EAP-general settings to eap_general_settings_client_message_if_c.

    15 *

    16 */

    17 

    18 /*

    19 * %version: 7 %

    20 */

    21 

    22 #if !defined(_EAP_GENERAL_SETTINGS_MESSAGE_BASE_H_)

    23 #define _EAP_GENERAL_SETTINGS_MESSAGE_BASE_H_

    24 

    25 #include "eap_tools.h"

    26 #include "eap_am_export.h"

    27 

    28 class abs_eap_general_settings_message_c;

    29 class eap_method_settings_c;

    30 

    31 /// Class is interface from user of EAP-general settings to eap_general_settings_client_message_if_c.

    32 class EAP_EXPORT eap_general_settings_message_c

    33 {

    34 private:

    35 	//--------------------------------------------------

    36 

    37 

    38 	//--------------------------------------------------

    39 protected:

    40 	//--------------------------------------------------

    41 

    42 	//--------------------------------------------------

    43 public:

    44 	//--------------------------------------------------

    45 

    46 	/**

    47 	 * The destructor of the eap_core class does nothing special.

    48 	 */

    49 	EAP_FUNC_IMPORT virtual ~eap_general_settings_message_c();

    50 

    51 	/**

    52 	 * The constructor initializes member attributes.

    53 	 */

    54 	EAP_FUNC_IMPORT eap_general_settings_message_c();

    55 

    56 	/**

    57 	 * This function must reset the state of object to same as 

    58 	 * state was after the configure() function call.

    59 	 * If object reset succeeds this function must return eap_status_ok.

    60 	 * If object reset fails this function must return corresponding error status.

    61 	 * @return This function returns the status of reset operation.

    62 	 */

    63 	virtual eap_status_e reset() = 0;

    64 

    65 	// This is documented in abs_eap_stack_interface_c::configure().

    66 	virtual eap_status_e configure() = 0;

    67 

    68 	// This is documented in abs_eap_stack_interface_c::shutdown().

    69 	virtual eap_status_e shutdown() = 0;

    70 

    71 	// This is documented in abs_eap_stack_interface_c::get_is_valid().

    72 	virtual bool get_is_valid() = 0;

    73 

    74 	virtual eap_status_e get_eap_methods(const eap_method_settings_c * const internal_settings) = 0;

    75 

    76 	virtual eap_status_e set_eap_methods(const eap_method_settings_c * const internal_settings) = 0;

    77 

    78 	virtual eap_status_e get_certificate_lists(const eap_method_settings_c * const internal_settings) = 0;

    79 

    80 	virtual eap_status_e delete_all_eap_settings(const eap_method_settings_c * const internal_settings) = 0;

    81 

    82 	virtual eap_status_e copy_all_eap_settings(const eap_method_settings_c * const internal_settings) = 0;

    83 

    84 	//--------------------------------------------------

    85 }; // class eap_general_settings_message_c

    86 

    87 /// Function creates new eap_general_settings_message_c object.

    88 eap_general_settings_message_c * new_eap_general_settings_client_message_if_c(

    89 	abs_eap_am_tools_c * const tools,

    90 	abs_eap_general_settings_message_c * const partner);

    91 

    92 //--------------------------------------------------

    93 

    94 #endif //#if !defined(_EAP_GENERAL_SETTINGS_MESSAGE_BASE_H_)

    95 

    96 //--------------------------------------------------

    97 

    98 

    99 

   100 // End.