RdbmsCatalogue.hpp 44.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
 * The CERN Tape Archive (CTA) project
 * Copyright (C) 2015  CERN
 *
 * 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
 * (at your option) any later version.
 *
 * 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

#include "catalogue/Catalogue.hpp"
22
#include "catalogue/RequesterAndGroupMountPolicies.hpp"
Steven Murray's avatar
Steven Murray committed
23
#include "catalogue/TimeBasedCache.hpp"
24
#include "common/threading/Mutex.hpp"
25
#include "rdbms/ConnPool.hpp"
26
#include "rdbms/Login.hpp"
27

28
#include <memory>
29

30
31
32
33
34
35
36
namespace cta {
namespace common {
namespace dataStructures {

/**
 * Forward declaration.
 */
37
class TapeFile;
38
39
40
41
42

} // namespace dataStructures
} // namespace catalogue
} // namespace cta

43
44
45
namespace cta {
namespace catalogue {

46
47
48
49
50
/**
 * Forward declaration.
 */
class ArchiveFileRow;

51
52
53
/**
 * Forward declaration.
 */
54
class RdbmsArchiveFileItorImpl;
55

56
/**
Steven Murray's avatar
Steven Murray committed
57
 * CTA catalogue implemented using a relational database backend.
58
 */
59
class RdbmsCatalogue: public Catalogue {
60
protected:
61

62
63
64
  /**
   * Protected constructor only to be called by sub-classes.
   *
65
   * @param log Object representing the API to the CTA logging system.
66
67
   * @param login The database login details to be used to create new
   * connections.
68
69
70
71
72
73
   * @param nbConns The maximum number of concurrent connections to the
   * underlying relational database for all operations accept listing archive
   * files which can be relatively long operations.
   * @param nbArchiveFileListingConns The maximum number of concurrent
   * connections to the underlying relational database for the sole purpose of
   * listing archive files.
74
75
76
   * @param maxTriesToConnext The maximum number of times a single method should
   * try to connect to the database in the event of LostDatabaseConnection
   * exceptions being thrown.
77
   */
78
79
  RdbmsCatalogue(
    log::Logger &log,
80
    const rdbms::Login &login,
81
    const uint64_t nbConns,
82
    const uint64_t nbArchiveFileListingConns,
83
    const uint32_t maxTriesToConnect);
84

85
86
public:

87
88
89
  /**
   * Destructor.
   */
90
  ~RdbmsCatalogue() override;
91

92
93
94
  /////////////////////////////////////////////////////////////////////
  // START OF METHODS DIRECTLY INVOLVED IN DATA TRANSFER AND SCHEDULING
  /////////////////////////////////////////////////////////////////////
95
96
97
98
99
100
101
102

  /**
   * 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.
   */
103
  void tapeLabelled(const std::string &vid, const std::string &drive, const bool lbpIsOn) override;
104

105
  /**
106
107
108
   * Checks the specified archival could take place and returns a new and
   * unique archive file identifier that can be used by a new archive file
   * within the catalogue.
109
110
111
112
113
114
115
116
117
118
   *
   * @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.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
   * @return The new archive file identifier.
   */
  uint64_t checkAndGetNextArchiveFileId(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const common::dataStructures::UserIdentity &user) override;

  /**
   * Returns the information required to queue an 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 an archive request.
139
140
141
142
143
144
   */
  common::dataStructures::ArchiveFileQueueCriteria getArchiveFileQueueCriteria(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const common::dataStructures::UserIdentity &user) override;

145
146
147
148
149
150
  /**
   * 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.
151
   * @return The list of tapes for writing.
152
   */
153
  std::list<TapeForWriting> getTapesForWriting(const std::string &logicalLibraryName) const override;
154
155

  /**
156
157
158
159
160
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to archive files.
   *
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for archiving files last.
161
162
   *
   * @param vid The volume identifier of the tape.
163
   * @param drive The name of the drive where the tape was mounted.
164
   */
165
  void tapeMountedForArchive(const std::string &vid, const std::string &drive) override;
166

167
  /**
168
169
   * Prepares for a file retrieval by returning the information required to
   * queue the associated retrieve request(s).
170
   *
171
172
   * @param diskInstanceName The name of the instance from where the retrieval
   * request originated
173
174
175
176
177
   * @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.
178
   * @param lc The log context.
179
180
   *
   * @return The information required to queue the associated retrieve request(s).
181
   */
182
  common::dataStructures::RetrieveFileQueueCriteria prepareToRetrieveFile(
183
    const std::string &diskInstanceName,
184
    const uint64_t archiveFileId,
185
186
    const common::dataStructures::UserIdentity &user,
    log::LogContext &lc) override;
187

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
  /**
   * Prepares for a file retrieval by returning the information required to
   * queue the associated retrieve request(s).
   *
   * @param diskInstanceName The name of the instance from where the retrieval
   * request originated
   * @param diskFileId The identifier of the source disk file which is unique
   * within it's host disk system.  Two files from different disk systems may
   * have the same identifier.  The combination of diskInstanceName and
   * diskFileId must be globally unique, in other words unique within the CTA
   * catalogue.
   * @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.
   * @param lc The log context.
   *
   * @return The information required to queue the associated retrieve request(s).
   */
208
  common::dataStructures::RetrieveFileQueueCriteria prepareToRetrieveFileByDiskFileId(
209
210
211
212
213
    const std::string &diskInstanceName,
    const std::string &diskFileId,
    const common::dataStructures::UserIdentity &user,
    log::LogContext &lc) override;

214
215
216
217
  /**
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to retrieve files.
   *
218
219
220
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for retrieving files last.
   *
221
222
223
   * @param vid The volume identifier of the tape.
   * @param drive The name of the drive where the tape was mounted.
   */
224
  void tapeMountedForRetrieve(const std::string &vid, const std::string &drive) override;
225

226
227
228
229
230
231
  /**
   * 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.
   */
232
  void noSpaceLeftOnTape(const std::string &vid) override;
233
234
235
236

  ///////////////////////////////////////////////////////////////////
  // END OF METHODS DIRECTLY INVOLVED IN DATA TRANSFER AND SCHEDULING
  ///////////////////////////////////////////////////////////////////
237

Steven Murray's avatar
Steven Murray committed
238
  void createAdminUser(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) override;
239
240
  void deleteAdminUser(const std::string &username) override;
  std::list<common::dataStructures::AdminUser> getAdminUsers() const override;
Steven Murray's avatar
Steven Murray committed
241
  void modifyAdminUserComment(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) override;
242

243
244
245
  /**
   * Creates the specified storage class.
   *
Steven Murray's avatar
Steven Murray committed
246
   * @param admin The administrator.
247
248
   * @param storageClass The storage class.
   */
249
  void createStorageClass(
Steven Murray's avatar
Steven Murray committed
250
    const common::dataStructures::SecurityIdentity &admin,
251
    const common::dataStructures::StorageClass &storageClass) override;
252
253
254
255
256
257
258
259
260

  /**
   * 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.
   */
261
  void deleteStorageClass(const std::string &diskInstanceName, const std::string &storageClassName) override;
262

263
  std::list<common::dataStructures::StorageClass> getStorageClasses() const override;
Steven Murray's avatar
Steven Murray committed
264
265
  void modifyStorageClassNbCopies(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const uint64_t nbCopies) override;
  void modifyStorageClassComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const std::string &comment) override;
266

Steven Murray's avatar
Steven Murray committed
267
  void createTapePool(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t nbPartialTapes, const bool encryptionValue, const std::string &comment) override;
268
  void deleteTapePool(const std::string &name) override;
269
  std::list<TapePool> getTapePools() const override;
Steven Murray's avatar
Steven Murray committed
270
271
272
  void modifyTapePoolNbPartialTapes(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t nbPartialTapes) override;
  void modifyTapePoolComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
  void setTapePoolEncryption(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const bool encryptionValue) override;
273

274
  void createArchiveRoute(
Steven Murray's avatar
Steven Murray committed
275
    const common::dataStructures::SecurityIdentity &admin,
276
277
278
279
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const uint64_t copyNb,
    const std::string &tapePoolName,
280
    const std::string &comment) override;
281
282
283
284
285
286
287
288
289
290
291


  /**
   * 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.
   */
292
  void deleteArchiveRoute(
293
294
    const std::string &diskInstanceName,
    const std::string &storageClassName, 
295
    const uint64_t copyNb) override;
296

297
  std::list<common::dataStructures::ArchiveRoute> getArchiveRoutes() const override;
Steven Murray's avatar
Steven Murray committed
298
299
  void modifyArchiveRouteTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &tapePoolName) override;
  void modifyArchiveRouteComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &comment) override;
300

Steven Murray's avatar
Steven Murray committed
301
  void createLogicalLibrary(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
302
303
  void deleteLogicalLibrary(const std::string &name) override;
  std::list<common::dataStructures::LogicalLibrary> getLogicalLibraries() const override;
Steven Murray's avatar
Steven Murray committed
304
  void modifyLogicalLibraryComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
305

306
  /**
307
   * Creates a tape.
308
   */
309
  void createTape(
Steven Murray's avatar
Steven Murray committed
310
    const common::dataStructures::SecurityIdentity &admin,
311
312
313
314
315
316
    const std::string &vid,
    const std::string &logicalLibraryName,
    const std::string &tapePoolName,
    const uint64_t capacityInBytes,
    const bool disabled,
    const bool full,
317
    const std::string &comment) override;
318

319
  void deleteTape(const std::string &vid) override;
320
321
322
323
324
325
326

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

329
330
331
332
333
334
335
336
337
  /**
   * 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.
   */
338
  common::dataStructures::VidToTapeMap getTapesByVid(const std::set<std::string> &vids) const override;
339

Steven Murray's avatar
Steven Murray committed
340
341
342
343
344
345
346
  /**
   * Returns all the tapes within the CTA catalogue.
   *
   * @return Map from tape volume identifier to tape.
   */
  common::dataStructures::VidToTapeMap getAllTapes() const override;

347
348
349
350
351
352
353
354
355
356
  /**
   * 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
357
   * @param admin The administrator.
358
359
   * @param vid The volume identifier of the tape to be reclaimed.
   */
Steven Murray's avatar
Steven Murray committed
360
  void reclaimTape(const common::dataStructures::SecurityIdentity &admin, const std::string &vid) override;
361

Steven Murray's avatar
Steven Murray committed
362
363
364
365
  void modifyTapeLogicalLibraryName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &logicalLibraryName) override;
  void modifyTapeTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &tapePoolName) override;
  void modifyTapeCapacityInBytes(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const uint64_t capacityInBytes) override;
  void modifyTapeEncryptionKey(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &encryptionKey) override;
366
367
368
369
370
371
372

  /**
   * 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
373
   * @param admin The administrator.
374
375
376
   * @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
377
  void setTapeFull(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool fullValue) override;
378

Steven Murray's avatar
Steven Murray committed
379
380
  void setTapeDisabled(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool disabledValue) override;
  void modifyTapeComment(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &comment) override;
381

Steven Murray's avatar
Steven Murray committed
382
383
384
385
  void modifyRequesterMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &mountPolicy) override;
  void modifyRequesteMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &comment) override;
  void modifyRequesterGroupMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &mountPolicy) override;
  void modifyRequesterGroupMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &comment) override;
386

387
  void createMountPolicy(
Steven Murray's avatar
Steven Murray committed
388
    const common::dataStructures::SecurityIdentity &admin,
389
390
391
392
393
394
    const std::string &name,
    const uint64_t archivePriority,
    const uint64_t minArchiveRequestAge,
    const uint64_t retrievePriority,
    const uint64_t minRetrieveRequestAge,
    const uint64_t maxDrivesAllowed,
395
    const std::string &comment) override;
396

397
  /**
398
   * Returns the list of all existing mount policies.
399
   *
400
401
   * @return the list of all existing mount policies.
   */
402
  std::list<common::dataStructures::MountPolicy> getMountPolicies() const override;
403
404
405
406
407
408

  /**
   * Deletes the specified mount policy.
   *
   * @param name The name of the mount policy.
   */
409
  void deleteMountPolicy(const std::string &name) override;
410
411
412
413
414
415
416

  /**
   * 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.
417
   *
Steven Murray's avatar
Steven Murray committed
418
   * @param admin The administrator.
419
   * @param mountPolicyName The name of the mount policy.
420
421
422
423
   * @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.
424
425
   * @param comment Comment.
   */
426
  void createRequesterMountRule(
Steven Murray's avatar
Steven Murray committed
427
    const common::dataStructures::SecurityIdentity &admin,
428
    const std::string &mountPolicyName,
429
    const std::string &diskInstance,
430
    const std::string &requesterName,
431
    const std::string &comment) override;
432
433

  /**
434
435
436
437
438
439
   * 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.
   */
440
  std::list<common::dataStructures::RequesterMountRule> getRequesterMountRules() const override;
441
442
443
444

  /**
   * Deletes the specified mount rule.
   *
445
446
447
448
   * @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.
449
   */
450
  void deleteRequesterMountRule(const std::string &diskInstanceName, const std::string &requesterName) override;
451
452
453
454

  /**
   * Creates the rule that the specified mount policy will be used for the
   * specified requester group.
455
   *
456
457
   * Please note that requester mount-rules overrule requester-group
   * mount-rules.
458
   *
Steven Murray's avatar
Steven Murray committed
459
   * @param admin The administrator.
460
   * @param mountPolicyName The name of the mount policy.
461
462
463
464
   * @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.
465
466
   * @param comment Comment.
   */
467
  void createRequesterGroupMountRule(
Steven Murray's avatar
Steven Murray committed
468
    const common::dataStructures::SecurityIdentity &admin,
469
    const std::string &mountPolicyName,
470
    const std::string &diskInstanceName,
471
    const std::string &requesterGroupName,
472
    const std::string &comment) override;
473
474
475
476
477
478
479

  /**
   * 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.
480
   */
481
  std::list<common::dataStructures::RequesterGroupMountRule> getRequesterGroupMountRules() const override;
482
483
484
485

  /**
   * Deletes the specified mount rule.
   *
486
487
488
489
   * @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.
490
   */
491
  void deleteRequesterGroupMountRule(
492
    const std::string &diskInstanceName,
493
494
    const std::string &requesterGroupName) override;

Steven Murray's avatar
Steven Murray committed
495
496
497
498
499
500
  void modifyMountPolicyArchivePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t archivePriority) override;
  void modifyMountPolicyArchiveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minArchiveRequestAge) override;
  void modifyMountPolicyRetrievePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t retrievePriority) override;
  void modifyMountPolicyRetrieveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minRetrieveRequestAge) override;
  void modifyMountPolicyMaxDrivesAllowed(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t maxDrivesAllowed) override;
  void modifyMountPolicyComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
501

502
  /**
503
504
   * Throws a UserError exception if the specified searchCriteria is not valid
   * due to a user error.
505
506
507
   *
   * @param searchCriteria The search criteria.
   */
508
  void checkTapeFileSearchCriteria(const TapeFileSearchCriteria &searchCriteria) const;
509

510
  /**
511
512
   * Returns the specified archive files.  Please note that the list of files
   * is ordered by archive file ID.
513
514
   *
   * @param searchCriteria The search criteria.
515
   * @return The archive files.
516
   */
517
  ArchiveFileItor getArchiveFiles(const TapeFileSearchCriteria &searchCriteria) const override;
518

519
  /**
520
   * Returns a summary of the tape files that meet the specified search
521
522
523
524
525
   * criteria.
   *
   * @param searchCriteria The search criteria.
   * @return The summary.
   */
526
  common::dataStructures::ArchiveFileSummary getTapeFileSummary(
527
    const TapeFileSearchCriteria &searchCriteria) const override;
528
529
530
531
532
533
534
535
536
537

  /**
   * 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.
   */
538
  common::dataStructures::ArchiveFile getArchiveFileById(const uint64_t id) override;
539

540
  /**
541
542
   * Returns true if the specified user running the CTA command-line tool on
   * the specified host has administrator privileges.
543
   *
Steven Murray's avatar
Steven Murray committed
544
   * @param admin The administrator.
545
546
   * @return True if the specified user running the CTA command-line tool on
   * the specified host has administrator privileges.
547
   */
Steven Murray's avatar
Steven Murray committed
548
  bool isAdmin(const common::dataStructures::SecurityIdentity &admin) const override;
549

550
551
552
553
554
555
  /**
   * Checks that the most trivial query goes through. Returns true on success,
   * false on failure.
   * 
   * @return True if the query went through.
   */
556
  void ping() override;
557

558
protected:
559

560
561
562
563
564
  /**
   * Object representing the API to the CTA logging system.
   */
  log::Logger &m_log;

565
566
567
  /**
   * Mutex to be used to a take a global lock on the database.
   */
568
  threading::Mutex m_mutex;
569
570

  /**
571
572
573
   * The pool of connections to the underlying relational database to be used
   * for all operations accept listing archive files which can be relatively
   * long operations.
574
   */
575
  mutable rdbms::ConnPool m_connPool;
576

577
578
579
580
581
582
  /**
   * The pool of connections to the underlying relational database to be used
   * for the sole purpose of listing archive files.
   */
  mutable rdbms::ConnPool m_archiveFileListingConnPool;

583
584
585
586
587
588
  /**
   * The maximum number of times a single method should try to connect to the
   * database in the event of LostDatabaseConnection exceptions being thrown.
   */
  uint32_t m_maxTriesToConnect;

589
  /**
590
   * Returns true if the specified admin user exists.
591
   *
592
   * @param conn The database connection.
593
594
   * @param adminUsername The name of the admin user.
   * @return True if the admin user exists.
595
   */
596
  bool adminUserExists(rdbms::Conn &conn, const std::string adminUsername) const;
597
598
599
600

  /**
   * Returns true if the specified storage class exists.
   *
601
   * @param conn The database connection.
602
   * @param diskInstanceName The name of the disk instance to which the storage
603
   * class belongs.
604
   * @param storageClassName The name of the storage class.
605
606
   * @return True if the storage class exists.
   */
607
  bool storageClassExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &storageClassName)
608
    const;
609

610
611
612
613
614
615
616
617
  /**
   * Returns true if the specified tape pool exists.
   *
   * @param tapePoolName The name of the tape pool.
   * @return True if the tape pool exists.
   */
  bool tapePoolExists(const std::string &tapePoolName) const override;

618
619
620
  /**
   * Returns true if the specified tape pool exists.
   *
621
   * @param conn The database connection.
622
623
624
   * @param tapePoolName The name of the tape pool.
   * @return True if the tape pool exists.
   */
625
  bool tapePoolExists(rdbms::Conn &conn, const std::string &tapePoolName) const;
626

627
628
629
630
631
632
633
  /**
   * Returns true if the specified archive file identifier exists.
   *
   * @param conn The database connection.
   * @param archiveFileId The archive file identifier.
   * @return True if the archive file identifier exists.
   */
634
  bool archiveFileIdExists(rdbms::Conn &conn, const uint64_t archiveFileId) const;
635

636
637
638
639
640
641
642
  /**
   * Returns true if the specified disk file identifier exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file identifier belongs.
   * @param diskFileId The disk file identifier.
643
   * @return True if the disk file identifier exists.
644
   */
645
  bool diskFileIdExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileId) const;
646

647
648
649
650
651
  /**
   * Returns true if the specified disk file path exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
652
   * file path belongs.
653
654
655
   * @param diskFilePath The disk file path.
   * @return True if the disk file path exists.
   */
656
  bool diskFilePathExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFilePath)
657
658
    const;

659
660
661
662
663
664
665
666
667
  /**
   * Returns true if the specified disk file user exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file user belongs.
   * @param diskFileUSer The name of the disk file user.
   * @return True if the disk file user exists.
   */
668
  bool diskFileUserExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileUser)
669
670
    const;

671
672
673
674
675
676
  /**
   * Returns true if the specified disk file group exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file group belongs.
677
   * @param diskFileGroup The name of the disk file group.
678
679
   * @return True if the disk file group exists.
   */
680
  bool diskFileGroupExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileGroup)
681
682
    const;

683
684
685
686
687
688
689
690
691
692
693
  /**
   * Returns true if the specified archive route exists.
   *
   * @param conn The database connection.
   * @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.
   * @return True if the archive route exists.
   */
694
  bool archiveRouteExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &storageClassName,
695
696
    const uint64_t copyNb) const;

697
698
699
700
701
702
703
704
  /**
   * Returns true if the specified tape exists.
   *
   * @param vid The volume identifier of the tape.
   * @return True if the tape exists.
   */
  bool tapeExists(const std::string &vid) const override;

705
706
707
  /**
   * Returns true if the specified tape exists.
   *
708
   * @param conn The database connection.
709
710
711
   * @param vid The volume identifier of the tape.
   * @return True if the tape exists.
   */
712
  bool tapeExists(rdbms::Conn &conn, const std::string &vid) const;
713

714
715
716
717
718
719
720
  /**
   * Returns the list of tapes that meet the specified search criteria.
   *
   * @param conn The database connection.
   * @param searchCriteria The search criteria.
   * @return The list of tapes.
   */
721
  std::list<common::dataStructures::Tape> getTapes(rdbms::Conn &conn, const TapeSearchCriteria &searchCriteria) const;
722

723
724
725
  /**
   * Returns true if the specified logical library exists.
   *
726
   * @param conn The database connection.
727
728
729
   * @param logicalLibraryName The name of the logical library.
   * @return True if the logical library exists.
   */
730
  bool logicalLibraryExists(rdbms::Conn &conn, const std::string &logicalLibraryName) const;
731
732
733
734

  /**
   * Returns true if the specified mount policy exists.
   *
735
   * @param conn The database connection.
736
737
738
   * @param mountPolicyName The name of the mount policy
   * @return True if the mount policy exists.
   */
739
  bool mountPolicyExists(rdbms::Conn &conn, const std::string &mountPolicyName) const;
740

741
  /**
742
   * Returns true if the specified requester mount-rule exists.
743
   *
744
745
746
747
748
   * @param diskInstanceName The name of the disk instance to which the
   * requester belongs.
   * @param requesterName The username of the requester which is only guaranteed
   * to be unique within its disk instance.
   * @return True if the requester mount-rule exists.
749
   */
750
  bool requesterMountRuleExists(rdbms::Conn &conn, const std::string &diskInstanceName,
751
    const std::string &requesterName) const;
752
753

  /**
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
    * A fully qualified user, in other words the name of the disk instance and
    * the name of the group.
    */
  struct User {
    /**
     * The name of the disk instance to which the user name belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the user which is only guaranteed to be unique within its
     * disk instance.
     */
    std::string username;

    /**
     * Constructor.
     *
     * @param d The name of the disk instance to which the group name belongs.
     * @param u The name of the group which is only guaranteed to be unique
     * within its disk instance.
     */
    User(const std::string &d, const std::string &u): diskInstanceName(d), username(u) {
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
    bool operator<(const User &rhs) const {
      return diskInstanceName < rhs.diskInstanceName || username < rhs.username;
    }
  }; // struct User

  /**
   * Returns a cached version of the specified requester mount-policy or nullopt
   * if one does not exist.
794
   *
795
796
   * @param user The fully qualified user, in other words the name of the disk
   * instance and the name of the group.
797
   * @return The mount policy or nullopt if one does not exists.
798
   */
799
  optional<common::dataStructures::MountPolicy> getCachedRequesterMountPolicy(const User &user) const;
800
801
802
803
804
805
806
807
808
809
810

  /**
   * Returns the specified requester mount-policy or nullopt if one does not
   * exist.
   *
   * @param conn The database connection.
   * @param user The fully qualified user, in other words the name of the disk
   * instance and the name of the group.
   * @return The mount policy or nullopt if one does not exists.
   */
  optional<common::dataStructures::MountPolicy> getRequesterMountPolicy(rdbms::Conn &conn, const User &user) const;
811
812

  /**
813
   * Returns true if the specified requester-group mount-rule exists.
814
   *
815
   * @param conn The database connection.
816
817
818
819
820
   * @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.
   * @return True if the requester-group mount-rule exists.
821
   */
822
  bool requesterGroupMountRuleExists(rdbms::Conn &conn, const std::string &diskInstanceName,
823
    const std::string &requesterGroupName) const;
824

825
  /**
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
    * A fully qualified user group, in other words the name of the disk instance
    * and the name of the group.
    */
  struct Group {
    /**
     * The name of the disk instance to which the group name belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the group which is only guaranteed to be unique within its
     * disk instance.
     */
    std::string groupName;

    /**
     * Constructor.
     *
     * @param d The name of the disk instance to which the group name belongs.
     * @param g The name of the group which is only guaranteed to be unique
     * within its disk instance.
     */
    Group(const std::string &d, const std::string &g): diskInstanceName(d), groupName(g) {
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
    bool operator<(const Group &rhs) const {
      return diskInstanceName < rhs.diskInstanceName || groupName < rhs.groupName;
    }
  }; // struct Group

  /**
   * Returns a cached version of the specified requester-group mount-policy or
   * nullptr if one does not exist.
   *
   * This method updates the cache when necessary.
868
   *
869
870
   * @param group The fully qualified group, in other words the name of the disk
   * instance and the name of the group.
871
   * @return The cached mount policy or nullopt if one does not exists.
872
   */
873
  optional<common::dataStructures::MountPolicy> getCachedRequesterGroupMountPolicy(const Group &group) const;
874
875
876
877
878
879
880
881

  /**
   * Returns the specified requester-group mount-policy or nullptr if one does
   * not exist.
   *
   * @param conn The database connection.
   * @param group The fully qualified group, in other words the name of the disk
   * instance and the name of the group.
882
   * @return The mount policy or nullopt if one does not exists.
883
   */
884
885
  optional<common::dataStructures::MountPolicy> getRequesterGroupMountPolicy(rdbms::Conn &conn, const Group &group)
    const;
886

887
888
889
890
891
  /**
   * Returns the specified tape log information from the specified database
   * result set.
   *
   * @param rset The result set.
892
   * @param driveColName The name of the database column that contains the name
893
894
895
896
   * of the tape drive.
   * @param timeColNAme The name of the database column that contains the time
   * stamp.
   */
897
  optional<common::dataStructures::TapeLog> getTapeLogFromRset(const rdbms::Rset &rset,
898
899
    const std::string &driveColName, const std::string &timeColName) const;

900
  /**
901
902
   * An RdbmsCatalogue specific method that inserts the specified row into the
   * ArchiveFile table.
903
   *
904
   * @param conn The database connection.
905
   * @param autocommitMode The autocommit mode of the SQL insert statement.
906
   * @param row The row to be inserted.
907
   */
908
  void insertArchiveFile(rdbms::Conn &conn, const rdbms::AutocommitMode autocommitMode,
909
    const ArchiveFileRow &row);
910

911
912
913
914
915
  /**
   * Creates the database schema.
   */
  void createDbSchema();

916
917
918
919
  /**
   * A fully qualified storage class, in other words the name of the disk
   * instance and the name of the storage class.
   */
920
  struct StorageClass {
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
    /**
     * The name of the disk instance to which the storage class belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the storage class which is only guaranteed to be unique
     * within its disk instance.
     */
    std::string storageClassName;

    /**
     * Constructor.
     *
     * @param dIN The name of the disk instance to which the storage class
     * belongs.
     * @param sN The name of the storage class which is only guaranteed to be
     * unique within its disk instance.
     */
940
    StorageClass(const std::string &d, const std::string &s): diskInstanceName(d), storageClassName(s) {
941
942
943
944
945
946
947
948
949
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
950
    bool operator<(const StorageClass &rhs) const {
951
952
      return diskInstanceName < rhs.diskInstanceName || storageClassName < rhs.storageClassName;
    }
953
  }; // struct StorageClass
954

955
956
957
958
959
960
961
962
963
964
965
966
  /**
   * Returns a cached version of the expected number of archive routes for the
   * specified storage class as specified by the call to the
   * createStorageClass() method as opposed to the actual number entered so far
   * using the createArchiveRoute() method.
   *
   * This method updates the cache when necessary.
   *
   * @param storageClass The fully qualified storage class, in other words the
   * name of the disk instance and the name of the storage class.
   * @return The expected number of archive routes.
   */
967
  uint64_t getCachedExpectedNbArchiveRoutes(const StorageClass &storageClass) const;
968

969
970
971
972
973
974
  /**
   * Returns the expected number of archive routes for the specified storage
   * class as specified by the call to the createStorageClass() method as
   * opposed to the actual number entered so far using the createArchiveRoute()
   * method.
   *
975
   * @param conn The database connection.
976
977
   * @param storageClass The fully qualified storage class, in other words the
   * name of the disk instance and the name of the storage class.
978
979
   * @return The expected number of archive routes.
   */
980
  uint64_t getExpectedNbArchiveRoutes(rdbms::Conn &conn, const StorageClass &storageClass) const;
981

982
  /**
983
   * Inserts the specified tape file into the Tape table.
984
   *
985
   * @param conn The database connection.
986
   * @param autocommitMode The autocommit mode of the SQL insert statement.
987
988
989
990
   * @param tapeFile The tape file.
   * @param archiveFileId The identifier of the archive file of which the tape
   * file is a copy.
   */
991
  void insertTapeFile(
992
993
    rdbms::Conn &conn,
    const rdbms::AutocommitMode autocommitMode,
994
995
    const common::dataStructures::TapeFile &tapeFile,
    const uint64_t archiveFileId);
996

997
998
999
  /**
   * Sets the last FSeq of the specified tape to the specified value.
   *
1000
   * @param conn The database connection.
For faster browsing, not all history is shown. View entire blame