eu.unicore.uftp.client

Class UFTPSessionClient

java.lang.Object

eu.unicore.uftp.client.AbstractUFTPClient

eu.unicore.uftp.client.UFTPSessionClient

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class UFTPSessionClient
extends AbstractUFTPClient

Client class for managing a UFTP session. A UFTP session supports multiple read/write operations, directory movement, listing directories etc.

Author:

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
UFTPSessionClient(InetAddress[] servers, int port) create a new UFTP session client

Method Summary

Modifier and Type	Method and Description
long	append(String remoteFile, long size, InputStream localSource) append data to remote file
void	cd(String dir) change to the given remote directory
void	cdUp() change to the parent directory
void	close()
static UFTPSessionClient	create(String[] args) create a session client instance from the supplied commandline parameters
long	get(String remoteFile, long offset, long length, OutputStream localTarget) partial read: get a chunk of a remote file
void	get(String remoteFile, OutputStream localTarget) get the remote file and write it to the given local stream
File	getBaseDirectory()
List<FileInfo>	getFileInfoList(String baseDir) get file information for the given basedir (which is relative to the current dir)
List<String>	getFileList(String baseDir) get the raw result of 'ls' for the given basedir (which is relative to the current dir)
long	getFileSize(String pathName)
static String	makeCommandline(String host, int port, String baseDirectory, String secret, int numStreams, String encryptionKey, int bufferSize, boolean compress, String commandFile) create a correct commandline for passing the given parameters to a UFTPSessionClient
void	mkdir(String dir) create a remote directory
void	put(String remoteFile, long size, InputStream localSource) write data to a remote file
long	put(String remoteFile, long size, long offset, InputStream localSource) write data to a remote file
String	pwd() get the current directory
void	rename(String from, String to) rename / move a remote file/directory
void	rm(String path) delete a remote file/directory
void	run()
void	setBaseDirectory(File base) set the local base directory
void	setCommandFile(String commandFile)
void	setModificationTime(String path, Calendar to) set the modification time of a remote file/directory
FileInfo	stat(String path) get file information for the given file/dir (which is relative to the current dir)
RsyncStats	syncLocalFile(String remoteMaster, File localSlave) sync a local file with its up-to-date remote version
RsyncStats	syncRemoteFile(File localMaster, String remoteSlave) sync a remote file with its up-to-date local version
void	writeAll(String remoteFile, InputStream localSource) write all the data from the input stream to a remote file

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

assertFeature, cancel, 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

UFTPSessionClient

public UFTPSessionClient(InetAddress[] servers,
                         int port)

create a new UFTP session client

Parameters:

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

port - - the server port

Method Detail

setCommandFile

public void setCommandFile(String commandFile)

run

public void run()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractUFTPClient

Throws:

IOException

get

public void get(String remoteFile,
                OutputStream localTarget)
         throws IOException

get the remote file and write it to the given local stream

Parameters:

remoteFile - - the remote path (relative to the current dir)

localTarget - - the local target stream to write to

Throws:

IOException

get

public long get(String remoteFile,
                long offset,
                long length,
                OutputStream localTarget)
         throws IOException

partial read: get a chunk of a remote file

Parameters:

remoteFile - - the remote file

offset - - the first byte to read, starting at "0"

length - - the number of bytes to read

localTarget - - the local stream to write to

Returns:

actual number of bytes read

Throws:

IOException

put

public long put(String remoteFile,
                long size,
                long offset,
                InputStream localSource)
         throws IOException

write data to a remote file

Parameters:

remoteFile - - the remote file

size - - number of bytes to write

offset - - the offset to start writing the remote file at

localSource - - the local stream to read from

Returns:

the actual number of bytes read

Throws:

IOException

put

public void put(String remoteFile,
                long size,
                InputStream localSource)
         throws IOException

write data to a remote file

Parameters:

remoteFile - - the remote file

size - - number of bytes to write

localSource - - the local stream to read from

Throws:

IOException

writeAll

public void writeAll(String remoteFile,
                     InputStream localSource)
              throws IOException

write all the data from the input stream to a remote file

Parameters:

remoteFile - - the remote file

localSource - - the local stream to read from

Throws:

IOException

append

public long append(String remoteFile,
                   long size,
                   InputStream localSource)
            throws IOException

append data to remote file

Parameters:

remoteFile - - the remote file

size - - number of bytes to write

localSource - - the local stream to read from

Throws:

IOException

getFileList

public List<String> getFileList(String baseDir)
                         throws IOException

get the raw result of 'ls' for the given basedir (which is relative to the current dir)

Parameters:

baseDir - - the base dir

Returns:

a list of directory entries

Throws:

IOException

getFileInfoList

public List<FileInfo> getFileInfoList(String baseDir)
                               throws IOException

get file information for the given basedir (which is relative to the current dir)

Parameters:

baseDir - - the base dir

Returns:

a list of directory entries

Throws:

IOException

stat

public FileInfo stat(String path)
              throws IOException

get file information for the given file/dir (which is relative to the current dir)

Parameters:

path - - the path of the file to stat

Returns:

file info

Throws:

IOException

getFileSize

public long getFileSize(String pathName)
                 throws IOException

Throws:

IOException

cd

public void cd(String dir)
        throws IOException

change to the given remote directory

Parameters:

dir - - the dir to change to, relative to the current one

Throws:

IOException

cdUp

public void cdUp()
          throws IOException

change to the parent directory

Throws:

IOException

mkdir

public void mkdir(String dir)
           throws IOException

create a remote directory

Parameters:

dir - - the dir to create, either absolute or relative to the current one

Throws:

IOException

rm

public void rm(String path)
        throws IOException

delete a remote file/directory

Parameters:

path - - the file/dir to delete, either absolute or relative to the current one

Throws:

IOException

rename

public void rename(String from,
                   String to)
            throws IOException

rename / move a remote file/directory

Parameters:

from - - the file/dir to rename, either absolute or relative to the current dir

to - - the target file name, either absolute or relative to the current dir

Throws:

IOException

setModificationTime

public void setModificationTime(String path,
                                Calendar to)
                         throws IOException

set the modification time of a remote file/directory

Parameters:

path - - the file/dir to modify

to - - the desired modification time

Throws:

IOException

pwd

public String pwd()
           throws IOException

get the current directory

Throws:

IOException

syncLocalFile

public RsyncStats syncLocalFile(String remoteMaster,
                                File localSlave)
                         throws Exception

sync a local file with its up-to-date remote version

Parameters:

remoteMaster - - the remote file (up of date)

localSlave - - the local file (out of date)

Throws:

Exception

syncRemoteFile

public RsyncStats syncRemoteFile(File localMaster,
                                 String remoteSlave)
                          throws Exception

sync a remote file with its up-to-date local version

Parameters:

localMaster - - the local file (up of date)

remoteSlave - - the remote file (out of date)

Returns:

RsyncStats info about the rsync process

Throws:

Exception

setBaseDirectory

public void setBaseDirectory(File base)

set the local base directory

Parameters:

base - - the base directory

getBaseDirectory

public File getBaseDirectory()

makeCommandline

public static String makeCommandline(String host,
                                     int port,
                                     String baseDirectory,
                                     String secret,
                                     int numStreams,
                                     String encryptionKey,
                                     int bufferSize,
                                     boolean compress,
                                     String commandFile)

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

Parameters:

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

port - - server port

baseDirectory - - local base directory

secret - - the secret

numStreams - - the number of streams

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

bufferSize - - size of the buffer

compress - - whether to enable gzip compression

commandFile - - file to read commands from

create

public static UFTPSessionClient create(String[] args)
                                throws UnknownHostException,
                                       FileNotFoundException

create a session client instance from the supplied commandline parameters

Throws:

UnknownHostException

FileNotFoundException