Salome HOME
a300ff14ce847c19ec11f1bb776e40d8bc023770
[tools/libbatch.git] / src / Core / Batch_CommunicationProtocol.hxx
1 //  Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 //  This library is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU Lesser General Public
8 //  License as published by the Free Software Foundation; either
9 //  version 2.1 of the License.
10 //
11 //  This library is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 //  Lesser General Public License for more details.
15 //
16 //  You should have received a copy of the GNU Lesser General Public
17 //  License along with this library; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 /*
23  *  Batch_CommunicationProtocol.hxx :
24  *
25  *  Created on: 14 sept. 2009
26  *  Author : Renaud BARATE - EDF R&D
27  */
28
29 #ifndef _BATCHCOMMUNICATIONPROTOCOL_H_
30 #define _BATCHCOMMUNICATIONPROTOCOL_H_
31
32 #include <string>
33 #include <vector>
34
35 #include "Batch_Defines.hxx"
36
37 namespace Batch {
38
39   enum CommunicationProtocolType {SH, SSH, RSH};
40
41   class BATCH_EXPORT CommunicationProtocol
42   {
43   public:
44     virtual ~CommunicationProtocol();
45
46     static const CommunicationProtocol & getInstance(CommunicationProtocolType protocolType);
47
48     virtual std::string getExecCommand(const std::string & subCommand,
49                                        const std::string & host,
50                                        const std::string & user) const;
51
52     virtual std::vector<std::string> getExecCommandArgs(const std::string & subCommand,
53                                                         const std::string & host,
54                                                         const std::string & user) const=0;
55
56     virtual int copyFile(const std::string & sourcePath,
57                          const std::string & sourceHost,
58                          const std::string & sourceUser,
59                          const std::string & destinationPath,
60                          const std::string & destinationHost,
61                          const std::string & destinationUser) const;
62
63     virtual int removeFile(const std::string & path,
64                            const std::string & host,
65                            const std::string & user) const;
66
67     virtual int makeDirectory(const std::string & path,
68                               const std::string & host,
69                               const std::string & user) const;
70
71   protected:
72
73     virtual std::vector<std::string> getCopyCommandArgs(const std::string & sourcePath,
74                                                         const std::string & sourceHost,
75                                                         const std::string & sourceUser,
76                                                         const std::string & destinationPath,
77                                                         const std::string & destinationHost,
78                                                         const std::string & destinationUser) const=0;
79
80     virtual std::string getRemoveSubCommand(const std::string & path) const;
81
82     virtual std::string getMakeDirectorySubCommand(const std::string & path) const;
83
84     std::string commandStringFromArgs(const std::vector<std::string> & args) const;
85
86   };
87
88 }
89
90 #endif