_lcmaps_pluginmanager.h File Reference

API of the PluginManager. More...

#include "lcmaps_types.h"
#include "_lcmaps_credential.h"

Go to the source code of this file.

Functions
int	startPluginManager ()
	start the PluginManager
int	stopPluginManager ()
	Terminate the PluginManager module.
int	runPluginManager (lcmaps_request_t request, lcmaps_cred_id_t lcmaps_cred, int npols, char **policynames)
	Run the PluginManager.
int	runPlugin (const char *pluginname)
	Run a plugin.
int	resetCredentialData ()
	Reset the Credential data.

---

Detailed Description

API of the PluginManager.

Author:

Martijn Steenbakkers for the EU DataGrid.

This header contains the declarations of the LCMAPS library functions:

1. startPluginManager(): start the PluginManager --> load plugins, start evaluation manager
2. runPluginManager(): run the PluginManager --> run evaluation manager --> run plugins
3. stopPluginManager(): stop the PluginManager
4. runPlugin(): run the specified plugin. (used by Evaluation Manager)
5. resetCredentialData(): reset the Credential Data. (used by Evaluation Manager)

Definition in file _lcmaps_pluginmanager.h.

---

Function Documentation

resetCredentialData (   )

Reset the Credential data. Wrapper around cleanCredentialData() to be used by the Evaluation Manager, before a new policy is evaluated Returns: the return value of cleanCredentialData() Definition at line 982 of file lcmaps_pluginmanager.c. References cleanCredentialData(), and lcmaps_log_debug(). Referenced by pdl_next_plugin().

runPlugin (  const char *  pluginname  )

Run a plugin. Run a plugin for the Evaluation Manager the result (succes or not will be passed to the Evaluation Manager) Parameters: pluginname  the name of the plugin module Return values: 0  plugin run succeeded 1  plugin run failed Definition at line 1014 of file lcmaps_pluginmanager.c. References lcmaps_log(), lcmaps_log_debug(), lcmaps_log_time(), lcmaps_plugindl_t, lcmaps_plugindl_s::next, lcmaps_plugindl_s::pluginname, lcmaps_plugindl_s::procs, lcmaps_plugindl_s::run_argc, lcmaps_plugindl_s::run_argv, and RUNPROC. Referenced by runEvaluationManager(), and runPluginManager().

runPluginManager (  lcmaps_request_t  request, lcmaps_cred_id_t  lcmaps_cred, int  npols, char **  policynames )

Run the PluginManager. This function runs the PluginManager for user mapping. Contact Evaluation Manager --> runs plugins Parameters: request  RSL request (job request) lcmaps_cred  user credential npols  number of policies to be considered for evaluation policynames  the names of the policies to be considered for evaluation Return values: 0  user mapping succeeded 1  user mapping failed Definition at line 866 of file lcmaps_pluginmanager.c. References lcmaps_cred_id_t, lcmaps_extractRunVars(), lcmaps_getRunVars(), lcmaps_log(), lcmaps_log_debug(), lcmaps_plugindl_t, lcmaps_request_t, lcmaps_setArgValue(), lcmaps_plugindl_s::next, lcmaps_plugindl_s::pluginname, print_lcmaps_plugin(), lcmaps_plugindl_s::run_argc, lcmaps_plugindl_s::run_argv, runEvaluationManager(), and runPlugin(). Referenced by lcmaps_run(), lcmaps_run_and_return_poolindex(), lcmaps_run_and_return_username(), lcmaps_run_with_fqans_and_return_account(), and lcmaps_run_without_credentials_and_return_username().

startPluginManager (   )

start the PluginManager start the PluginManager --> load plugins, start evaluation manager Return values: 0  succes 1  failure Definition at line 160 of file lcmaps_pluginmanager.c. References clean_plugin_list(), getPluginNameAndArgs(), lcmaps_db_clean(), lcmaps_db_entry_t, lcmaps_db_read(), LCMAPS_ETC_HOME, lcmaps_genfilename(), lcmaps_log(), lcmaps_log_debug(), lcmaps_log_time(), LCMAPS_MAXPATHLEN, lcmaps_plugindl_t, lcmaps_plugindl_s::next, lcmaps_db_entry_s::next, PluginInit(), lcmaps_db_entry_s::pluginname, lcmaps_plugindl_s::pluginname, print_lcmaps_plugin(), and startEvaluationManager(). Referenced by lcmaps_init_and_logfile().

stopPluginManager (   )

Terminate the PluginManager module. stop the PluginManager --> terminate plugins, clean plugin list, (stop evaluation manager) Return values: 0  succes 1  failure Definition at line 1070 of file lcmaps_pluginmanager.c. References clean_plugin_list(), cleanCredentialData(), lcmaps_log(), lcmaps_log_debug(), printCredData(), and stopEvaluationManager(). Referenced by lcmaps_term().

---