EGEE
Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

fts-simple.h

Go to the documentation of this file.
00001 /*
00002  *  Copyright (c) Members of the EGEE Collaboration. 2005.
00003  *  See http://eu-egee.org/partners/ for details on the copyright holders.
00004  *  For license conditions see the license file or http://eu-egee.org/license.html
00005  *
00006  *  GLite Data Management - Simple file fts API
00007  *
00008  *  Authors: Gabor Gombas <Gabor.Gombas@cern.ch>
00009  *           Zoltan Farkas <Zoltan.Farkas@cern.ch>
00010  *
00011  */
00012 
00013 #ifndef GLITE_DATA_TRANSFER_FTS_SIMPLE_H
00014 #define GLITE_DATA_TRANSFER_FTS_SIMPLE_H
00015 
00016 #ifdef __cplusplus
00017 extern "C" {
00018 #endif
00019 
00020 #include <glite/data/transfer/c/transfer-simple.h>
00021 
00022 /**********************************************************************
00023  * Constants
00024  */
00025 
00026 /* SURL generation pattern types */
00027 typedef enum
00028 {
00029     GLITE_FTS_SURL_LFN,
00030     GLITE_FTS_SURL_DAY,
00031     GLITE_FTS_SURL_HOUR,
00032     GLITE_FTS_SURL_FLAT
00033 } glite_fts_surl_pattern;
00034 
00035 /* Default SURL generation pattern */
00036 #define GLITE_FTS_SURL_DEFAULT      GLITE_FTS_SURL_LFN
00037 
00038 /* Job parameter key for gridftp */
00039 #define GLITE_FTS_PARAM_GRIDFTP     "gridftp"
00040 
00041 /* Job parameter key for MyProxy */
00042 #define GLITE_FTS_PARAM_MYPROXY     "myproxy"
00043 
00044 /* Job parameter key for DelegationID */
00045 #define GLITE_FTS_PARAM_DELEGATIONID    "delegationid"
00046 
00047 /* Job parameter for storageClass */
00048 #define GLITE_FTS_PARAM_SPACETOKEN   "spacetoken"
00049 
00050 /* SRM 2.2 overwrite flag */
00051 #define GLITE_FTS_PARAM_OVERWRITEFLAG   "overwrite"
00052 
00053 /* Service Discovery parameter keys */
00054 #define GLITE_FTS_SD_PATTERN        "surl_pattern"
00055 #define GLITE_FTS_SD_SURL_PREFIX    "surl_prefix"
00056 #define GLITE_FTS_SD_SRM_ENDPOINT   "srm_endpoint"
00057 
00058 /* Service type for Service Discovery */
00059 #define GLITE_FTS_SD_TYPE       "org.glite.FileTransfer"
00060 
00061 /* Service type of Channel Agent for Service Discovery */
00062 #define GLITE_CA_SD_TYPE        "org.glite.ChannelAgent"
00063 
00064 /* Environment variable to override default service type */
00065 #define GLITE_FTS_SD_ENV        "GLITE_SD_FTS_TYPE"
00066 
00067 
00068 /**********************************************************************
00069  * General guidelines:
00070  * - Functions that return a pointer return NULL when there is an error.
00071  * - Functions that return 'int' return 0 when successful and -1 in case
00072  *   of an error.
00073  * - Any objects returned by a function is owned by the caller and has to
00074  *   be deallocated by the caller.
00075  */
00076 
00077 /**********************************************************************
00078  * Function prototypes - library management functions
00079  */
00080 
00081 /* Return the current FileTransfer endpoint used by the transfer context */
00082 const char *glite_fts_get_endpoint(glite_transfer_ctx *ctx);
00083 
00084 #if 0 /* These need more research */
00085 char *glite_fts_generate_surl(glite_transfer_ctx *ctx, const char *src);
00086 
00087 int glite_fts_set_srm_endpoint(glite_transfer_ctx *ctx, const char *uri);
00088 
00089 int glite_fts_set_surl_prefix(glite_transfer_ctx *ctx, const char *prefix);
00090 
00091 int glite_fts_set_surl_pattern(glite_transfer_ctx *ctx,
00092     glite_fts_surl_pattern pattern);
00093 #endif 
00094 
00095 /**********************************************************************
00096  * Function prototypes - org.glite.data.transfer.ServiceBase
00097  */
00098 
00111 char *glite_fts_getVersion(glite_transfer_ctx *ctx);
00112 
00120 char *glite_fts_getSchemaVersion(glite_transfer_ctx *ctx);
00121 
00129 char *glite_fts_getInterfaceVersion(glite_transfer_ctx *ctx);
00130 
00139 char *glite_fts_getServiceMetadata(glite_transfer_ctx *ctx, const char *key);
00140 
00145 /**********************************************************************
00146  * Function prototypes - org.glite.data.transfer.fts.FileTransfer
00147  */
00148 
00165 char *glite_fts_submit(glite_transfer_ctx *ctx,
00166     const glite_transfer_TransferJob *job);
00167 
00176 char *glite_fts_transferSubmit(glite_transfer_ctx *ctx,
00177     const glite_transfer_TransferJob *job, int withDelegation);
00178 
00187 char *glite_fts_placementSubmit(glite_transfer_ctx *ctx,
00188     const glite_transfer_PlacementJob *job, int withDelegation);
00189 
00201 glite_transfer_JobStatus **glite_fts_listRequests(glite_transfer_ctx *ctx,
00202     int numStates, const char * const states[], const char *channelName,
00203     int *resultCount);
00204 
00218 glite_transfer_JobStatus **glite_fts_listRequests2(glite_transfer_ctx *ctx,
00219     int numStates, const char * const states[], const char *channelName,
00220    const char* restrict_dn, const char* restrict_vo,
00221     int *resultCount);
00222 
00234 glite_transfer_FileTransferStatus **glite_fts_getFileStatus(glite_transfer_ctx *ctx,
00235     const char *requestId, int offset, int limit, int *resultCount);
00236 
00245 glite_transfer_JobStatus *glite_fts_getTransferJobStatus(glite_transfer_ctx *ctx,
00246     const char *requestId);
00247 
00256 glite_transfer_TransferJobSummary *glite_fts_getTransferJobSummary(glite_transfer_ctx *ctx,
00257     const char *requestId);
00258 glite_transfer_TransferJobSummary2 *glite_fts_getTransferJobSummary2(glite_transfer_ctx *ctx,
00259     const char *requestId);
00260 
00261 
00276 int glite_fts_cancel(glite_transfer_ctx *ctx, int nitems, const char **requestIds);
00277 
00287 int glite_fts_addVOManager(glite_transfer_ctx *ctx, const char *VOname,
00288         const char *principal);
00289 
00299 int glite_fts_removeVOManager(glite_transfer_ctx *ctx, const char *VOname,
00300         const char *principal);
00301 
00311 char **glite_fts_listVOManagers(glite_transfer_ctx *ctx, const char *VOname,
00312         int *resultcount);
00313 
00321 glite_transfer_Roles *glite_fts_getRoles(glite_transfer_ctx *ctx);
00322 
00330 glite_transfer_Roles *glite_fts_getRolesOf(glite_transfer_ctx *ctx, const char *otherDN);
00331 
00341 int glite_fts_setJobPriority(glite_transfer_ctx *ctx,
00342         const char *requestID, const int priority);
00343 
00348 #ifdef __cplusplus
00349 }
00350 #endif
00351 
00352 #endif /* GLITE_DATA_TRANSFER_FTS_SIMPLE_H */
The GLite Project. All rights reserved.