_lcmaps_runvars.h File Reference

API of runvars structure. More...

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

Go to the source code of this file.

Functions
LCMAPS_RUNVARS_STORAGE_CLASS int	lcmaps_extractRunVars (lcmaps_request_t request, lcmaps_cred_id_t lcmaps_cred)
	extract the variables from user credential that can be used by the plugins
LCMAPS_RUNVARS_STORAGE_CLASS void *	lcmaps_getRunVars (char *argName, char *argType)
	returns a void pointer to the requested value
LCMAPS_RUNVARS_STORAGE_CLASS int	lcmaps_setRunVars (char *argName, char *argType, void *value)
	fill the runvars_list with a value for argName and argType

---

Detailed Description

API of runvars structure.

Author:

Martijn Steenbakkers for the EU DataGrid.

This module takes the data that are presented to LCMAPS (the global credential and Job request) and extracts the variables that will be used by the plugins from it and stores them into a list. The interface to the LCMAPS module is composed of:

1. lcmaps_extractRunVars(): takes the global credential and Job request and extracts run variables from them
2. lcmaps_setRunVars(): adds run variables to a list
3. lcmaps_getRunVars(): gets run variables from list

Definition in file _lcmaps_runvars.h.

---

Function Documentation

lcmaps_extractRunVars (  lcmaps_request_t  request, lcmaps_cred_id_t  lcmaps_cred )

extract the variables from user credential that can be used by the plugins This function takes the user credential and job request (in RSL) and extracts the information which is published in the runvars_list. These variables can be accessed by the plugins. Parameters: request  the job request (RSL) lcmaps_cred  the credential presented by the user Return values: 0  succes. 1  failure. Definition at line 119 of file lcmaps_runvars.c. References lcmaps_cred_id_s::context, lcmaps_cred_id_s::cred, lcmaps_cred_id_s::dn, lcmaps_cred_id_s::fqan, lcmaps_cntArgs(), lcmaps_cred_id_t, lcmaps_log(), lcmaps_log_debug(), lcmaps_request_t, lcmaps_setRunVars(), and lcmaps_cred_id_s::nfqan. Referenced by runPluginManager().

lcmaps_getRunVars (  char *  argName, char *  argType )

returns a void pointer to the requested value This function returns a void pointer to the requested variable with name argName and type argType in the runvars_list. Internally it uses lcmaps_getArgValue(). Parameters: argName  name of the variable argType  type of the variable Returns: void pointer to the value or NULL Definition at line 241 of file lcmaps_runvars.c. References lcmaps_getArgValue(). Referenced by runPluginManager().

lcmaps_setRunVars (  char *  argName, char *  argType, void *  value )

fill the runvars_list with a value for argName and argType This function fills the (internal) runvars_list with the value for the variable with name argName and type argType. Internally lcmaps_setArgValue() is used. Parameters: argName  name of the runvars variable argType  type of the runvars variable value  void pointer to the value Return values: 0  succes. -1  failure. Definition at line 282 of file lcmaps_runvars.c. References lcmaps_argument_t, lcmaps_log_debug(), and lcmaps_setArgValue(). Referenced by lcmaps_extractRunVars().

---