The interface to be implemented by LCMAPS plugins

Functions
int	plugin_introspect (int *argc, lcmaps_argument_t **argv)
	Plugin asks for required arguments.
int	plugin_initialize (int argc, char **argv)
	initialize the plugin.
int	plugin_run (int argc, lcmaps_argument_t *argv)
	Gather credentials for user making use of the ordered arguments.
int	plugin_terminate ()
	Whatever is needed to terminate the plugin module goes in here.

---

Detailed Description

This is the interface that LCMAPS the plugin have to implement.

---

Function Documentation

plugin_initialize (  int  argc, char **  argv )

initialize the plugin. Everything that is needed to initialize the plugin should be put inside this function. Arguments as read from the LCMAPS database (argc, argv) are passed to the plugin. Parameters: argc  number of passed arguments. argv  argument list. argv[0] contains the name of the plugin. Return values: LCMAPS_MOD_SUCCESS  successful initialization LCMAPS_MOD_FAIL  failure in the plugin initialization LCMAPS_MOD_NOFILE  private plugin database could not be found (same effect as LCMAPS_MOD_FAIL) Definition at line 144 of file lcmaps_plugin_example.c. References lcmaps_log_debug(), LCMAPS_MOD_SUCCESS, and plugin_initialize(). Referenced by plugin_initialize().

plugin_introspect (  int *  argc, lcmaps_argument_t **  argv )

Plugin asks for required arguments. Parameters: argc  the number of arguments requested by this plugin argv  the (empty) list of arguments requested by this plugin Return values: LCMAPS_MOD_SUCCESS  success LCMAPS_MOD_FAIL  failure (will result in a lcmaps failure) Definition at line 90 of file lcmaps_plugin_example.c. References lcmaps_argument_t, lcmaps_cntArgs(), lcmaps_log_debug(), LCMAPS_MOD_SUCCESS, and plugin_introspect(). Referenced by plugin_introspect().

plugin_run (  int  argc, lcmaps_argument_t *  argv )

Gather credentials for user making use of the ordered arguments. Ask for credentials by passing the arguments (like JDL, globus DN, VOMS roles etc.) that were ordered earlier by the plugin_introspect() function Parameters: argc  number of arguments argv  list of arguments Return values: LCMAPS_MOD_SUCCESS  authorization succeeded LCMAPS_MOD_FAIL  authorization failed Definition at line 187 of file lcmaps_plugin_example.c. References lcmaps_argument_t, lcmaps_getArgValue(), lcmaps_log_debug(), LCMAPS_MOD_FAIL, LCMAPS_MOD_SUCCESS, lcmaps_request_t, and plugin_run(). Referenced by plugin_run().

plugin_terminate (   )

Whatever is needed to terminate the plugin module goes in here. Return values: LCMAPS_MOD_SUCCESS  success LCMAPS_MOD_FAIL  failure (will result in an authorization failure) Definition at line 259 of file lcmaps_plugin_example.c. References lcmaps_log_debug(), and LCMAPS_MOD_SUCCESS.

---