Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

lcmaps_vo_data.h File Reference

LCMAPS module for creating and accessing VO data structures. More...

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Data Structures

struct  lcmaps_vo_data_s
 structure that contains the VO information found in the user's gss credential. More...


Functions

lcmaps_vo_data_t* lcmaps_createVoData (const char *vo, const char *group, const char *subgroup, const char *role, const char *capability)
 Create a VoData structure. More...

int lcmaps_deleteVoData (lcmaps_vo_data_t **vo_data)
 Delete a VoData structure. More...

int lcmaps_cleanVoData (lcmaps_vo_data_t *vo_data)
 Clean a VoData structure. More...

int lcmaps_copyVoData (lcmaps_vo_data_t *dst_vo_data, const lcmaps_vo_data_t *src_vo_data)
 Copy a VoData structure into an empty VoData structure. More...

int lcmaps_printVoData (int debug_level, const lcmaps_vo_data_t *vo_data)
 Print the contents of a VoData structure. More...

int lcmaps_stringVoData (const lcmaps_vo_data_t *vo_data, char *buffer, int nchars)
 Cast a VoData structure into a string. More...


Detailed Description

LCMAPS module for creating and accessing VO data structures.

Author:
Martijn Steenbakkers for the EU DataGrid.

The interface is composed of:
  1. lcmaps_createVoData(): create a VoData structure
  2. lcmaps_deleteVoData(): delete a VoData structure
  3. lcmaps_copyVoData(): copy (the contents of) a VoData structure
  4. lcmaps_printVoData(): print the contents of a VoData structure
  5. lcmaps_stringVoData(): cast a VoData structure into a string

Definition in file lcmaps_vo_data.h.


Function Documentation

int lcmaps_cleanVoData ( lcmaps_vo_data_t * vo_data )
 

Clean a VoData structure.

Clean a VoData structure that was previously filled with lcmaps_copyVoData(). The contents are freed and set to zero.

Parameters:
vo_data   a pointer to a VoData structure
Return values:
0   in case of success
-1   in case of failure

Definition at line 192 of file lcmaps_vo_data.c.

int lcmaps_copyVoData ( lcmaps_vo_data_t * dst_vo_data,
const lcmaps_vo_data_t * src_vo_data )
 

Copy a VoData structure into an empty VoData structure.

Copy a VoData structure into an empty VoData structure which has to exist.

Parameters:
dst_vo_data   pointer to a empty VoData structure that should be filled
src_vo_data   pointer to the VoData structure that should be copied
Return values:
0   success
-1   failure (either src_vo_data or dst_vo_data was empty)

Definition at line 260 of file lcmaps_vo_data.c.

lcmaps_vo_data_t * lcmaps_createVoData ( const char * vo,
const char * group,
const char * subgroup,
const char * role,
const char * capability )
 

Create a VoData structure.

Create a VoData structure (store a VO, group, (subgroup,) role, capability combination). Allocate the memory. To be freed with lcmaps_deleteVoData().

Parameters:
vo   name of the VO
group   name of the group
subgroup   name of the subgroup (ignored for the moment)
role   the role
capability   the capability (whatever it is)

Returns:
pointer to the VoData structure or NULL

Definition at line 78 of file lcmaps_vo_data.c.

int lcmaps_deleteVoData ( lcmaps_vo_data_t ** vo_data )
 

Delete a VoData structure.

Delete a VoData structure that was previously created with lcmaps_createVoData(). The pointer to the VoData structure is finally set to NULL;

Parameters:
vo_data   pointer to a pointer to a VoData structure
Return values:
0   in case of success
-1   in case of failure

Definition at line 138 of file lcmaps_vo_data.c.

int lcmaps_printVoData ( int debug_level,
const lcmaps_vo_data_t * vo_data )
 

Print the contents of a VoData structure.

Parameters:
vo_data   pointer to a VoData structure
debug_level   debug_level for which the contents will be printed

Returns:
0 (always)

Definition at line 321 of file lcmaps_vo_data.c.

int lcmaps_stringVoData ( const lcmaps_vo_data_t * vo_data,
char * buffer,
int nchars )
 

Cast a VoData structure into a string.

The user of this function should create the buffer of size nchars beforehand. In buffer a string like the following will be written: "/VO=fred/GROUP=fred/flintstone/ROLE=director/CAPABILITY=destroy"

Currently the SUBGROUP entry is ignored. Only if the information is present in the VoData structure, it is added to the string. Both data for VO and GROUP are required (might change).

Parameters:
vo_data   pointer to a VoData structure
buffer   pointer to character array of size nchars
nchars   size of character array
Return values:
0   in case of success
-1   in case of failure

Definition at line 389 of file lcmaps_vo_data.c.


Generated at Tue Sep 23 15:48:38 2003 for edg-lcmaps by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001