ProbeSession.hpp 3.5 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
26
27
28
29
30
31
32
33
/******************************************************************************
 *
 * 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

#include "castor/log/LogContext.hpp"
#include "castor/log/Logger.hpp"
#include "castor/mediachanger/MediaChangerFacade.hpp"
#include "castor/tape/tapeserver/daemon/DriveConfig.hpp"
#include "castor/tape/tapeserver/daemon/Session.hpp"
#include "castor/tape/tapeserver/drive/DriveInterface.hpp"
#include "castor/tape/tapeserver/file/Structures.hpp"
#include "castor/tape/tapeserver/SCSI/Device.hpp"
34
#include "castor/tape/tapeserver/system/Wrapper.hpp"
Daniele Kruse's avatar
Daniele Kruse committed
35
36
37
38
39
40
41
42

#include <memory>

namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  /**
43
44
45
46
   * Class responsible for probing a tape drive to see if it empty and
   * accessible.  If the drive satisfies both of these criteria then the probe
   * will recommend that the state of the drive should be marked as UP, else
   * it will recommend DOWN.
Daniele Kruse's avatar
Daniele Kruse committed
47
48
49
   */
  class ProbeSession : public Session {
  public:
50

Daniele Kruse's avatar
Daniele Kruse committed
51
52
53
54
55
56
57
58
59
60
    /**
     * 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.
     */
    ProbeSession(
      castor::log::Logger &log,
      const DriveConfig &driveConfig,
61
      System::virtualWrapper &sysWrapper);
Daniele Kruse's avatar
Daniele Kruse committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
    
    /** 
     * Execute the session and return the type of action to be performed
     * immediately after the session has completed.
     *
     * @return Returns the type of action to be performed after the session has
     * completed.
     */
    EndOfSessionAction execute() throw();
    
  private:

    /**
     * The logging object     
     */
77
    castor::log::Logger &m_log;
Daniele Kruse's avatar
Daniele Kruse committed
78
79
80
81
82
83
84
85
86
    
    /**
     * 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
     */
87
    System::virtualWrapper &m_sysWrapper;
Daniele Kruse's avatar
Daniele Kruse committed
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

    /** 
     * Execute the session and return the type of action to be performed
     * immediately after the session has completed.
     *
     * @return Returns the type of action to be performed after the session has
     * completed.
     */
    EndOfSessionAction exceptionThrowingExecute();

    /**
     * Creates and returns the object that represents the tape drive to be
     * probed.
     *
     * @return The tape drive.
     */
    std::auto_ptr<drive::DriveInterface> createDrive();
    
  }; // class ProbeSession

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