eu.unicore.uftp.client

Class UFTPClient

java.lang.Object

eu.unicore.uftp.client.AbstractUFTPClient

eu.unicore.uftp.client.UFTPClient

All Implemented Interfaces:

Runnable

public class UFTPClient
extends AbstractUFTPClient
implements Runnable

Client class for handling UFTP transfers
There are two ways to use this class:

• as a commandline tool
• directly via its API

Author:

Tim Pohlmann, 2010, Forschungszentrum Juelich - JSC, schuller

Field Summary

Fields inherited from class eu.unicore.uftp.client.AbstractUFTPClient

BUFFSIZE, cancelled, client, compress, HOSTERR, key, numcons, progressListener, reader, socket, SYNERR, writer

Constructor Summary

Constructors

Constructor and Description
UFTPClient(InetAddress[] servers, int port, InputStream source) create a new UFTP client for writing data to the given server, which is read from the specified source
UFTPClient(InetAddress[] servers, int port, OutputStream target) create a new UFTP client for reading data from the given server and writing it to the specified target
UFTPClient(InetAddress[] servers, int port, String fileName, boolean send, boolean append) create a new UFTP client for file transfer from/to the given server

Method Summary

Modifier and Type	Method and Description
long	getFinalTransferRate() after the transfer has finished, this will reflect the net transfer rate in bytes per second
static void	main(String[] args) runs a UFTP data transfer
static String	makeCommandline(String host, int port, String localFile, boolean sendData, String secret, int numStreams, String encryptionKey, boolean append, boolean compress) create a correct commandline for passing the given parameters to a UFTPClient
static String	makeCommandline(String host, int port, String localFile, boolean sendData, String secret, int numStreams, String encryptionKey, boolean append, boolean compress, int bufferSize) create a correct commandline for passing the given parameters to a UFTPClient
void	run()

Methods inherited from class eu.unicore.uftp.client.AbstractUFTPClient

cancel, cleanup, closeData, connect, createSocket, createSocket, getAuthtimeout, getBufferSize, getKey, getNumConnections, getProgressListener, getSecret, getServerFeatures, getServerList, getTimeout, isCompress, isConnected, openDataConnection, prepareGet, preparePut, setAuthtimeout, setBufferSize, setCompress, setKey, setNumConnections, setProgressListener, setSecret, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

UFTPClient

public UFTPClient(InetAddress[] servers,
                  int port,
                  String fileName,
                  boolean send,
                  boolean append)
           throws FileNotFoundException

create a new UFTP client for file transfer from/to the given server

Parameters:

servers - - list of alternative IP addresses of the UFTP server

port - - the server port

fileName - - the local file name

send - - true if data should be sent

append - - true if data (in receive mode) should be appended to the local file

Throws:

FileNotFoundException

UFTPClient

public UFTPClient(InetAddress[] servers,
                  int port,
                  InputStream source)
           throws IOException

create a new UFTP client for writing data to the given server, which is read from the specified source

Parameters:

servers - - list of alternative IP addresses of the UFTP server

port - - UFTP port

source - - input stream for reading data from

Throws:

IOException

UFTPClient

public UFTPClient(InetAddress[] servers,
                  int port,
                  OutputStream target)
           throws IOException

create a new UFTP client for reading data from the given server and writing it to the specified target

Parameters:

servers - - list of alternative IP addresses of the UFTP server

port - - UFTP port

target - - output stream for writing data to

Throws:

IOException

Method Detail

run

public void run()

Specified by:

run in interface Runnable

getFinalTransferRate

public long getFinalTransferRate()

after the transfer has finished, this will reflect the net transfer rate in bytes per second

Returns:

transfer rate

main

public static void main(String[] args)
                 throws Exception

runs a UFTP data transfer

Parameters:

args -

Throws:

Exception

makeCommandline

public static String makeCommandline(String host,
                                     int port,
                                     String localFile,
                                     boolean sendData,
                                     String secret,
                                     int numStreams,
                                     String encryptionKey,
                                     boolean append,
                                     boolean compress,
                                     int bufferSize)

create a correct commandline for passing the given parameters to a UFTPClient

Parameters:

host - - server host (can be a comma separated list of addresses)

port - - server port

localFile - - local file name

sendData - - true if client should send data

secret - - the secret

numStreams - - the number of streams

encryptionKey - - encryption key (base64), if null, no encryption will be used

append - - whether to append to an existing file

bufferSize - - file read/write buffer in kbytes (default 128)

Returns:

makeCommandline

public static String makeCommandline(String host,
                                     int port,
                                     String localFile,
                                     boolean sendData,
                                     String secret,
                                     int numStreams,
                                     String encryptionKey,
                                     boolean append,
                                     boolean compress)

create a correct commandline for passing the given parameters to a UFTPClient

Parameters:

host - - server host (can be a comma separated list of addresses)

port - - server port

localFile - - local file name

sendData - - true if client should send data

secret - - the secret

numStreams - - the number of streams

encryptionKey - - encryption key (base64), if null, no encryption will be used

append - - whether to append to an existing file

Returns: