smf/smfcredentialmgr/smfcredmgrserver/inc/smfcredmgrdb.h
changeset 18 013a02bf2bb0
parent 14 a469c0e6e7fb
--- a/smf/smfcredentialmgr/smfcredmgrserver/inc/smfcredmgrdb.h	Thu Aug 05 16:46:37 2010 +0530
+++ b/smf/smfcredentialmgr/smfcredmgrserver/inc/smfcredmgrdb.h	Thu Aug 05 16:48:48 2010 +0530
@@ -7,15 +7,20 @@
  * at the URL "http://www.eclipse.org/legal/epl-v10.html"
  *
  * Initial Contributors:
- * Pritam Roy Biswas, Sasken Communication Technologies Ltd - Initial contribution
+ * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
+ * 
+ * Contributors:
+ * Pritam Roy Biswas, Nalina Hariharan, Sasken Communication Technologies Ltd
  *
  * Description:
  * This header defines the database-table and the creation of database that will be 
- *  used by the Credential Manager Server to store all 
- *  the credentials related to an Authentication Application
+ * used by the Credential Manager Server to store all the credentials related 
+ * to an Authentication Application
  */
+
 #ifndef SMFCREDMGRDB_H_
 #define SMFCREDMGRDB_H_
+
 #include <sqldb.h>
 #include <e32base.h>
 #include <f32file.h>
@@ -24,79 +29,95 @@
 _LIT(KSmfCredMgrDbPrivateDir, "C:\\private\\EF0FFBD7\\");
 _LIT(KSmfCredMgrDbFileName, "[EF0FFBD7]CREDMGRDB.db");
 
-//Create Table
-_LIT8(KCreatePluginIDTable,"CREATE TABLE PluginIDTable(PluginId TEXT PRIMARY KEY, AuthAppId TEXT UNIQUE, IsEnabled INT)");
-_LIT8(KCreateURLTable,"CREATE TABLE URLTable(AuthAppId TEXT UNIQUE, URL TEXT,PRIMARY KEY(AuthAppId,URL))");
+//Create Database Table Queries
+_LIT8(KCreatePluginIDTable,"CREATE TABLE PluginIDTable(PluginId TEXT, AuthAppId TEXT, IsEnabled INT, PRIMARY KEY(PluginId, AuthAppId))");
+_LIT8(KCreateURLTable,"CREATE TABLE URLTable(AuthAppId TEXT, URL TEXT, PRIMARY KEY(AuthAppId, URL))");
 _LIT8(KCreateRegTokenValidityTable,"CREATE TABLE RegTokenValidityTable(RegistrationToken TEXT PRIMARY KEY, AuthAppId TEXT UNIQUE, Validity BIGINT)");
-_LIT8(KCreateAuthParamsTable,"CREATE TABLE AuthParamsTable(AuthAppId TEXT UNIQUE, AuthKey TEXT, AuthSecret TEXT, PRIMARY KEY(AuthAppId,AuthKey))");
+_LIT8(KCreateAuthParamsTable,"CREATE TABLE AuthParamsTable(AuthAppId TEXT, AuthKey TEXT, AuthSecret TEXT, PRIMARY KEY(AuthAppId, AuthKey))");
+
 
 /**
  * The creator class of the server database.
- *  Derives from CBase
+ * Derives from CBase
  */
 class CSmfCredMgrDb : public CBase
 	{
 public:
 	/**
-	 * New Methods
+	 * NewL Method
+	 * @return The constructed CSmfCredMgrDb instance
 	 */
 	static CSmfCredMgrDb* NewL();
+	
 	/**
-	 * New Methods
+	 * NewLC Method
+	 * @return The constructed CSmfCredMgrDb instance
 	 */
 	static CSmfCredMgrDb* NewLC();
 
 	/**
-	 * destructor
+	 * Destructor
 	 */
 	~CSmfCredMgrDb();
 
 private:
 	/**
-	 * constructor
+	 * Constructor
 	 */
 	CSmfCredMgrDb();
 
 	/**
-	 * two phase constructor
+	 * Two phase constructor
 	 */
 	void ConstructL();
 
 	/**
 	 * Method to create the Db file
 	 * @param aFileName The file name
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description.
 	 */
 	TInt CreateDbFile(const TFileName &aFileName);
 
 	/**
-	 * Method to crete the Db tables
+	 * Method to create the Db tables
 	 * @param aFileName The Db file name
 	 */
 	void CompleteDBCreationL(const TFileName &aFileName);
 
 	/**
-	 * Creates the Plugin Id table 
+	 * Creates the Plugin Id table
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description. 
 	 */
 	TInt PluginIDTableCreate();
 
 	/**
-	 * Creates the URL table 
+	 * Creates the URL table
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description.
 	 */
 	TInt URLTableCreate();
 
 	/**
-	 * Creates the RegistrationToken-Validity Table  
+	 * Creates the RegistrationToken-Validity Table
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description.
 	 */
 	TInt RegTokenValidityTableCreate();
 
 	/**
-	 * Creates the Authentication Parameters Table  
+	 * Creates the Authentication Parameters Table
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description.
 	 */
 	TInt AuthParamsTableCreate();
 
 	/**
 	 * Deletes the Db 
 	 * @param aFileName The Db file name
+	 * @return Returns KErrNone if success. Refer ESqlDbError and system-wide 
+	 * error codes for detailed error description.
 	 */
 	TInt DeleteDbFile(const TFileName &aFileName);