eu.unicore.uftp.client

Class AbstractUFTPClient

java.lang.Object

eu.unicore.uftp.client.AbstractUFTPClient

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

TunnelClient, UFTPClient, UFTPSessionClient

public abstract class AbstractUFTPClient
extends Object
implements Runnable, Closeable

Client base class

Author:

schuller

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFSIZE NETWORK send/receive buffer size, this must be the same on client/server if multiple streams are to be used
protected boolean	cancelled
protected DPCClient	client
protected boolean	compress
static int	HOSTERR
protected byte[]	key
protected int	numcons
protected UFTPProgressListener	progressListener
protected InputStream	reader
protected Socket	socket
static int	SYNERR Errorcodes
protected OutputStream	writer

Constructor Summary

Constructors

Constructor and Description
AbstractUFTPClient(InetAddress[] servers, int port) create a new UFTP client for file transfer from/to the given server

Method Summary

Modifier and Type	Method and Description
void	assertFeature(String feature)
void	cancel() signal the client that it should cancel an operation
void	close()
protected void	closeData()
void	connect()
protected Socket	createSocket(int numConnections, DPCClient client, byte[] key)
protected Socket	createSocket(int numConnections, DPCClient client, byte[] key, boolean compress)
int	getAuthtimeout()
int	getBufferSize()
byte[]	getKey()
int	getNumConnections()
UFTPProgressListener	getProgressListener()
String	getSecret()
List<String>	getServerFeatures()
InetAddress[]	getServerList()
int	getTimeout()
boolean	isCompress()
boolean	isConnected()
void	openDataConnection() if necessary, open data connection
protected void	prepareGet(OutputStream localTarget) setup reader and writer for getting remote data, by connecting them to the appropriate socket input stream and local output stream
protected void	preparePut(InputStream localSource) setup reader and writer for writing local data to the remote target, by connecting them to the socket output stream and local input source
void	setAuthtimeout(int authtimeout)
void	setBufferSize(int bufferSize)
void	setCompress(boolean compress)
void	setKey(byte[] key) set the (encoded) symmetric key to be used for encryption/decryption
void	setNumConnections(int num)
void	setProgressListener(UFTPProgressListener progressListener)
void	setSecret(String secret)
void	setTimeout(int timeout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

SYNERR

public static final int SYNERR

Errorcodes

See Also:

Constant Field Values

HOSTERR

public static final int HOSTERR

See Also:

Constant Field Values

BUFFSIZE

public static final int BUFFSIZE

NETWORK send/receive buffer size, this must be the same on client/server if multiple streams are to be used

See Also:

Constant Field Values

key

protected byte[] key

compress

protected boolean compress

numcons

protected int numcons

progressListener

protected UFTPProgressListener progressListener

client

protected final DPCClient client

socket

protected Socket socket

reader

protected InputStream reader

writer

protected OutputStream writer

cancelled

protected volatile boolean cancelled

Constructor Detail

AbstractUFTPClient

public AbstractUFTPClient(InetAddress[] servers,
                          int port)

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

Method Detail

connect

public void connect()
             throws IOException,
                    AuthorizationFailureException

Throws:

IOException

AuthorizationFailureException

openDataConnection

public void openDataConnection()
                        throws IOException

if necessary, open data connection

Throws:

IOException

closeData

protected void closeData()

prepareGet

protected void prepareGet(OutputStream localTarget)
                   throws IOException

setup reader and writer for getting remote data, by connecting them to the appropriate socket input stream and local output stream

Parameters:

localTarget - local output stream

Throws:

IOException

preparePut

protected void preparePut(InputStream localSource)
                   throws IOException

setup reader and writer for writing local data to the remote target, by connecting them to the socket output stream and local input source

Parameters:

localSource - local input source

Throws:

IOException

createSocket

protected Socket createSocket(int numConnections,
                              DPCClient client,
                              byte[] key)
                       throws IOException

Throws:

IOException

createSocket

protected Socket createSocket(int numConnections,
                              DPCClient client,
                              byte[] key,
                              boolean compress)
                       throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

setNumConnections

public void setNumConnections(int num)

getNumConnections

public int getNumConnections()

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getAuthtimeout

public int getAuthtimeout()

setAuthtimeout

public void setAuthtimeout(int authtimeout)

getSecret

public String getSecret()

setSecret

public void setSecret(String secret)

setKey

public void setKey(byte[] key)

set the (encoded) symmetric key to be used for encryption/decryption

Parameters:

key -

getKey

public byte[] getKey()

isCompress

public boolean isCompress()

setCompress

public void setCompress(boolean compress)

getProgressListener

public UFTPProgressListener getProgressListener()

setProgressListener

public void setProgressListener(UFTPProgressListener progressListener)

getServerList

public InetAddress[] getServerList()

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int bufferSize)

isConnected

public boolean isConnected()

getServerFeatures

public List<String> getServerFeatures()

assertFeature

public void assertFeature(String feature)
                   throws RuntimeException

Throws:

RuntimeException

cancel

public void cancel()

signal the client that it should cancel an operation