org.mmbase.module.builders.vwms
Class SCPcopy

java.lang.Object
  org.mmbase.module.builders.vwms.SCPcopy

public class SCPcopy
extends Object

Performs a transfer of a file from the current server to a host. Uses invocation of ssh on the commandline to achieve its ends. Since no password is used, the client machine (this server) has to be configured to gain access (i.e. through the use of public keys). Also note that the client needs execute rights on ssh.
A system that directlky acecsses ssh, and does not make use of Execute is being developed.

Version:

$Id: SCPcopy.java 35335 2009-05-21 08:14:41Z michiel $

Author:

Rico Jansen, Pierre van Rooden (javadocs)

Field Summary

(package private) String	dsthost Name of the destination host
(package private) String	dstpath Root-path of the file at the destination host
(package private) String	dstuser Name of the destination user.
(package private) Execute	exec Program runner for executing the 'ssh' command.
(package private) String	sshpath Path to ssh command
(package private) String	thisserver Name of the current server

Constructor Summary

SCPcopy()
Deprecated. vpro-specific

SCPcopy(String sshpath)
Deprecated. vpro-specific

SCPcopy(String sshpath, String user)
Deprecated. vpro-specific

SCPcopy(String sshpath, String user, String host)
Deprecated. vpro-specific

SCPcopy(String sshpath, String user, String host, String path)
SCPCopy Constructor.

Method Summary

void	copy(String base, String src) Transfers a file from this server to the host.
void	copy(String base, String src, String dst) Transfers a file from this server to a host.
String	getHost() Get name of the destination host
String	getPath() Get root-path of the file at the destination host
String	getSSHpath() Get path to ssh command
String	getUser() Get name of the destination user.
static void	main(String[] args) Deprecated. VPRO-specific
boolean	mkdir(String path) Creates a directory at the host.
boolean	mkdirs(String path) Creates a full directory path at the host.
boolean	realcopy(String src, String dst) Transfers a file at this server to the host.
boolean	remove(String path) Removes a file at the host.
boolean	removedir(String path) Removes a directory at the host.
boolean	rename(String src, String dst) Renames a file at the host.
void	setHost(String host) Set name of the destination host
void	setPath(String path) Set root-path of the file at the destination host
void	setSSHpath(String path) Set path to ssh command
void	setUser(String user) Set name of the destination user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

exec

Execute exec

Program runner for executing the 'ssh' command.

thisserver

String thisserver

Name of the current server

dstpath

String dstpath

Root-path of the file at the destination host

dstuser

String dstuser

Name of the destination user. Needed to log in to the host (using ssh).

dsthost

String dsthost

Name of the destination host

sshpath

String sshpath

Path to ssh command

Constructor Detail

SCPcopy

public SCPcopy()

Deprecated. vpro-specific

SCPCopy Constructor.

SCPcopy

public SCPcopy(String sshpath)

Deprecated. vpro-specific

SCPCopy Constructor.

Parameters:

sshpath - Path to ssh command

SCPcopy

public SCPcopy(String sshpath,
               String user)

Deprecated. vpro-specific

SCPCopy Constructor.

Parameters:

sshpath - Path to ssh command

user - User name needed to log on at the destination host

SCPcopy

public SCPcopy(String sshpath,
               String user,
               String host)

Deprecated. vpro-specific

SCPCopy Constructor.

Parameters:

sshpath - Path to ssh command

user - User name needed to log on at the destination host

host - Name of the destination host

SCPcopy

public SCPcopy(String sshpath,
               String user,
               String host,
               String path)

SCPCopy Constructor.

Parameters:

sshpath - Path to ssh command

user - User name needed to log on at the destination host

host - Name of the destination host

path - Root path of the file at the destination host

Method Detail

copy

public void copy(String base,
                 String src,
                 String dst)

Transfers a file from this server to a host. Creates directories if needed.

Parameters:

base - Root path of the file on this server

src - The actual file to transfer (includes path info)

dst - Name of the destination host

copy

public void copy(String base,
                 String src)

Transfers a file from this server to the host. Creates directories if needed.

Parameters:

base - Root path of the file on this server

src - The actual file to transfer (includes path info)

mkdir

public boolean mkdir(String path)

Creates a directory at the host.

Parameters:

path - directory to create

Returns:

true if successful

mkdirs

public boolean mkdirs(String path)

Creates a full directory path at the host.

Parameters:

path - path to create

Returns:

true if successful

rename

public boolean rename(String src,
                      String dst)

Renames a file at the host.

Parameters:

src - Original file name

dst - New file name

Returns:

true if successful

realcopy

public boolean realcopy(String src,
                        String dst)

Transfers a file at this server to the host. Directories should already exist.

Parameters:

src - file path at this server

dst - new file path at the host

Returns:

true if successful

remove

public boolean remove(String path)

Removes a file at the host.

Parameters:

path - path of the file to remove

Returns:

true if successful

removedir

public boolean removedir(String path)

Removes a directory at the host.

Parameters:

path - path of the directory to remove

Returns:

true if successful

getSSHpath

public String getSSHpath()

Get path to ssh command

getPath

public String getPath()

Get root-path of the file at the destination host

getHost

public String getHost()

Get name of the destination host

getUser

public String getUser()

Get name of the destination user.

setSSHpath

public void setSSHpath(String path)

Set path to ssh command

setPath

public void setPath(String path)

Set root-path of the file at the destination host

setHost

public void setHost(String host)

Set name of the destination host

setUser

public void setUser(String user)

Set name of the destination user.

main

public static void main(String[] args)

Deprecated. VPRO-specific

Entry for direct invocation from the commandline. Usage:
java SCPCopy [basedir],[filepath],[destinationhost]

Parameters:

args - The commandline arguments