EGEE

org.glite.data.transfer.fts.FileTransfer


Functions

char * glite_fts_submit (glite_transfer_ctx *ctx, const glite_transfer_TransferJob *job)
 Submit a FileTransfer job.
char * glite_fts_transferSubmit (glite_transfer_ctx *ctx, const glite_transfer_TransferJob *job, int withDelegation, int withChecksums)
 Submit a FileTransfer job with optional checskum information.
char * glite_fts_placementSubmit (glite_transfer_ctx *ctx, const glite_transfer_PlacementJob *job, int withDelegation)
 Submit a FilePlacement job.
glite_transfer_JobStatus ** glite_fts_listRequests (glite_transfer_ctx *ctx, int numStates, const char *const states[], const char *channelName, int *resultCount)
 Get a list of jobIDs matching the given states on the given channel.
glite_transfer_JobStatus ** glite_fts_listRequests2 (glite_transfer_ctx *ctx, int numStates, const char *const states[], const char *channelName, const char *restrict_dn, const char *restrict_vo, int *resultCount)
 Get a list of jobIDs matching the given states on the given channel.
glite_transfer_FileTransferStatus ** glite_fts_getFileStatus (glite_transfer_ctx *ctx, const char *requestId, int offset, int limit, int *resultCount)
 Get the statuses of all the files with the given requestID.
glite_transfer_JobStatusglite_fts_getTransferJobStatus (glite_transfer_ctx *ctx, const char *requestId)
 Get the summary state for the whole job.
glite_transfer_TransferJobSummaryglite_fts_getTransferJobSummary (glite_transfer_ctx *ctx, const char *requestId)
 Get a summary status of the job.
glite_transfer_TransferJobSummary2glite_fts_getTransferJobSummary2 (glite_transfer_ctx *ctx, const char *requestId)
int glite_fts_cancel (glite_transfer_ctx *ctx, int nitems, const char **requestIds)
 Attempt to cancel the given job on the service.
int glite_fts_addVOManager (glite_transfer_ctx *ctx, const char *VOname, const char *principal)
 Add a manager to the given VO.
int glite_fts_removeVOManager (glite_transfer_ctx *ctx, const char *VOname, const char *principal)
 Remove a manager from the given VO.
char ** glite_fts_listVOManagers (glite_transfer_ctx *ctx, const char *VOname, int *resultcount)
 Lists managers of a given VO.
glite_transfer_Rolesglite_fts_getRoles (glite_transfer_ctx *ctx)
 Get roles of the client on this service.
glite_transfer_Rolesglite_fts_getRolesOf (glite_transfer_ctx *ctx, const char *otherDN)
 Get roles of the specified user on this service.
int glite_fts_setJobPriority (glite_transfer_ctx *ctx, const char *requestID, const int priority)
 Set priority of a job.

Function Documentation

int glite_fts_addVOManager ( glite_transfer_ctx ctx,
const char *  VOname,
const char *  principal 
)

Add a manager to the given VO.

Parameters:
ctx The transfer context.
VOname The name of the VO.
principal The principal to add.
Returns:
0 when successful and -1 in case of an error.

int glite_fts_cancel ( glite_transfer_ctx ctx,
int  nitems,
const char **  requestIds 
)

Attempt to cancel the given job on the service.

The only semantics defined are 'best effort':

glite_transfer_FileTransferStatus** glite_fts_getFileStatus ( glite_transfer_ctx ctx,
const char *  requestId,
int  offset,
int  limit,
int *  resultCount 
)

Get the statuses of all the files with the given requestID.

Parameters:
ctx The transfer context.
requestId The ID of the request.
offset Number of results to skip.
limit Number of results to return.
resultCount Number of items in the result array.
Returns:
Array of file transfer status objects, or NULL in case of an error.

glite_transfer_Roles* glite_fts_getRoles ( glite_transfer_ctx ctx  ) 

Get roles of the client on this service.

Parameters:
ctx The transfer context.
Returns:
Roles object.

glite_transfer_Roles* glite_fts_getRolesOf ( glite_transfer_ctx ctx,
const char *  otherDN 
)

Get roles of the specified user on this service.

Parameters:
ctx The transfer context.
Returns:
Roles object.

glite_transfer_JobStatus* glite_fts_getTransferJobStatus ( glite_transfer_ctx ctx,
const char *  requestId 
)

Get the summary state for the whole job.

Possible answers: SUBMITTED, PENDING, ACTIVE, CANCELLING, CANCELLED, DONE, FINISHED, TRANSFERFAILED.

Parameters:
ctx The transfer context.
requestId The ID of the request.
Returns:
The job status.

glite_transfer_TransferJobSummary* glite_fts_getTransferJobSummary ( glite_transfer_ctx ctx,
const char *  requestId 
)

Get a summary status of the job.

Including the job state and some summary statistics.

Parameters:
ctx The transfer context.
requestId The ID of the request.
Returns:
An object containing the status informations.

glite_transfer_TransferJobSummary2* glite_fts_getTransferJobSummary2 ( glite_transfer_ctx ctx,
const char *  requestId 
)

glite_transfer_JobStatus** glite_fts_listRequests ( glite_transfer_ctx ctx,
int  numStates,
const char *const   states[],
const char *  channelName,
int *  resultCount 
)

Get a list of jobIDs matching the given states on the given channel.

Parameters:
ctx The transfer context.
numStates The number of items in the states array.
states Array of states we are interested in.
channelName The name of the channel.
resultCount [OUT] The number of items in the result array.
Returns:
An array of jobIDs.

glite_transfer_JobStatus** glite_fts_listRequests2 ( glite_transfer_ctx ctx,
int  numStates,
const char *const   states[],
const char *  channelName,
const char *  restrict_dn,
const char *  restrict_vo,
int *  resultCount 
)

Get a list of jobIDs matching the given states on the given channel.

Parameters:
ctx The transfer context.
numStates The number of items in the states array.
states Array of states we are interested in.
channelName The name of the channel.
restrict_dn Restrict to this DN
restrict_vo Restrict to this VO
resultCount [OUT] The number of items in the result array.
Returns:
An array of jobIDs.

char** glite_fts_listVOManagers ( glite_transfer_ctx ctx,
const char *  VOname,
int *  resultcount 
)

Lists managers of a given VO.

Parameters:
ctx The transfer context.
VOname The name of the VO.
resultcount [OUT] Number of returned items.
Returns:
Array of managers, or NULL in case of an error.

char* glite_fts_placementSubmit ( glite_transfer_ctx ctx,
const glite_transfer_PlacementJob job,
int  withDelegation 
)

Submit a FilePlacement job.

Parameters:
ctx The transfer context.
job The object containing all the informations related to the job.
Returns:
The requestID, or NULL in case of an error.

int glite_fts_removeVOManager ( glite_transfer_ctx ctx,
const char *  VOname,
const char *  principal 
)

Remove a manager from the given VO.

Parameters:
ctx The transfer context.
VOname The name of the VO.
principal The principal to add.
Returns:
0 when successful and -1 in case of an error.

int glite_fts_setJobPriority ( glite_transfer_ctx ctx,
const char *  requestID,
const int  priority 
)

Set priority of a job.

Parameters:
ctx The transfer context.
requestID ID of the transfer job.
priority The new priority of the job.
Returns:
Roles object.

char* glite_fts_submit ( glite_transfer_ctx ctx,
const glite_transfer_TransferJob job 
)

Submit a FileTransfer job.

This funcion is for backward compatibility here, so clients with a version number can use services with smaller version number. Only the minor and patch versions can differ!

Parameters:
ctx The transfer context.
job The object containing all the informations related to the job.
Returns:
The requestID, or NULL in case of an error.

char* glite_fts_transferSubmit ( glite_transfer_ctx ctx,
const glite_transfer_TransferJob job,
int  withDelegation,
int  withChecksums 
)

Submit a FileTransfer job with optional checskum information.

Parameters:
ctx The transfer context.
job The object containing all the informations related to the job.
withDelegation If the job should use delegated credentials.
withChecksums If the job has checksum specified by the client.
Returns:
The requestID, or NULL in case of an error.

The GLite Project. All rights reserved.