FCL/sf/mw/accesssec: comparison securitysettings/eapqtdialogs/src/eapdialogplugin.cpp

equal deleted inserted replaced

-:ad1f037f1ac2
+:c98682f98478
 * Description: Eap Dialog Plugin implementation
 *
 */
 /*
-* %version: 8 %
+* %version: 9 %
 */
+// System includes
 #include <hbdevicedialoginterface.h>
 #include <QVariantMap>
+// User includes
 #include "eapdialogplugin.h"
 #include "eapusernamepwddialog.h"
 #include "eapquerydialog.h"
 #include "eappasswordquerydialog.h"
 #include "eapfastinstallpacquerydialog.h"
 #include "eapfastprovnotsuccessnotedialog.h"
 #include "OstTraceDefinitions.h"
 #ifdef OST_TRACE_COMPILER_IN_USE
 #endif
+/*!
+* \class EapDialogPlugin
+* \brief Implements Eap Dialog Plugin.
+*/
+// External function prototypes
 Q_EXPORT_PLUGIN2(eapdialogplugin, EapDialogPlugin)
+// Local constants
-// This plugin implements one device dialog type
+//! This plugin implements several device dialog types
 static const struct {
 const char *mTypeString;
 } dialogInfos[] = {
 {"com.nokia.eap.usernamepassworddialog/1.0"},
 {"com.nokia.eap.querydialog/1.0"},
 {"com.nokia.eap.mschapv2oldpassworddialog/1.0"},
 {"com.nokia.eap.mschapv2newpassworddialog/1.0"},
 {"com.nokia.eap.fastshowprovnotsuccessnotedialog/1.0"}
 };
-/**
+// ======== LOCAL FUNCTIONS ========
-* Constructor
-*/
+// ======== MEMBER FUNCTIONS ========
+/*!
+* Constructor.
+*/
 EapDialogPlugin::EapDialogPlugin()
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_EAPDIALOGPLUGIN_ENTRY );
 qDebug("EapDialogPlugin::EapDialogPlugin");
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_EAPDIALOGPLUGIN_EXIT );
 }
-/**
+/*!
 * Destructor
 */
 EapDialogPlugin::~EapDialogPlugin()
 {
 OstTraceFunctionEntry0( DUP1_EAPDIALOGPLUGIN_DEAPDIALOGPLUGIN_ENTRY );
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_DEAPDIALOGPLUGIN_EXIT );
 }
-/**
+/*!
 * Create device dialog widget
+*
+* @param [in]  deviceDialogType Tells which Dialog to create
+* @param [in]  parameters Parameters for the Construction of the dialog.
+* @return  created dialog widget
 */
 HbDeviceDialogInterface *EapDialogPlugin::createDeviceDialog(
 const QString &deviceDialogType,
 const QVariantMap &parameters)
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_CREATEDEVICEDIALOG_ENTRY );
 qDebug("EapDialogPlugin::createDeviceDialog ENTER");
+HbDeviceDialogInterface* dialog = NULL;
-if ( deviceDialogType.compare("com.nokia.eap.usernamepassworddialog/1.0") == 0 )
+if ( deviceDialogType.compare(dialogInfos[0].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapUsernamePwdDialog");
-return ( new EapUsernamePwdDialog(parameters) );
+dialog = new EapUsernamePwdDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.querydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[1].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapQueryDialog");
-return ( new EapQueryDialog(parameters) );
+dialog = new EapQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.passwordquerydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[2].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapPasswordQueryDialog");
-return ( new EapPasswordQueryDialog(parameters) );
+dialog = new EapPasswordQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastinstallpacquerydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[3].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastInstallPacQueryDialog");
-return ( new EapFastInstallPacQueryDialog(parameters) );
+dialog = new EapFastInstallPacQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastpacstorepwquerydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[4].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastPacStorePwQueryDialog");
-return ( new EapFastPacStorePwQueryDialog(parameters));
+dialog = new EapFastPacStorePwQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastcreatemasterkeyquerydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[5].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastCreateMasterKeyQueryDialog");
-return ( new EapFastCreateMasterKeyQueryDialog(parameters) );
+dialog = new EapFastCreateMasterKeyQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastpacfilepwquerydialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[6].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastPacFilePwQueryDialog");
-return ( new EapFastPacFilePwQueryDialog(parameters) );
+dialog = new EapFastPacFilePwQueryDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastprovwaitnotedialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[7].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastProvWaitNoteDialog");
-return ( new EapFastProvWaitNoteDialog(parameters) );
+dialog = new EapFastProvWaitNoteDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.mschapv2passwordexpirednotedialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[8].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapMschapv2PwdExpNoteDialog");
-return ( new EapMschapv2PwdExpNoteDialog(parameters) );
+dialog = new EapMschapv2PwdExpNoteDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.mschapv2oldpassworddialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[9].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapMschapv2OldPwdDialog");
-return ( new EapMschapv2OldPwdDialog(parameters) );
+dialog = new EapMschapv2OldPwdDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.mschapv2newpassworddialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[10].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapMschapv2NewPwdDialog");
-return ( new EapMschapv2NewPwdDialog(parameters) );
+dialog = new EapMschapv2NewPwdDialog(parameters);
 }
-else if ( deviceDialogType.compare("com.nokia.eap.fastshowprovnotsuccessnotedialog/1.0") == 0 )
+else if ( deviceDialogType.compare(dialogInfos[11].mTypeString) == 0 )
 {
 qDebug("EapDialogPlugin::createDeviceDialog: new EapFastProvNotSuccessNoteDialog");
-return ( new EapFastProvNotSuccessNoteDialog(parameters) );
+dialog = new EapFastProvNotSuccessNoteDialog(parameters);
 }
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_CREATEDEVICEDIALOG_EXIT );
 qDebug("EapDialogPlugin::createDeviceDialog EXIT");
-return NULL;
+return dialog;
 }
-/**
+/*!
-* Check if client is allowed to use device dialog widget
+* Check if client is allowed to use device dialog widget. For the meantime
-*/
+* this plugin doesn't perform operations that may compromise security.
+* All clients are allowed to use.
+*
+* @param [in]  deviceDialogType Tells which Dialog type
+* @param [in]  parameters Device dialog parameters
+* @param [in]  securityInfo Information for Security check
+* @return  returns always true
+*/
 bool EapDialogPlugin::accessAllowed(const QString &deviceDialogType,
 const QVariantMap &parameters, const QVariantMap &securityInfo) const
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_ACCESSALLOWED_ENTRY );
 Q_UNUSED(deviceDialogType)
 Q_UNUSED(parameters)
 Q_UNUSED(securityInfo)
-// This plugin doesn't perform operations that may compromise security.
-// All clients are allowed to use.
 return true;
 }
-/**
+/*!
 * Return information of device dialog the plugin creates
+*
+* @param [in]  deviceDialogType Tells which Dialog type
+* @param [in]  parameters Device dialog parameters
+* @param [in,out]  info Structure the plugin fills with an information
+* @return  returns always true
 */
 bool EapDialogPlugin::deviceDialogInfo(const QString &deviceDialogType,
 const QVariantMap &parameters, DeviceDialogInfo *info) const
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_DEVICEDIALOGINFO_ENTRY );
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_DEVICEDIALOGINFO_EXIT );
 qDebug("EapDialogPlugin::deviceDialogInfo EXIT");
 return true;
 }
-/**
+/*!
-* Return device dialog types this plugin implements
+* Returns a list of device dialog types the plugin implements.
+*
+* @return returns device dialog types this plugin implements
 */
 QStringList EapDialogPlugin::deviceDialogTypes() const
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_DEVICEDIALOGTYPES_ENTRY );
 qDebug("EapDialogPlugin::deviceDialogTypes");
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_DEVICEDIALOGTYPES_EXIT );
 return types;
 }
-/**
+/*!
 * Return plugin flags
+*
+* @return returns plugin flags
 */
 EapDialogPlugin::PluginFlags EapDialogPlugin::pluginFlags() const
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_PLUGINFLAGS_ENTRY );
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_PLUGINFLAGS_EXIT );
 return NoPluginFlags;
 }
-/**
+/*!
 * The last error is not stored, not supported
+*
+* @return returns always 0
 */
 int EapDialogPlugin::error() const
 {
 OstTraceFunctionEntry0( EAPDIALOGPLUGIN_ERROR_ENTRY );
 OstTraceFunctionExit0( EAPDIALOGPLUGIN_ERROR_EXIT );

changeset 36	c98682f98478
parent 34	ad1f037f1ac2
child 44	22d80358905b