FileLocationHandlerSftp.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  FileLocationHandlerSftp Copyright 2021 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
namespace FileLocationHandler {
class FileLocationHandlerSftp : public AbstractFileLocationHandler {
 
public:
 
        const SftpClientLocationOpts = {
            "encoding": <FileHandlerOptionInfo>{
                "type": "string",
                "desc": "file encoding (read / write)",
            },
            "ssh2_private_key": <FileHandlerOptionInfo>{
                "type": "string",
                "desc": "the private key file",
            },
            "ssh2_public_key": <FileHandlerOptionInfo>{
                "type": "string",
                "desc": "the public key file",
            },
        };
 
 
protected:
     string getTextFileImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
 
protected:
     binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
 
protected:
     Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
 
protected:
     Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
 
protected:
     writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
public:
 
 
 
protected:
     OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
 
protected:
     hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
public:
 
 
 
protected:
     hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
public:
 
 
    /*
        @note This method can throw any exception related to making an SFTP connection
    */
protected:
     object getSftpClient(string scheme, string location, *hash<auto> opts, reference<string> file);
public:
 
};
};