smf/smfservermodule/smfserver/pluginmgr/smfpluginmanager.h
changeset 18 013a02bf2bb0
parent 14 a469c0e6e7fb
child 25 a180113055cb
equal deleted inserted replaced
17:106a4bfcb866 18:013a02bf2bb0
   118 			const QString& aPluginID, 
   118 			const QString& aPluginID, 
   119 			const SmfRequestTypeID& aOperation, 
   119 			const SmfRequestTypeID& aOperation, 
   120 			QByteArray& aInputData );
   120 			QByteArray& aInputData );
   121 	
   121 	
   122 	/**
   122 	/**
       
   123 	 * Method called by Smf server to create a synchronous plugin request.
       
   124 	 * @param aPluginID The plugin ID that need to perform this operation
       
   125 	 * @param aOperation The type of operation to be performed
       
   126 	 * @param aInputData The data required by the plugins
       
   127 	 * @param aOutputData [out] The output data to be filled by the plugins
       
   128 	 * @return SmfError The result of the operation. It can be :-
       
   129 	 * SmfPluginNoError (if the request is success) or 
       
   130 	 * SmfPluginLoadError (if plugin could not be loaded) or
       
   131 	 * SmfPluginNotAuthorised (if the plugin is not authorised) or
       
   132 	 * SmfPluginUnknownPluginService (if the requested service is not known or unsupported)
       
   133 	 */
       
   134 	SmfError createSyncRequest ( const QString& aPluginID, 
       
   135 			const SmfRequestTypeID& aOperation, 
       
   136 			QByteArray& aInputData,
       
   137 			QByteArray& aOutputData );
       
   138 	
       
   139 	/**
   123 	 * Method called by Transport Manager when network response is available
   140 	 * Method called by Transport Manager when network response is available
   124 	 * @param aTransportResult The result of Transport Operation
   141 	 * @param aTransportResult The result of Transport Operation
   125 	 * @param aReply The QNetworkReply instance that requested 
   142 	 * @param aReply The QNetworkReply instance that requested 
   126 	 * this transaction
   143 	 * this transaction
   127 	 * @param aResponse The network response data, may be NULL for error
   144 	 * @param aResponse The network response data, may be NULL for error
   230 	/**
   247 	/**
   231 	 * Method that checks if a plugin is authorised to make a request. 
   248 	 * Method that checks if a plugin is authorised to make a request. 
   232 	 * This method communicates with Credential and Settings Manager 
   249 	 * This method communicates with Credential and Settings Manager 
   233 	 * through Smf server, giving the registration token and getting 
   250 	 * through Smf server, giving the registration token and getting 
   234 	 * the valid url list if available for this plugin.
   251 	 * the valid url list if available for this plugin.
   235 	 * @param aRegToken The registration token given by the plugin
   252 	 * @param aPluginId The ID of the plugin
   236 	 * @param aUrlList [out] The list of Urls that the plugin can send 
   253 	 * @param aUrlList [out] The list of Urls that the plugin can send 
   237 	 * request to (to be filled by CSM). This list will be empty if 
   254 	 * request to (to be filled by CSM). This list will be empty if 
   238 	 * aRegToken is empty
   255 	 * aRegToken is empty
   239 	 * @return Returns true if plugin is authorised, else returns false.
   256 	 * @return Returns true if plugin is authorised, else returns false.
   240 	 * Also returns false if aRegToken is empty.
   257 	 * Also returns false if aRegToken is empty.
   241 	 */
   258 	 */
   242 	bool authorisePlugin( const QString &aRegToken, 
   259 	bool authorisePlugin( const QString &aPluginId, 
   243 			QList<QUrl> &aUrlList );
   260 			QList<QUrl> &aUrlList );
   244 	
   261 	
   245 	/**
   262 	/**
   246 	 * Method to serialize the result of parsing (which is done by the 
   263 	 * Method to serialize the result of parsing (which is done by the 
   247 	 * plugins) to QByteArray to be sent to Smf server.
   264 	 * plugins) to QByteArray to be sent to Smf server.