$darkmode
Qore FileLocationHandler Module Reference 2.3
FileLocationHandlerSftp.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* FileLocationHandlerSftp Copyright 2021 - 2023 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
26 namespace FileLocationHandler {
28 
31 
32 public:
34 
40  "encoding": <FileHandlerOptionInfo>{
41  "type": "string",
42  "desc": "file encoding (read / write)",
43  },
44  "ssh2_private_key": <FileHandlerOptionInfo>{
45  "type": "string",
46  "desc": "the private key file",
47  },
48  "ssh2_public_key": <FileHandlerOptionInfo>{
49  "type": "string",
50  "desc": "the public key file",
51  },
52  };
53 
55 
63 protected:
64  string getTextFileImpl(string scheme, string location, *hash<auto> opts);
65 public:
66 
67 
69 
77 protected:
78  binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
79 public:
80 
81 
83 
89 protected:
90  Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash<auto> opts);
91 public:
92 
93 
95 
103 protected:
104  Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
105 public:
106 
107 
109 
117 protected:
118  Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
119 public:
120 
121 
123 
130 protected:
131  writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
132 public:
133 
134 
136 
149 protected:
150  OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
151 public:
152 
153 
155 
157 protected:
158  hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
159 public:
160 
161 
163 
165 protected:
166  hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
167 public:
168 
169 
171  /*
172  @note This method can throw any exception related to making an SFTP connection
173  */
174 protected:
175  object getSftpClient(string scheme, string location, *hash<auto> opts, reference<string> file);
176 public:
177 
178 };
179 };
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:53
The class for handling "sftp://"" locations.
Definition: FileLocationHandlerSftp.qc.dox.h:30
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text file from the given location.
OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash< auto > opts)
Returns an output stream for writing data to the given location.
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
object getSftpClient(string scheme, string location, *hash< auto > opts, reference< string > file)
Returns an SFTP client for the given location.
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at the given location.
const SftpClientLocationOpts
Valid SFTP location options.
Definition: FileLocationHandlerSftp.qc.dox.h:39
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
Qore::AbstractPollOperation getIoPollerForLocationImpl(string scheme, string location, *hash< auto > opts)
Retrieves an I/O poller to retrieve a binary file from the given location.
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
binary binary()
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26
File handler option info.
Definition: FileLocationHandler.qc.dox.h:28