|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileTransfer
The service interface of the File Transfer component. It exposes all the required functionality to submit, manage and query transfer jobs, each containing one or many file transfers.
Method Summary | |
---|---|
void |
addVOManager(java.lang.String VOName,
java.lang.String principal)
Adds a manager to the given VO. |
void |
cancel(java.lang.String[] requestIDs)
Attempt to cancel the given jobs on the service. |
FileTransferStatus[] |
getFileStatus(java.lang.String requestID,
int offset,
int limit)
Return the statuses of all the files with the given requestID. |
FileTransferStatus2[] |
getFileStatus2(java.lang.String requestID,
int offset,
int limit)
Return the statuses of all the files with the given requestID. |
Roles |
getRoles()
Returns the roles of the client on this service. |
Roles |
getRolesOf(java.lang.String otherDN)
Returns the roles of the client on this service. |
JobStatus |
getTransferJobStatus(java.lang.String requestID)
Get the summary state for the whole job. |
TransferJobSummary |
getTransferJobSummary(java.lang.String requestID)
Returns a summary status of the job. |
TransferJobSummary2 |
getTransferJobSummary2(java.lang.String requestID)
Returns the extended summary status of the job. |
JobStatus[] |
listRequests(java.lang.String[] inGivenStates,
java.lang.String channelName)
Return a list of jobIDs matching the given states on the given channel. |
JobStatus[] |
listRequests2(java.lang.String[] inGivenStates,
java.lang.String channelName,
java.lang.String forDN,
java.lang.String forVO)
Return a list of jobIDs matching the given states on the given channel. |
java.lang.String[] |
listVOManagers(java.lang.String VOName)
Lists managers of a given VO |
java.lang.String |
placementSubmit(PlacementJob job)
Submits the placement job to the service. |
java.lang.String |
placementSubmit2(PlacementJob job)
The same as placementSubmit except that it expects a delegation to have been made before. |
void |
removeVOManager(java.lang.String VOName,
java.lang.String principal)
Removes a manager from the given VO. |
void |
setJobPriority(java.lang.String requestID,
int priority)
Update the priority of the job in the queue. |
java.lang.String |
submit(TransferJob job)
Deprecated. Renamed transferSubmit(TransferJob) . Placement (logical) jobs should go through the placementSubmit(PlacementJob) method.
Semantic description of the method: The following steps are performed for each entry:
|
java.lang.String |
transferSubmit(TransferJob job)
Submits the transfer job to the service. |
java.lang.String |
transferSubmit2(TransferJob job)
The same as transferSubmit except that it expects a delegation to have been made before. |
Methods inherited from interface org.glite.data.transfer.ServiceBase |
---|
getInterfaceVersion, getSchemaVersion, getServiceMetadata, getVersion |
Method Detail |
---|
java.lang.String placementSubmit(PlacementJob job) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
job
- The description of the files to transfer.
InvalidArgumentException
- in the case of job being malformed.
AuthorizationException
- in the case of the user not being authorized to submit a job.
InternalException
- in the case of internal server errors (like the database being offline)
ServiceBusyException
- in the case of the service being temporarily unable to handle the request (queue full, being drained).
AuthorizationException
.
InvalidArgumentException
ServiceBusyException
java.lang.String placementSubmit2(PlacementJob job) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
InvalidArgumentException
AuthorizationException
ServiceBusyException
InternalException
java.lang.String transferSubmit(TransferJob job) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
job
- The description of the files to transfer.
InvalidArgumentException
- in the case of job being malformed.
AuthorizationException
- in the case of the user not being authorized to submit a job.
InternalException
- in the case of internal server errors (like the database being offline)
ServiceBusyException
- in the case of the service being temporarily unable to handle the request (queue full, being drained).
AuthorizationException
.
InvalidArgumentException
ServiceBusyException
java.lang.String transferSubmit2(TransferJob job) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
InvalidArgumentException
AuthorizationException
ServiceBusyException
InternalException
java.lang.String submit(TransferJob job) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
transferSubmit(TransferJob)
. Placement (logical) jobs should go through the placementSubmit(PlacementJob)
method.
AuthorizationException
.
InvalidArgumentException
ServiceBusyException
job
- The description of the files to transfer.
InvalidArgumentException
- in the case of job being malformed.
AuthorizationException
- in the case of the user not being authorized to submit a job.
InternalException
- in the case of internal server errors (like the database being offline)
ServiceBusyException
- in the case of the service being temporarily unable to handle the request (queue full, being drained).JobStatus[] listRequests(java.lang.String[] inGivenStates, java.lang.String channelName) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
inGivenStates
- states to matchchannelName
- the channel name to match, if null, empty, or 'any', any channel will be matched.
InvalidArgumentException
- in the case of an unknow state request
AuthorizationException
- in the case of the user not being authorized to request the state.
InternalException
- in the case of internal server errors (like the database being offline)
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.JobStatus
JobStatus[] listRequests2(java.lang.String[] inGivenStates, java.lang.String channelName, java.lang.String forDN, java.lang.String forVO) throws InvalidArgumentException, AuthorizationException, ServiceBusyException, InternalException
inGivenStates
- states to matchchannelName
- the channel name to match, if null, empty, or 'any', any channel will be matched.forDN
- restrict to this DNforVO
- restrict to this VO
InvalidArgumentException
- in the case of an unknow state request
AuthorizationException
- in the case of the user not being authorized to request the state.
InternalException
- in the case of internal server errors (like the database being offline)
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.JobStatus
FileTransferStatus[] getFileStatus(java.lang.String requestID, int offset, int limit) throws NotExistsException, ServiceBusyException, InternalException, AuthorizationException
requestID
- The requestID to obtain an Iterator over.offset
- the offset from the first file to returnlimit
- the number of files to return
NotExistsException
- in the case of unknown requestID.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.
AuthorizationException
- in the case of unauthorized use.
InternalException
- in the case of the service not being available for some internal reason.FileTransferStatus
FileTransferStatus2[] getFileStatus2(java.lang.String requestID, int offset, int limit) throws NotExistsException, ServiceBusyException, InternalException, AuthorizationException
requestID
- The requestID to obtain an Iterator over.offset
- the offset from the first file to returnlimit
- the number of files to return
NotExistsException
- in the case of unknown requestID.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.
AuthorizationException
- in the case of unauthorized use.
InternalException
- in the case of the service not being available for some internal reason.FileTransferStatus2
JobStatus getTransferJobStatus(java.lang.String requestID) throws NotExistsException, InternalException, AuthorizationException, ServiceBusyException
requestID
- The job request ID.
NotExistsException
- in the case of unknown requestID.
AuthorizationException
- in the case of unauthorized use.
InternalException
- in the case of the service not being available for some internal reason.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.-
Semantic description of the method:
The following steps are performed for each entry:
- Check if the user is authorized to query the job;
if permission is not granted, throws {@link org.glite.data.transfer.AuthorizationException}.
- Checks if TransferJob ID is there;
if it is not, throws {@link org.glite.data.transfer.NotExistsException}
- Query the job state, return state.
TransferJobSummary getTransferJobSummary(java.lang.String requestID) throws NotExistsException, InternalException, AuthorizationException, ServiceBusyException
requestID
- The job request ID.
NotExistsException
- in the case of unknown requestID.
AuthorizationException
- in the case of unauthorized use.
InternalException
- in the case of the service not being available for some internal reason.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.-
Semantic description of the method:
The following steps are performed for each entry:
- Check if the user is authorized to query the job;
if permission is not granted, throws {@link org.glite.data.transfer.AuthorizationException}.
- Checks if TransferJob ID is there;
if it is not, throws {@link org.glite.data.transfer.NotExistsException}
- Query the job, return summary.
TransferJobSummary2 getTransferJobSummary2(java.lang.String requestID) throws NotExistsException, InternalException, AuthorizationException, ServiceBusyException
requestID
- The job request ID.
NotExistsException
- in the case of unknown requestID.
AuthorizationException
- in the case of unauthorized use.
InternalException
- in the case of the service not being available for some internal reason.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.-
Semantic description of the method:
The following steps are performed for each entry:
- Check if the user is authorized to query the job;
if permission is not granted, throws {@link org.glite.data.transfer.AuthorizationException}.
- Checks if TransferJob ID is there;
if it is not, throws {@link org.glite.data.transfer.NotExistsException}
- Query the job, return summary.
void cancel(java.lang.String[] requestIDs) throws NotExistsException, InternalException, AuthorizationException, ServiceBusyException, CannotCancelException
requestIDs
- The job request IDs.
NotExistsException
- in the case of unknown requestID.
AuthorizationException
- in the case of unauthorized use.
CannotCancelException
- in the case of the job state being not cancellable.
InternalException
- in the case of the service not being available for some internal reason.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.
AuthorizationException
.
NotExistsException
void setJobPriority(java.lang.String requestID, int priority) throws AuthorizationException, NotExistsException, InvalidArgumentException, ServiceBusyException, InternalException
requestID
- The id of the job to set the prioritypriority
- The new priority for the job (value between 0 and 5)
NotExistsException
- in the case of unknown requestID.
AuthorizationException
- in the case of unauthorized use.
InvalidArgumentException
- in the case of an invalid priority being given.
InternalException
- in the case of the service not being available for some internal reason.
ServiceBusyException
- in the case of the service being temporarily unable to handle the request.void addVOManager(java.lang.String VOName, java.lang.String principal) throws AuthorizationException, InvalidArgumentException, NotExistsException, ExistsException, InternalException
VOName
- the name of the vo on which to add the managerprincipal
- the principal to be added as a manager
AuthorizationException
InvalidArgumentException
NotExistsException
ExistsException
InternalException
void removeVOManager(java.lang.String VOName, java.lang.String principal) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
VOName
- the name of the vo from which to remove the managerprincipal
- the principal to be removed
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
java.lang.String[] listVOManagers(java.lang.String VOName) throws AuthorizationException, InvalidArgumentException, NotExistsException, InternalException
VOName
- the name of the vo for which to list managers
AuthorizationException
InvalidArgumentException
NotExistsException
InternalException
Roles getRoles() throws AuthorizationException, InternalException
AuthorizationException
InternalException
Roles getRolesOf(java.lang.String otherDN) throws AuthorizationException, InternalException
otherDN
- the DN to check the roles for
AuthorizationException
InternalException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |