ServiceDiscovery.h

Go to the documentation of this file.

/*
 * Copyright (c) Members of the EGEE Collaboration. 2004.
 * See http://eu-egee.org/partners/ for details on the copyright holders.
 * For license conditions see the license file or http://eu-egee.org/license.html
 *
 * Authors:
 *     Gabor Gombas <Gabor.Gombas@cern.ch>
 *     John Walk <J.A.Walk@rl.ac.uk>
 */

#ifndef SERVICE_DISCOVERY_H
#define SERVICE_DISCOVERY_H

/* This is the C API for the GLite Service Discovery sub-system. It directly
   copies the Java interface in org.glite.service-discovery.api-java. */

#ifdef __cplusplus
extern "C" {
#endif

/* GLOBAL DEFINES *************************************************************/

#define SDStatus_SUCCESS 0
#define SDStatus_FAILURE 1

/* Name of the environment variable holding the default VO */
#define SDEnv_VO     "GLITE_SD_VO"
/* Name of the environment variable holding the default site */
#define SDEnv_SITE   "GLITE_SD_SITE"
/* Name of the environment variable holding the list of plugins to use */
#define SDEnv_PLUGIN "GLITE_SD_PLUGIN"


/* GLOBAL TYPE DEFINITIONS  ***************************************************/

typedef struct
{
        char *key;
        char *value;
} SDServiceData;


typedef struct
{
        void * const _owner;
        int numItems;
        SDServiceData *items;
} SDServiceDataList;


typedef struct
{
        int numNames;
        char **names;
} SDVOList;


typedef struct
{
        void * const _owner;
        char *name;
        char *type;
        char *endpoint;
        char *version;
} SDService;


typedef struct
{
        void * const _owner;
        int numServices;
        SDService **services;
} SDServiceList;


typedef struct
{
        void * const _owner;
        char *name;
        char *type;
        char *endpoint;
        char *version;
        char *site;
        char *wsdl;
        char *administration;
        SDVOList *vos;
        SDServiceList *associatedServices;
        SDServiceDataList *data;
} SDServiceDetails;


typedef struct
{
        void * const _owner;
        int numServiceDetails;
        SDServiceDetails **servicedetails;
} SDServiceDetailsList;


typedef struct
{
        int status;
        char *reason;   
} SDException;


/* PUBLIC FUNCTIONS ***********************************************************/

extern SDService *SD_getService(const char *serviceName, SDException *exception);


extern SDServiceDetails *SD_getServiceDetails(const char *serviceName, SDException *exception);


extern SDServiceDataList *SD_getServiceData(const char *serviceName, SDException *exception);


extern char *SD_getServiceDataItem(const char *serviceName, const char *key, SDException *exception);


extern char *SD_getServiceSite(const char *serviceName, SDException *exception);


extern char *SD_getServiceWSDL(const char *serviceName, SDException *exception);


extern SDServiceList *SD_listAssociatedServices(const char *serviceName, const char *type, const char *site, const SDVOList *vos, SDException *exception);


extern SDServiceList *SD_listServices(const char *type, const char *site, const SDVOList *vos, SDException *exception);


extern SDServiceList *SD_listServicesByData(const SDServiceDataList *data, const char *type, const char *site, const SDVOList *vos, SDException *exception);



extern SDServiceList *SD_listServicesByHost(const char *type, const char *host, const SDVOList *vos, SDException *exception);

extern void SD_freeServiceDataList(SDServiceDataList *serviceDataList);


extern void SD_freeService(SDService *service);


extern void SD_freeServiceList(SDServiceList *serviceList);


extern void SD_freeServiceDetails(SDServiceDetails *serviceDetails);


extern void SD_freeException(SDException *exception);


#ifdef __cplusplus
}
#endif

#endif /* SERVICE_DISCOVERY_H */

---