eu.unicore.uftp.server

Class UFTPTransferRequest

java.lang.Object

eu.unicore.uftp.server.UFTPBaseRequest

eu.unicore.uftp.server.UFTPTransferRequest

public class UFTPTransferRequest
extends UFTPBaseRequest

describes a data transfer between server and client

Author:

Tim Pohlmann, 2010, Forschungszentrum Juelich - JSC, schuller

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_TYPE

Fields inherited from class eu.unicore.uftp.server.UFTPBaseRequest

logger

Constructor Summary

Constructors

Constructor and Description
UFTPTransferRequest(InetAddress client, boolean send, int numCons, File file, boolean append, String secret, String user, String group, byte[] key)
UFTPTransferRequest(InetAddress client, boolean send, int numCons, File file, boolean append, String secret, String user, String group, byte[] key, long rateLimit, boolean compress)
UFTPTransferRequest(Properties properties) build a job from the given string in the java properties format 'client-ip=...' 'send=...' 'file=-...' 'numcons=...' 'secret=....'
UFTPTransferRequest(String properties)

Method Summary

Modifier and Type	Method and Description
InetAddress	getClient() get the client IP address
long	getCreatedTime() get the instant at which this job was created
String	getExcludes()
File	getFile()
String	getGroup()
String	getIncludes()
byte[]	getKey()
int	getNumCons() Returns the number of parallel connections
long	getRateLimit()
protected String	getRequestType()
String	getSecret() returns the secret
String	getUser()
boolean	isAppend() whether the file should be appended to
boolean	isCompress() whether the data should be compressed during transfer
boolean	isSendJob() returns the send/receive mode
boolean	isSession()
static boolean	isTransferRequest(Properties props)
static Properties	loadProperties(String props)
String	toString()
void	writeEncoded(OutputStream os) writes out the job in properties format 'client-ip=...' 'send=...' etc

Methods inherited from class eu.unicore.uftp.server.UFTPBaseRequest

readResponse, sendTo, sendTo

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_TYPE

public static final String REQUEST_TYPE

See Also:

Constant Field Values

Constructor Detail

UFTPTransferRequest

public UFTPTransferRequest(InetAddress client,
                           boolean send,
                           int numCons,
                           File file,
                           boolean append,
                           String secret,
                           String user,
                           String group,
                           byte[] key,
                           long rateLimit,
                           boolean compress)

Parameters:

client - - Client's ip address

send - - true if this side should send

file - - file to send/receive

numCons - - Number of concurrent connections

append - append

secret - - authz secret

user - - unix user name

group - - user's group

key - - encoded for encrypting/decrypting

rateLimit - - bandwidth limit in bytes per second

compress - - whether to compress data

UFTPTransferRequest

public UFTPTransferRequest(InetAddress client,
                           boolean send,
                           int numCons,
                           File file,
                           boolean append,
                           String secret,
                           String user,
                           String group,
                           byte[] key)

UFTPTransferRequest

public UFTPTransferRequest(Properties properties)
                    throws UnknownHostException,
                           IOException

build a job from the given string in the java properties format 'client-ip=...' 'send=...' 'file=-...' 'numcons=...' 'secret=....'

Parameters:

properties - properties

Throws:

UnknownHostException

IOException - when encoded properties cannot be read

UFTPTransferRequest

public UFTPTransferRequest(String properties)
                    throws UnknownHostException,
                           IOException

Throws:

UnknownHostException

IOException

Method Detail

loadProperties

public static Properties loadProperties(String props)
                                 throws IOException

Throws:

IOException

getClient

public InetAddress getClient()

get the client IP address

Returns:

client address

isSendJob

public boolean isSendJob()

returns the send/receive mode

Returns:

true if this side sends

getFile

public File getFile()

Returns:

file to send or write to

isAppend

public boolean isAppend()

whether the file should be appended to

Returns:

true if append

isCompress

public boolean isCompress()

whether the data should be compressed during transfer

Returns:

true if data will be compressed

getNumCons

public int getNumCons()

Returns the number of parallel connections

Returns:

number of connections

getSecret

public String getSecret()

returns the secret

Returns:

secret

getUser

public String getUser()

getGroup

public String getGroup()

getRateLimit

public long getRateLimit()

getKey

public byte[] getKey()

writeEncoded

public void writeEncoded(OutputStream os)
                  throws IOException

writes out the job in properties format 'client-ip=...' 'send=...' etc

Specified by:

writeEncoded in class UFTPBaseRequest

Parameters:

os - output stream where the options are written to

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getIncludes

public String getIncludes()

getExcludes

public String getExcludes()

getRequestType

protected String getRequestType()

Specified by:

getRequestType in class UFTPBaseRequest

isSession

public boolean isSession()

getCreatedTime

public long getCreatedTime()

get the instant at which this job was created

Returns:

isTransferRequest

public static boolean isTransferRequest(Properties props)