EmptyDriveProbe.hpp 3.09 KB
Newer Older
Daniele Kruse's avatar
Daniele Kruse committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/******************************************************************************
 *
 * This file is part of the Castor project.
 * See http://castor.web.cern.ch/castor
 *
 * Copyright (C) 2003  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 2
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * 
 *
 * @author Castor Dev team, castor-dev@cern.ch
 *****************************************************************************/

#pragma once

Victor Kotlyar's avatar
Victor Kotlyar committed
26
27
#include "common/log/LogContext.hpp"
#include "common/log/Logger.hpp"
Daniele Kruse's avatar
Daniele Kruse committed
28
29
30
31
32
#include "castor/mediachanger/MediaChangerFacade.hpp"
#include "castor/tape/tapeserver/daemon/DriveConfig.hpp"
#include "castor/tape/tapeserver/drive/DriveInterface.hpp"
#include "castor/tape/tapeserver/file/Structures.hpp"
#include "castor/tape/tapeserver/SCSI/Device.hpp"
33
#include "castor/tape/tapeserver/system/Wrapper.hpp"
Daniele Kruse's avatar
Daniele Kruse committed
34
35
36
37
38
39
40
41

#include <memory>

namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  /**
42
   * Class responsible for probing a tape drive to see if it empty and
43
   * accessible.
Daniele Kruse's avatar
Daniele Kruse committed
44
   */
45
  class EmptyDriveProbe {
Daniele Kruse's avatar
Daniele Kruse committed
46
  public:
47

Daniele Kruse's avatar
Daniele Kruse committed
48
49
50
51
52
53
54
    /**
     * Constructor
     * 
     * @param log Object representing the API to the CASTOR logging system.
     * @param driveConfig Configuration of the tape drive to be probed.
     * @param sysWrapper Object representing the operating system.
     */
55
    EmptyDriveProbe(
Victor Kotlyar's avatar
Victor Kotlyar committed
56
      cta::log::Logger &log,
Daniele Kruse's avatar
Daniele Kruse committed
57
      const DriveConfig &driveConfig,
58
      System::virtualWrapper &sysWrapper);
Daniele Kruse's avatar
Daniele Kruse committed
59
60
    
    /** 
61
     * Probes the tape drive to determine whether it is empty and accessible.
Daniele Kruse's avatar
Daniele Kruse committed
62
     *
63
     * @return True if the drive is empty and accessible.
Daniele Kruse's avatar
Daniele Kruse committed
64
     */
65
    bool driveIsEmpty() throw();
Daniele Kruse's avatar
Daniele Kruse committed
66
67
68
69
70
71
    
  private:

    /**
     * The logging object     
     */
Victor Kotlyar's avatar
Victor Kotlyar committed
72
    cta::log::Logger &m_log;
Daniele Kruse's avatar
Daniele Kruse committed
73
74
75
76
77
78
79
80
81
    
    /**
     * The configuration of the tape drive to be probed.
     */
    const DriveConfig m_driveConfig;
    
    /**
     * The system wrapper used to find the device and instantiate the drive object
     */
82
    System::virtualWrapper &m_sysWrapper;
Daniele Kruse's avatar
Daniele Kruse committed
83
84

    /** 
85
     * Probes the tape drive to determine whether it is empty and accessible.
Daniele Kruse's avatar
Daniele Kruse committed
86
     *
87
     * @return True if the drive is empty and accessible.
Daniele Kruse's avatar
Daniele Kruse committed
88
     */
89
    bool exceptionThrowingDriveIsEmpty();
Daniele Kruse's avatar
Daniele Kruse committed
90
91
92
93
94
95
96

    /**
     * Creates and returns the object that represents the tape drive to be
     * probed.
     *
     * @return The tape drive.
     */
97
    std::unique_ptr<drive::DriveInterface> createDrive();
Daniele Kruse's avatar
Daniele Kruse committed
98
    
99
  }; // class EmptyDriveProbe
Daniele Kruse's avatar
Daniele Kruse committed
100
101
102
103
104

} // namespace daemon
} // namespace tapeserver
} // namespace tape
} // namespace castor