Skip to content
Snippets Groups Projects
Commit 695a75f7 authored by Daniele Kruse's avatar Daniele Kruse
Browse files

Added some comments to scheduler functions regarding exceptions that might be thrown

parent 713acef7
No related branches found
No related tags found
No related merge requests found
......@@ -74,42 +74,49 @@ public:
/**
* Queue an archive request and return the CTA file ID.
* Throws a UserError exception in case of wrong request parameters (ex. no route to tape)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual uint64_t queueArchive(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::ArchiveRequest &request);
/**
* Queue a retrieve request.
* Throws a UserError exception in case of wrong request parameters (ex. unknown file id)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual void queueRetrieve(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::RetrieveRequest &request);
/**
* Delete an archived file or a file which is in the process of being archived.
* Throws a UserError exception in case of wrong request parameters (ex. unknown file id)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual void deleteArchive(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::DeleteArchiveRequest &request);
/**
* Cancel an ongoing retrieval.
* Throws a UserError exception in case of wrong request parameters (ex. file not being retrieved)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual void cancelRetrieve(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::CancelRetrieveRequest &request);
/**
* Update the file information of an archived file.
* Throws a UserError exception in case of wrong request parameters (ex. unknown file id)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual void updateFileInfo(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::UpdateFileInfoRequest &request);
/**
* Update the storage class of an archived file.
* Throws a UserError exception in case of wrong request parameters (ex. unknown storage class)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual void updateFileStorageClass(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::UpdateFileStorageClassRequest &request);
/**
* List the storage classes that a specific user is allowed to use (the ones belonging to the instance from where
* the command was issued)
* Throws a (Non)RetryableError exception in case something else goes wrong with the request
*/
virtual std::list<cta::common::dataStructures::StorageClass> listStorageClass(const cta::common::dataStructures::SecurityIdentity &cliIdentity, const cta::common::dataStructures::ListStorageClassRequest &request);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment