Qore FileLocationHandler Module Reference  2.0
FileLocationHandlerSftp.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* FileLocationHandlerSftp Copyright 2021 - 2022 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 {
29 
30 public:
32 
38 
39 
41 
49 protected:
50  string getTextFileImpl(string scheme, string location, *hash<auto> opts);
51 public:
52 
53 
55 
63 protected:
64  binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
65 public:
66 
67 
69 
75 protected:
76  Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
77 public:
78 
79 
81 
87 protected:
88  Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
89 public:
90 
91 
93 
98 protected:
99  writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
100 public:
101 
102 
104 
116 protected:
117  OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
118 public:
119 
120 
122 
124 protected:
125  hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
126 public:
127 
128 
130 
132 protected:
133  hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
134 public:
135 
136 
138 protected:
139  object getSftpClient(string scheme, string location, *hash<auto> opts, reference<string> file);
140 public:
141 
142 };
143 };
object getSftpClient(string scheme, string location, *hash< auto > opts, reference< string > file)
Returns an SFTP client for the given location.
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file&#39;s data at the given location.
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
The class for handling file locations.
Definition: FileLocationHandlerSftp.qc.dox.h:28
binary binary()
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:43
const SftpClientLocationOpts
Valid SFTP location options.
Definition: FileLocationHandlerSftp.qc.dox.h:37
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.
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at the given location.