Catalogue.hpp 23.6 KB
Newer Older
1
/*
2
3
 * The CERN Tape Archive(CTA) project
 * Copyright(C) 2015  CERN
4
5
6
7
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
8
 *(at your option) any later version.
9
10
11
12
13
14
15
16
17
18
19
20
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

21
#include "catalogue/ArchiveFileDoesNotExist.hpp"
22
#include "catalogue/ArchiveFileItor.hpp"
23
#include "catalogue/TapeFileSearchCriteria.hpp"
24
25
#include "catalogue/TapeFileWritten.hpp"
#include "catalogue/TapeForWriting.hpp"
26
#include "catalogue/TapeSearchCriteria.hpp"
27
28
29
#include "common/dataStructures/AdminHost.hpp"
#include "common/dataStructures/AdminUser.hpp"
#include "common/dataStructures/ArchiveFile.hpp"
Steven Murray's avatar
Steven Murray committed
30
#include "common/dataStructures/ArchiveFileQueueCriteria.hpp"
31
#include "common/dataStructures/ArchiveFileSummary.hpp"
32
33
34
#include "common/dataStructures/ArchiveJob.hpp"
#include "common/dataStructures/ArchiveRoute.hpp"
#include "common/dataStructures/CancelRetrieveRequest.hpp"
35
#include "common/dataStructures/DiskFileInfo.hpp"
Daniele Kruse's avatar
Daniele Kruse committed
36
#include "common/dataStructures/DriveState.hpp"
37
38
39
40
#include "common/dataStructures/EntryLog.hpp"
#include "common/dataStructures/ListStorageClassRequest.hpp"
#include "common/dataStructures/LogicalLibrary.hpp"
#include "common/dataStructures/MountType.hpp"
41
#include "common/dataStructures/MountPolicy.hpp"
42
43
44
#include "common/dataStructures/ReadTestResult.hpp"
#include "common/dataStructures/RepackInfo.hpp"
#include "common/dataStructures/RepackType.hpp"
45
46
#include "common/dataStructures/RequesterGroupMountRule.hpp"
#include "common/dataStructures/RequesterMountRule.hpp"
47
#include "common/dataStructures/RetrieveFileQueueCriteria.hpp"
48
49
50
51
52
#include "common/dataStructures/RetrieveJob.hpp"
#include "common/dataStructures/RetrieveRequest.hpp"
#include "common/dataStructures/SecurityIdentity.hpp"
#include "common/dataStructures/StorageClass.hpp"
#include "common/dataStructures/Tape.hpp"
53
#include "common/dataStructures/TapeCopyToPoolMap.hpp"
54
#include "common/dataStructures/TapeFile.hpp"
55
56
57
58
#include "common/dataStructures/TapePool.hpp"
#include "common/dataStructures/UpdateFileInfoRequest.hpp"
#include "common/dataStructures/UserIdentity.hpp"
#include "common/dataStructures/VerifyInfo.hpp"
59
#include "common/dataStructures/VidToTapeMap.hpp"
60
#include "common/dataStructures/WriteTestResult.hpp"
61
#include "common/exception/UserError.hpp"
62
63
64

#include <list>
#include <map>
65
66
67
#include <set>
#include <stdint.h>
#include <string>
68

69
namespace cta {
70
71
72

namespace catalogue {

73
74
75
76
77
78
79
80
/**
 * Abstract class defining the interface to the CTA catalogue responsible for
 * storing crticial information about archive files, tapes and tape files.
 */
class Catalogue {
public:

  /**
81
82
   * Destructor.
   */
83
  virtual ~Catalogue() = 0;
84

85
86
87
  //////////////////////////////////////////////////////////////////
  // START OF METHODS DIRECTLY INVOLVED DATA TRANSFER AND SCHEDULING
  //////////////////////////////////////////////////////////////////
88
89
90
91
92
93
94
95
96
97

  /**
   * Notifies the catalogue that the specified tape was labelled.
   *
   * @param vid The volume identifier of the tape.
   * @param drive The name of tape drive that was used to label the tape.
   * @param lbpIsOn Set to true if Logical Block Protection (LBP) was enabled.
   */
  virtual void tapeLabelled(const std::string &vid, const std::string &drive, const bool lbpIsOn) = 0;

98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
  /**
   * Prepares the catalogue for a new archive file and returns the information
   * required to queue the associated archive request.
   *
   * @param diskInstanceName The name of the disk instance to which the
   * storage class belongs.
   * @param storageClassName The name of the storage class of the file to be
   * archived.  The storage class name is only guaranteed to be unique within
   * its disk instance.  The storage class name will be used by the Catalogue
   * to determine the destination tape pool for each tape copy.
   * @param user The user for whom the file is to be archived.  This will be
   * used by the Catalogue to determine the mount policy to be used when
   * archiving the file.
   * @return The information required to queue the associated archive request.
   */
  virtual common::dataStructures::ArchiveFileQueueCriteria prepareForNewFile(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const common::dataStructures::UserIdentity &user) = 0;

118
119
120
121
122
123
124
125
126
127
  /**
   * Returns the list of tapes that can be written to by a tape drive in the
   * specified logical library, in other words tapes that are labelled, not
   * disabled, not full and are in the specified logical library.
   *
   * @param logicalLibraryName The name of the logical library.
   */
  virtual std::list<TapeForWriting> getTapesForWriting(const std::string &logicalLibraryName) const = 0;

  /**
128
   * Notifies the catalogue that the specified files have been written to tape.
129
   *
130
   * @param events The tape file written events.
131
   */
132
  virtual void filesWrittenToTape(const std::set<TapeFileWritten> &event) = 0;
133

134
135
136
137
  /**
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to archive files.
   *
138
139
140
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for archiving files last.
   *
141
142
143
144
145
   * @param vid The volume identifier of the tape.
   * @param drive The name of the drive where the tape was mounted.
   */
  virtual void tapeMountedForArchive(const std::string &vid, const std::string &drive) = 0; // internal function (noCLI)

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
  /**
   * Prepares for a file retrieval by returning the information required to
   * queue the associated retrieve request(s).
   *
   * @param instanceName The name of the instance from where the retrieval request originated
   * @param archiveFileId The unique identifier of the archived file that is
   * to be retrieved.
   * @param user The user for whom the file is to be retrieved.  This will be
   * used by the Catalogue to determine the mount policy to be used when
   * retrieving the file.
   *
   * @return The information required to queue the associated retrieve request(s).
   */
  virtual common::dataStructures::RetrieveFileQueueCriteria prepareToRetrieveFile(
    const std::string &instanceName,
    const uint64_t archiveFileId,
    const common::dataStructures::UserIdentity &user) = 0;

164
165
166
167
  /**
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to retrieve files.
   *
168
169
170
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for retrieving files last.
   *
171
172
173
174
   * @param vid The volume identifier of the tape.
   * @param drive The name of the drive where the tape was mounted.
   */
  virtual void tapeMountedForRetrieve(const std::string &vid, const std::string &drive) = 0; // internal function (noCLI)
175
176
177
178
179
180
181
182
183
184

  /**
   * This method notifies the CTA catalogue that there is no more free space on
   * the specified tape.
   *
   * @param vid The volume identifier of the tape.
   */
  virtual void noSpaceLeftOnTape(const std::string &vid) = 0;

  ////////////////////////////////////////////////////////////////
185
  // END OF METHODS DIRECTLY INVOLVED DATA TRANSFER AND SCHEDULING
186
187
  ////////////////////////////////////////////////////////////////

Steven Murray's avatar
Steven Murray committed
188
  virtual void createAdminUser(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) = 0;
189
  virtual void deleteAdminUser(const std::string &username) = 0;
190
  virtual std::list<common::dataStructures::AdminUser> getAdminUsers() const = 0;
Steven Murray's avatar
Steven Murray committed
191
  virtual void modifyAdminUserComment(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) = 0;
192

Steven Murray's avatar
Steven Murray committed
193
  virtual void createAdminHost(const common::dataStructures::SecurityIdentity &admin, const std::string &hostName, const std::string &comment) = 0;
194
  virtual void deleteAdminHost(const std::string &hostName) = 0;
195
  virtual std::list<common::dataStructures::AdminHost> getAdminHosts() const = 0;
Steven Murray's avatar
Steven Murray committed
196
  virtual void modifyAdminHostComment(const common::dataStructures::SecurityIdentity &admin, const std::string &hostName, const std::string &comment) = 0;
197

198
199
200
  /**
   * Creates the specified storage class.
   *
Steven Murray's avatar
Steven Murray committed
201
   * @param admin The administrator.
202
203
204
   * @param storageClass The storage class.
   */
  virtual void createStorageClass(
Steven Murray's avatar
Steven Murray committed
205
    const common::dataStructures::SecurityIdentity &admin,
206
207
208
209
210
211
212
213
214
215
216
217
    const common::dataStructures::StorageClass &storageClass) = 0;

  /**
   * Deletes the specified storage class.
   *
   * @param diskInstanceName The name of the disk instance to which the
   * storage class belongs.
   * @param stoargeClassName The name of the storage class which is only
   * guaranteed to be unique within its disk isntance.
   */
  virtual void deleteStorageClass(const std::string &diskInstanceName, const std::string &storageClassName) = 0;

218
  virtual std::list<common::dataStructures::StorageClass> getStorageClasses() const = 0;
Steven Murray's avatar
Steven Murray committed
219
220
  virtual void modifyStorageClassNbCopies(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const uint64_t nbCopies) = 0;
  virtual void modifyStorageClassComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const std::string &comment) = 0;
221

Steven Murray's avatar
Steven Murray committed
222
  virtual void createTapePool(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t nbPartialTapes, const bool encryptionValue, const std::string &comment) = 0;
223
  virtual void deleteTapePool(const std::string &name) = 0;
224
  virtual std::list<common::dataStructures::TapePool> getTapePools() const = 0;
Steven Murray's avatar
Steven Murray committed
225
226
227
  virtual void modifyTapePoolNbPartialTapes(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t nbPartialTapes) = 0;
  virtual void modifyTapePoolComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) = 0;
  virtual void setTapePoolEncryption(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const bool encryptionValue) = 0;
228

229
  virtual void createArchiveRoute(
Steven Murray's avatar
Steven Murray committed
230
    const common::dataStructures::SecurityIdentity &admin,
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const uint64_t copyNb,
    const std::string &tapePoolName,
    const std::string &comment) = 0;

  /**
   * Deletes the specified archive route.
   *
   * @param diskInstanceName The name of the disk instance to which the storage
   * class belongs.
   * @param storageClassName The name of the storage class which is only
   * guaranteed to be unique within its disk instance.
   * @param copyNb The copy number of the tape file.
   */
  virtual void deleteArchiveRoute(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const uint64_t copyNb) = 0;

251
  virtual std::list<common::dataStructures::ArchiveRoute> getArchiveRoutes() const = 0;
Steven Murray's avatar
Steven Murray committed
252
253
  virtual void modifyArchiveRouteTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &tapePoolName) = 0;
  virtual void modifyArchiveRouteComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &comment) = 0;
254

Steven Murray's avatar
Steven Murray committed
255
  virtual void createLogicalLibrary(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) = 0;
256
  virtual void deleteLogicalLibrary(const std::string &name) = 0;
257
  virtual std::list<common::dataStructures::LogicalLibrary> getLogicalLibraries() const = 0;
Steven Murray's avatar
Steven Murray committed
258
  virtual void modifyLogicalLibraryComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) = 0;
259

260
  /**
261
262
   * Creates a tape which is assumed to have logical block protection (LBP)
   * enabled.
263
   */
264
  virtual void createTape(
Steven Murray's avatar
Steven Murray committed
265
    const common::dataStructures::SecurityIdentity &admin,
266
267
268
269
270
271
272
    const std::string &vid,
    const std::string &logicalLibraryName,
    const std::string &tapePoolName,
    const uint64_t capacityInBytes,
    const bool disabled,
    const bool full,
    const std::string &comment) = 0;
273
  virtual void deleteTape(const std::string &vid) = 0;
274
275
276
277
278
279
280
281
282
283

  /**
   * Returns the list of tapes that meet the specified search criteria.
   *
   * @param searchCriteria The search criteria.
   * @return The list of tapes.
   */
  virtual std::list<common::dataStructures::Tape> getTapes(
    const TapeSearchCriteria &searchCriteria = TapeSearchCriteria()) const = 0;

284
285
286
287
288
289
290
291
292
293
294
  /**
   * Returns the tapes with the specified volume identifiers.
   *
   * This method will throw an exception if it cannot find ALL of the specified
   * tapes.
   *
   * @param vids The tape volume identifiers (VIDs).
   * @return Map from tape volume identifier to tape.
   */
  virtual common::dataStructures::VidToTapeMap getTapesByVid(const std::set<std::string> &vids) const = 0;

295
296
297
298
299
300
301
302
303
304
  /**
   * Reclaims the specified tape.
   *
   * This method will throw an exception if the specified tape does not exist.
   *
   * This method will throw an exception if the specified tape is not FULL.
   *
   * This method will throw an exception if there is still at least one tape
   * file recorded in the cataligue as being on the specified tape.
   *
Steven Murray's avatar
Steven Murray committed
305
   * @param admin The administrator.
306
307
   * @param vid The volume identifier of the tape to be reclaimed.
   */
Steven Murray's avatar
Steven Murray committed
308
  virtual void reclaimTape(const common::dataStructures::SecurityIdentity &admin, const std::string &vid) = 0;
309

Steven Murray's avatar
Steven Murray committed
310
311
312
313
  virtual void modifyTapeLogicalLibraryName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &logicalLibraryName) = 0;
  virtual void modifyTapeTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &tapePoolName) = 0;
  virtual void modifyTapeCapacityInBytes(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const uint64_t capacityInBytes) = 0;
  virtual void modifyTapeEncryptionKey(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &encryptionKey) = 0;
314
315
316
317
318
319
320

  /**
   * Sets the full status of the specified tape.
   *
   * Please note that this method is to be called by the CTA front-end in
   * response to a command from the CTA command-line interface (CLI).
   *
Steven Murray's avatar
Steven Murray committed
321
   * @param admin The administrator.
322
323
324
   * @param vid The volume identifier of the tape to be marked as full.
   * @param fullValue Set to true if the tape is full.
   */
Steven Murray's avatar
Steven Murray committed
325
  virtual void setTapeFull(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool fullValue) = 0;
326

Steven Murray's avatar
Steven Murray committed
327
328
  virtual void setTapeDisabled(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool disabledValue) = 0;
  virtual void modifyTapeComment(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &comment) = 0;
329

Steven Murray's avatar
Steven Murray committed
330
331
332
333
  virtual void modifyRequesterMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &mountPolicy) = 0;
  virtual void modifyRequesteMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &comment) = 0;
  virtual void modifyRequesterGroupMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &mountPolicy) = 0;
  virtual void modifyRequesterGroupMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &comment) = 0;
334

335
   virtual void createMountPolicy(
Steven Murray's avatar
Steven Murray committed
336
    const common::dataStructures::SecurityIdentity &admin,
337
338
339
340
341
342
343
344
    const std::string &name, 
    const uint64_t archivePriority, 
    const uint64_t minArchiveRequestAge, 
    const uint64_t retrievePriority, 
    const uint64_t minRetrieveRequestAge, 
    const uint64_t maxDrivesAllowed, 
    const std::string &comment) = 0;

345
  /**
346
   * Returns the list of all existing mount policies.
347
   *
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
   * @return the list of all existing mount policies.
   */
  virtual std::list<common::dataStructures::MountPolicy> getMountPolicies() const = 0;

  /**
   * Deletes the specified mount policy.
   *
   * @param name The name of the mount policy.
   */
  virtual void deleteMountPolicy(const std::string &name) = 0;

  /**
   * Creates the rule that the specified mount policy will be used for the
   * specified requester.
   *
   * Please note that requester mount-rules overrule requester-group
   * mount-rules.
365
   *
Steven Murray's avatar
Steven Murray committed
366
   * @param admin The administrator.
367
   * @param mountPolicyName The name of the mount policy.
368
369
370
371
   * @param diskInstance The name of the disk instance to which the requester
   * belongs.
   * @param requesterName The name of the requester which is only guarantted to
   * be unique within its disk instance.
372
373
   * @param comment Comment.
   */
374
  virtual void createRequesterMountRule(
Steven Murray's avatar
Steven Murray committed
375
    const common::dataStructures::SecurityIdentity &admin,
376
    const std::string &mountPolicyName,
377
    const std::string &diskInstance,
378
379
380
381
    const std::string &requesterName,
    const std::string &comment) = 0;

  /**
382
383
384
385
386
387
388
389
390
391
392
   * Returns the rules that specify which mount policy is be used for which
   * requester.
   *
   * @return the rules that specify which mount policy is be used for which
   * requester.
   */
  virtual std::list<common::dataStructures::RequesterMountRule> getRequesterMountRules() const = 0;

  /**
   * Deletes the specified mount rule.
   *
393
394
395
396
   * @param diskInstanceName The name of the disk instance to which the
   * requester belongs.
   * @param requesterName The name of the requester which is only guaranteed to
   * be unique within its disk instance.
397
   */
398
  virtual void deleteRequesterMountRule(const std::string &diskInstanceName, const std::string &requesterName) = 0;
399

400
  /**   
401
402
   * Creates the rule that the specified mount policy will be used for the
   * specified requester group.
403
   *
404
405
   * Please note that requester mount-rules overrule requester-group
   * mount-rules.
406
   *
Steven Murray's avatar
Steven Murray committed
407
   * @param admin The administrator.
408
   * @param mountPolicyName The name of the mount policy.
409
410
411
412
   * @param diskInstanceName The name of the disk instance to which the
   * requester group belongs.
   * @param requesterGroupName The name of the requester group which is only
   * guarantted to be unique within its disk instance.
413
   * @param comment Comment.
414
   */
415
  virtual void createRequesterGroupMountRule(
Steven Murray's avatar
Steven Murray committed
416
    const common::dataStructures::SecurityIdentity &admin,
417
    const std::string &mountPolicyName,
418
    const std::string &diskInstanceName,
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
    const std::string &requesterGroupName,
    const std::string &comment) = 0;

  /**
   * Returns the rules that specify which mount policy is be used for which
   * requester group.
   *
   * @return the rules that specify which mount policy is be used for which
   * requester group.
   */
  virtual std::list<common::dataStructures::RequesterGroupMountRule> getRequesterGroupMountRules() const = 0;

  /**
   * Deletes the specified mount rule.
   *
434
435
436
437
   * @param diskInstanceName The name of the disk instance to which the
   * requester group belongs.
   * @param requesterGroupName The name of the requester group which is only
   * guaranteed to be unique within its disk instance.
438
   */
439
440
441
  virtual void deleteRequesterGroupMountRule(
    const std::string &diskInstanceName,
    const std::string &requesterGroupName) = 0;
442

Steven Murray's avatar
Steven Murray committed
443
444
445
446
447
448
  virtual void modifyMountPolicyArchivePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t archivePriority) = 0;
  virtual void modifyMountPolicyArchiveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minArchiveRequestAge) = 0;
  virtual void modifyMountPolicyRetrievePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t retrievePriority) = 0;
  virtual void modifyMountPolicyRetrieveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minRetrieveRequestAge) = 0;
  virtual void modifyMountPolicyMaxDrivesAllowed(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t maxDrivesAllowed) = 0;
  virtual void modifyMountPolicyComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) = 0;
449

450
  /**
451
452
   * Returns the specified archive files.  Please note that the list of files
   * is ordered by archive file ID.
453
454
   *
   * @param searchCriteria The search criteria.
455
   * @return The archive files.
456
   */
457
458
  virtual ArchiveFileItor getArchiveFiles(
    const TapeFileSearchCriteria &searchCriteria = TapeFileSearchCriteria()) const = 0;
459
460

  /**
461
   * Returns a summary of the tape files that meet the specified search
462
463
464
465
466
   * criteria.
   *
   * @param searchCriteria The search criteria.
   * @return The summary.
   */
467
  virtual common::dataStructures::ArchiveFileSummary getTapeFileSummary(
468
    const TapeFileSearchCriteria &searchCriteria = TapeFileSearchCriteria()) const = 0;
469
470
471
472
473
474
475
476
477
478
479

  /**
   * Returns the archive file with the specified unique identifier.
   *
   * This method assumes that the archive file being requested exists and will
   * therefore throw an exception if it does not.
   *
   * @param id The unique identifier of the archive file.
   * @return The archive file.
   */
  virtual common::dataStructures::ArchiveFile getArchiveFileById(const uint64_t id) = 0;
480

481
482
483
484
  /**
   * Deletes the specified archive file and its associated tape copies from the
   * catalogue.
   *
485
486
487
488
   * Please note that the name of the disk instance is specified in order to
   * prevent a disk instance deleting an archive file that belongs to another
   * disk instance.
   *
489
490
   * @param instanceName The name of the instance from where the deletion request
   * originated
491
492
493
   * @param archiveFileId The unique identifier of the archive file.
   * @return The metadata of the deleted archive file including the metadata of
   * the associated and also deleted tape copies.
494
495
   * @throw ArchiveFileDoesNotExistInCatalogue If the specified archive file
   * does not exist in the catalogue.
496
   */
497
498
  virtual common::dataStructures::ArchiveFile deleteArchiveFile(const std::string &instanceName, 
    const uint64_t archiveFileId) = 0;
499

500
501
502
503
  /**
   * Returns true if the specified user running the CTA command-line tool on
   * the specified host has administrator privileges.
   *
Steven Murray's avatar
Steven Murray committed
504
   * @param admin The administrator.
505
506
507
   * @return True if the specified user running the CTA command-line tool on
   * the specified host has administrator privileges.
   */
Steven Murray's avatar
Steven Murray committed
508
  virtual bool isAdmin(const common::dataStructures::SecurityIdentity &admin) const = 0;
509

510
  /**
511
   * Checks that the most trivial query goes through. Throws an exception if not.
512
   */
513
  virtual void ping() = 0;
514

515
516
517
518
519
520
521
522
  /**
   * Returns true if the specified tape pool exists.
   *
   * @param tapePoolName The name of the tape pool.
   * @return True if the tape pool exists.
   */
  virtual bool tapePoolExists(const std::string &tapePoolName) const = 0;

523
524
525
526
527
528
529
530
  /**
   * Returns true if the specified tape exists.
   *
   * @param vid The volume identifier of the tape.
   * @return True if the tape exists.
   */
  virtual bool tapeExists(const std::string &vid) const = 0;

531
532
}; // class Catalogue

533
} // namespace catalogue
534
} // namespace cta