The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Quiq::Sftp::Client - SFTP Client

BASE CLASS

Quiq::Hash

DESCRIPTION

Ein Objekt der Klasse repräsentiert einen SFTP-Client. Die Klasse realisiert ihre Funktionalität unter Rückgriff auf Net::SFTP::Foreign, allerdings nicht durch Ableitung, sondern durch Einbettung. Die Klasse zeichnet sich dadurch aus, dass sie

  • Fehler nicht über Returnwerte anzeigt, sondern im Fehlerfall eine Exception wirft (allerdings schreibt Net::SFTP::Foreign zusätzlich Meldungen nach STDERR, siehe Net::SFTP::Foreign#stderr_fh um dies ggf. zu verbessern)

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

  $ftp = $class->new(%args);

Arguments

%args

Siehe Net::SFTP::Foreign.

Returns

Object

Description

Instantiiere eine Objekt der Klasse und liefere eine Referenz auf dieses Objekt zurück.

Example

  my $smb = Quiq::Sftp->new(
      user => 'fs',
      password => 'geheim',
      host => 'ftp.fseitz.de',
  );

Objektmethoden

cd() - Wechsele Server-Verzeichnis

Synopsis

  $sftp->cd($dir);

Arguments

$dir

(String) Verzeichnis-Pfad.

Description

Wechsele auf dem Server in Verzeichnis $dir.

delete() - Lösche Datei auf Server

Synopsis

  $sftp->delete($file);

Alias

remove()

Arguments

$file

(String) Datei-Pfad.

Description

Lösche die Datei $file auf dem Server.

get() - Hole Datei von Server

Synopsis

  $sftp->get($remote,%opts);
  $sftp->get($remote,$local,%opts);

Arguments

$remote

(String) Pfad der entfernten Datei.

$local

(String) Pfad der lokalen Datei.

Options

%opts

Siehe Net::SFTP::Foreignget($remote,-$local,-%options)>.

Description

Hole Datei $remote vom Server und speichere sie unter dem Pfad $local.

getData() - Hole Daten von Server

Synopsis

  $data = $sftp->getData($remote,%opts);

Arguments

$remote

(String) Pfad der entfernten Datei.

Options

%opts

Siehe Net::SFTP::Foreignput($local,-$remote,-%opts)>.

Description

Hole die Datei $remote vom Server und liefere dessen Inhalt zurück.

ls() - Liste von Dateien in Server-Verzeichnis

Synopsis

  @arr|$arr = $sftp->ls(%opts);
  @arr|$arr = $sftp->ls($path,%opts);

Arguments

$path

(String) Verzeichnis-Pfad.

Options

%opts

Siehe Net::SFTP::Foreignls($remote,-%opts)>.

Returns

(Array of Strings) Liste von Datei- oder Verzeichnisnamen. Im Skalarkontext eine Referenz auf die Liste.

Description

Liefere die Liste der Dateien unter dem Remote-Pfad $path.

put() - Übertrage Datei auf Server

Synopsis

  $sftp->put($local,%opts);
  $sftp->put($local,$remote,%opts);

Arguments

$local

(String) Pfad der lokalen Datei.

$remote

(String) Pfad der entfernten Datei.

Options

%opts

Siehe Net::SFTP::Foreignput($local,-$remote,-%opts)>.

Description

Übertrage Datei $lokal auf den Server und speichere sie unter dem Pfad $remote.

putData() - Übertrage Daten auf Server

Synopsis

  $sftp->putData($data,$remote,%opts);

Arguments

$data

(String) Daten, die übertragen werden sollen

$remote

(String) Pfad der entfernten Datei.

Options

%opts

Siehe Net::SFTP::Foreignput($local,-$remote,-%opts)>.

Description

Übertrage Daten $data auf den Server und speichere sie unter dem Pfad $remote.

VERSION

1.208

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2023 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.