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

fts-simple.h

Go to the documentation of this file.
00001 
00022 #ifndef GLITE_DATA_TRANSFER_FTS_SIMPLE_H
00023 #define GLITE_DATA_TRANSFER_FTS_SIMPLE_H
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 #include <glite/data/transfer/c/transfer-simple.h>
00030 
00031 /**********************************************************************
00032  * Constants
00033  */
00034 
00035 /* SURL generation pattern types */
00036 typedef enum
00037 {
00038     GLITE_FTS_SURL_LFN,
00039     GLITE_FTS_SURL_DAY,
00040     GLITE_FTS_SURL_HOUR,
00041     GLITE_FTS_SURL_FLAT
00042 } glite_fts_surl_pattern;
00043 
00044 /* Default SURL generation pattern */
00045 #define GLITE_FTS_SURL_DEFAULT      GLITE_FTS_SURL_LFN
00046 
00047 /* Job parameter key for gridftp */
00048 #define GLITE_FTS_PARAM_GRIDFTP     "gridftp"
00049 
00050 /* Job parameter key for MyProxy */
00051 #define GLITE_FTS_PARAM_MYPROXY     "myproxy"
00052 
00053 /* Job parameter key for DelegationID */
00054 #define GLITE_FTS_PARAM_DELEGATIONID    "delegationid"
00055 
00056 /* Job parameter for storageClass */
00057 #define GLITE_FTS_PARAM_SPACETOKEN   "spacetoken"
00058 #define GLITE_FTS_PARAM_SPACETOKEN_SOURCE   "source_spacetoken"
00059 
00060 #define GLITE_FTS_PARAM_COPY_PIN_LIFETIME "copy_pin_lifetime"
00061 #define GLITE_FTS_PARAM_LAN_CONNECTION "lan_connection"
00062 #define GLITE_FTS_PARAM_FAIL_NEARLINE "fail_nearline"
00063 
00064 /* SRM 2.2 overwrite flag */
00065 #define GLITE_FTS_PARAM_OVERWRITEFLAG   "overwrite"
00066 
00067 /* Service Discovery parameter keys */
00068 #define GLITE_FTS_SD_PATTERN        "surl_pattern"
00069 #define GLITE_FTS_SD_SURL_PREFIX    "surl_prefix"
00070 #define GLITE_FTS_SD_SRM_ENDPOINT   "srm_endpoint"
00071 
00072 /* Service type for Service Discovery */
00073 #define GLITE_FTS_SD_TYPE       "org.glite.FileTransfer"
00074 
00075 /* Service type of Channel Agent for Service Discovery */
00076 #define GLITE_CA_SD_TYPE        "org.glite.ChannelAgent"
00077 
00078 /* Environment variable to override default service type */
00079 #define GLITE_FTS_SD_ENV        "GLITE_SD_FTS_TYPE"
00080 
00081 
00082 /**********************************************************************
00083  * General guidelines:
00084  * - Functions that return a pointer return NULL when there is an error.
00085  * - Functions that return 'int' return 0 when successful and -1 in case
00086  *   of an error.
00087  * - Any objects returned by a function is owned by the caller and has to
00088  *   be deallocated by the caller.
00089  */
00090 
00091 /**********************************************************************
00092  * Function prototypes - library management functions
00093  */
00094 
00095 /* Return the current FileTransfer endpoint used by the transfer context */
00096 const char *glite_fts_get_endpoint(glite_transfer_ctx *ctx);
00097 
00098 #if 0 /* These need more research */
00099 char *glite_fts_generate_surl(glite_transfer_ctx *ctx, const char *src);
00100 
00101 int glite_fts_set_srm_endpoint(glite_transfer_ctx *ctx, const char *uri);
00102 
00103 int glite_fts_set_surl_prefix(glite_transfer_ctx *ctx, const char *prefix);
00104 
00105 int glite_fts_set_surl_pattern(glite_transfer_ctx *ctx,
00106     glite_fts_surl_pattern pattern);
00107 #endif 
00108 
00109 /**********************************************************************
00110  * Function prototypes - org.glite.data.transfer.ServiceBase
00111  */
00112 
00123 char *glite_fts_getVersion(glite_transfer_ctx *ctx);
00124 
00130 char *glite_fts_getSchemaVersion(glite_transfer_ctx *ctx);
00131 
00137 char *glite_fts_getInterfaceVersion(glite_transfer_ctx *ctx);
00138 
00145 char *glite_fts_getServiceMetadata(glite_transfer_ctx *ctx, const char *key);
00146 
00151 /**********************************************************************
00152  * Function prototypes - org.glite.data.transfer.fts.FileTransfer
00153  */
00154 
00169 char *glite_fts_submit(glite_transfer_ctx *ctx,
00170     const glite_transfer_TransferJob *job);
00171 
00178 char *glite_fts_transferSubmit(glite_transfer_ctx *ctx,
00179     const glite_transfer_TransferJob *job, int withDelegation);
00180 
00187 char *glite_fts_placementSubmit(glite_transfer_ctx *ctx,
00188     const glite_transfer_PlacementJob *job, int withDelegation);
00189 
00199 glite_transfer_JobStatus **glite_fts_listRequests(glite_transfer_ctx *ctx,
00200     int numStates, const char * const states[], const char *channelName,
00201     int *resultCount);
00202 
00214 glite_transfer_JobStatus **glite_fts_listRequests2(glite_transfer_ctx *ctx,
00215     int numStates, const char * const states[], const char *channelName,
00216    const char* restrict_dn, const char* restrict_vo,
00217     int *resultCount);
00218 
00228 glite_transfer_FileTransferStatus **glite_fts_getFileStatus(glite_transfer_ctx *ctx,
00229     const char *requestId, int offset, int limit, int *resultCount);
00230 
00237 glite_transfer_JobStatus *glite_fts_getTransferJobStatus(glite_transfer_ctx *ctx,
00238     const char *requestId);
00239 
00246 glite_transfer_TransferJobSummary *glite_fts_getTransferJobSummary(glite_transfer_ctx *ctx,
00247     const char *requestId);
00248 glite_transfer_TransferJobSummary2 *glite_fts_getTransferJobSummary2(glite_transfer_ctx *ctx,
00249     const char *requestId);
00250 
00251 
00263 int glite_fts_cancel(glite_transfer_ctx *ctx, int nitems, const char **requestIds);
00264 
00272 int glite_fts_addVOManager(glite_transfer_ctx *ctx, const char *VOname,
00273         const char *principal);
00274 
00282 int glite_fts_removeVOManager(glite_transfer_ctx *ctx, const char *VOname,
00283         const char *principal);
00284 
00292 char **glite_fts_listVOManagers(glite_transfer_ctx *ctx, const char *VOname,
00293         int *resultcount);
00294 
00300 glite_transfer_Roles *glite_fts_getRoles(glite_transfer_ctx *ctx);
00301 
00307 glite_transfer_Roles *glite_fts_getRolesOf(glite_transfer_ctx *ctx, const char *otherDN);
00308 
00316 int glite_fts_setJobPriority(glite_transfer_ctx *ctx,
00317         const char *requestID, const int priority);
00318 
00323 #ifdef __cplusplus
00324 }
00325 #endif
00326 
00327 #endif /* GLITE_DATA_TRANSFER_FTS_SIMPLE_H */
The GLite Project. All rights reserved.