Store::RSyncSSH - Class to define RSyncSSH store that perform RSync operations between a local- and remote location through a SSH-connection.
Used in the same way as the Store-class. See the Store-class for more information.
Class to perform RSync operations between a local- and remote location through a SSH-connection.
These additional parameters are special to the RSyncSSH-class and are to be used with the open()-method:
knownhosts The knownhosts-file entry that identifies the host that one connects to. It is basically the publickey in the same format as in a SSH knownhosts-file. When this option is specified it creates a random file in /tmp that contains the host-name and the publickey when the open()-method is called. It also appends the sshoptions-parameter in both the get- and put-command to add the option "-o UserKnownHostsFile" and sets it to the temporary file. This means that the host-parameter should not be changed after the open()- method has been called as it could make the host-name in the temporary knownhosts-file invalid. When the DESTROY-method is called it unlinks the temporary knownhosts-file.
passwordfile This parameter must be specified if the authentication mode set to the new()-method is AUTH_PWFILE. It basically defines the location and name of the file to read the password from for the user connecting through SSH to get/put data on the remote location.
privatekey This parameters must be specified if the authentication mode set to the new()-method is AUTH_KEY. The key specified here is in the same format as in the .ssh/id_rsa-file. The parameters is written to a random file in /tmp that is used as the privatekey/identity file when connecting through SSH to the remote location. When the DESTROY()-method is called it unlinks the temporary privatekey-file.
It is used in the same way as the Store-class. See the Store-class for more information.
Constructor is inherited from the Store-class. See the Store-class for more information.
It uses the inherited new()-method.
It returns the instantiated class.
Defines the parameters used on the RSyncSSH-store. This methods is inherited from the Store-class. See the Store-class for more information.
Creates the necessary StoreProcess-instances used by the RSyncSSH-store.
It basically creates StoreProcess::Shell-instances for GET-, PUT- and DEL-operations and inputs the necessary Parameter::Group-class parameters.
This method has overridden a Store-class method. See the Store-class for more information.
Returns the size of the area designated by the remote-parameter to the open()-method.
The size is calculated by using ssh and then running the "ls" command recursively.
It returns the size in Bytes. Please see the Store-class for more information on this method.
Lists a designated remote folder.
Input parameter is path. If none given it defaults to the root of the store area.
The method uses ssh and the "ls" command to list the folder in the remote area.
Returns a HASH-reference structure upon success. Please see the Store-class for more information on this method.
Overrides the close()-method of the placeholder Store-class.
Unlinks temporary files used when store is open. Also calls the placeholder classes close()-method.
Always returns 1.